cloudsearch

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package cloudsearch provides the client and types for making API requests to Amazon CloudSearch.

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region).

See cloudsearch package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudsearch/

Using the Client

To Amazon CloudSearch with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon CloudSearch client CloudSearch for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudsearch/#New

Index

Constants

View Source
const (

	// ErrCodeBaseException for service response error code
	// "BaseException".
	//
	// An error occurred while processing the request.
	ErrCodeBaseException = "BaseException"

	// ErrCodeDisabledOperationException for service response error code
	// "DisabledAction".
	//
	// The request was rejected because it attempted an operation which is not enabled.
	ErrCodeDisabledOperationException = "DisabledAction"

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// An internal error occurred while processing the request. If this problem
	// persists, report an issue from the Service Health Dashboard (http://status.aws.amazon.com/).
	ErrCodeInternalException = "InternalException"

	// ErrCodeInvalidTypeException for service response error code
	// "InvalidType".
	//
	// The request was rejected because it specified an invalid type definition.
	ErrCodeInvalidTypeException = "InvalidType"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceeded".
	//
	// The request was rejected because a resource limit has already been met.
	ErrCodeLimitExceededException = "LimitExceeded"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFound".
	//
	// The request was rejected because it attempted to reference a resource that
	// does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFound"
)
View Source
const (
	ServiceName = "cloudsearch" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName   // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPoliciesStatus

type AccessPoliciesStatus struct {

	// Access rules for a domain's document or search service endpoints. For more
	// information, see Configuring Access for a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)
	// in the Amazon CloudSearch Developer Guide. The maximum size of a policy document
	// is 100 KB.
	//
	// Options is a required field
	Options *string `type:"string" required:"true"`

	// The status of domain configuration option.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

func (AccessPoliciesStatus) GoString

func (s AccessPoliciesStatus) GoString() string

GoString returns the string representation

func (AccessPoliciesStatus) String

func (s AccessPoliciesStatus) String() string

String returns the string representation

type AlgorithmicStemming

type AlgorithmicStemming string
const (
	AlgorithmicStemmingNone    AlgorithmicStemming = "none"
	AlgorithmicStemmingMinimal AlgorithmicStemming = "minimal"
	AlgorithmicStemmingLight   AlgorithmicStemming = "light"
	AlgorithmicStemmingFull    AlgorithmicStemming = "full"
)

Enum values for AlgorithmicStemming

func (AlgorithmicStemming) MarshalValue added in v0.3.0

func (enum AlgorithmicStemming) MarshalValue() (string, error)

func (AlgorithmicStemming) MarshalValueBuf added in v0.3.0

func (enum AlgorithmicStemming) MarshalValueBuf(b []byte) ([]byte, error)

type AnalysisOptions

type AnalysisOptions struct {

	// The level of algorithmic stemming to perform: none, minimal, light, or full.
	// The available levels vary depending on the language. For more information,
	// see Language Specific Text Processing Settings (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings)
	// in the Amazon CloudSearch Developer Guide
	AlgorithmicStemming AlgorithmicStemming `type:"string" enum:"true"`

	// A JSON array that contains a collection of terms, tokens, readings and part
	// of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary
	// enables you to override the default tokenization for selected terms. This
	// is only valid for Japanese language fields.
	JapaneseTokenizationDictionary *string `type:"string"`

	// A JSON object that contains a collection of string:value pairs that each
	// map a term to its stem. For example, {"term1": "stem1", "term2": "stem2",
	// "term3": "stem3"}. The stemming dictionary is applied in addition to any
	// algorithmic stemming. This enables you to override the results of the algorithmic
	// stemming to correct specific cases of overstemming or understemming. The
	// maximum size of a stemming dictionary is 500 KB.
	StemmingDictionary *string `type:"string"`

	// A JSON array of terms to ignore during indexing and searching. For example,
	// ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each
	// word you want to ignore. Wildcards and regular expressions are not supported.
	Stopwords *string `type:"string"`

	// A JSON object that defines synonym groups and aliases. A synonym group is
	// an array of arrays, where each sub-array is a group of terms where each term
	// in the group is considered a synonym of every other term in the group. The
	// aliases value is an object that contains a collection of string:value pairs
	// where the string specifies a term and the array of values specifies each
	// of the aliases for that term. An alias is considered a synonym of the specified
	// term, but the term is not considered a synonym of the alias. For more information
	// about specifying synonyms, see Synonyms (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms)
	// in the Amazon CloudSearch Developer Guide.
	Synonyms *string `type:"string"`
	// contains filtered or unexported fields
}

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

func (AnalysisOptions) GoString

func (s AnalysisOptions) GoString() string

GoString returns the string representation

func (AnalysisOptions) String

func (s AnalysisOptions) String() string

String returns the string representation

type AnalysisScheme

type AnalysisScheme struct {

	// Synonyms, stopwords, and stemming options for an analysis scheme. Includes
	// tokenization dictionary for Japanese.
	AnalysisOptions *AnalysisOptions `type:"structure"`

	// An IETF RFC 4646 (http://tools.ietf.org/html/rfc4646) language code or mul
	// for multiple languages.
	//
	// AnalysisSchemeLanguage is a required field
	AnalysisSchemeLanguage AnalysisSchemeLanguage `type:"string" required:"true" enum:"true"`

	// Names must begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore).
	//
	// AnalysisSchemeName is a required field
	AnalysisSchemeName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

func (AnalysisScheme) GoString

func (s AnalysisScheme) GoString() string

GoString returns the string representation

func (AnalysisScheme) String

func (s AnalysisScheme) String() string

String returns the string representation

func (*AnalysisScheme) Validate

func (s *AnalysisScheme) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalysisSchemeLanguage

type AnalysisSchemeLanguage string

An IETF RFC 4646 (http://tools.ietf.org/html/rfc4646) language code or mul for multiple languages.

const (
	AnalysisSchemeLanguageAr     AnalysisSchemeLanguage = "ar"
	AnalysisSchemeLanguageBg     AnalysisSchemeLanguage = "bg"
	AnalysisSchemeLanguageCa     AnalysisSchemeLanguage = "ca"
	AnalysisSchemeLanguageCs     AnalysisSchemeLanguage = "cs"
	AnalysisSchemeLanguageDa     AnalysisSchemeLanguage = "da"
	AnalysisSchemeLanguageDe     AnalysisSchemeLanguage = "de"
	AnalysisSchemeLanguageEl     AnalysisSchemeLanguage = "el"
	AnalysisSchemeLanguageEn     AnalysisSchemeLanguage = "en"
	AnalysisSchemeLanguageEs     AnalysisSchemeLanguage = "es"
	AnalysisSchemeLanguageEu     AnalysisSchemeLanguage = "eu"
	AnalysisSchemeLanguageFa     AnalysisSchemeLanguage = "fa"
	AnalysisSchemeLanguageFi     AnalysisSchemeLanguage = "fi"
	AnalysisSchemeLanguageFr     AnalysisSchemeLanguage = "fr"
	AnalysisSchemeLanguageGa     AnalysisSchemeLanguage = "ga"
	AnalysisSchemeLanguageGl     AnalysisSchemeLanguage = "gl"
	AnalysisSchemeLanguageHe     AnalysisSchemeLanguage = "he"
	AnalysisSchemeLanguageHi     AnalysisSchemeLanguage = "hi"
	AnalysisSchemeLanguageHu     AnalysisSchemeLanguage = "hu"
	AnalysisSchemeLanguageHy     AnalysisSchemeLanguage = "hy"
	AnalysisSchemeLanguageId     AnalysisSchemeLanguage = "id"
	AnalysisSchemeLanguageIt     AnalysisSchemeLanguage = "it"
	AnalysisSchemeLanguageJa     AnalysisSchemeLanguage = "ja"
	AnalysisSchemeLanguageKo     AnalysisSchemeLanguage = "ko"
	AnalysisSchemeLanguageLv     AnalysisSchemeLanguage = "lv"
	AnalysisSchemeLanguageMul    AnalysisSchemeLanguage = "mul"
	AnalysisSchemeLanguageNl     AnalysisSchemeLanguage = "nl"
	AnalysisSchemeLanguageNo     AnalysisSchemeLanguage = "no"
	AnalysisSchemeLanguagePt     AnalysisSchemeLanguage = "pt"
	AnalysisSchemeLanguageRo     AnalysisSchemeLanguage = "ro"
	AnalysisSchemeLanguageRu     AnalysisSchemeLanguage = "ru"
	AnalysisSchemeLanguageSv     AnalysisSchemeLanguage = "sv"
	AnalysisSchemeLanguageTh     AnalysisSchemeLanguage = "th"
	AnalysisSchemeLanguageTr     AnalysisSchemeLanguage = "tr"
	AnalysisSchemeLanguageZhHans AnalysisSchemeLanguage = "zh-Hans"
	AnalysisSchemeLanguageZhHant AnalysisSchemeLanguage = "zh-Hant"
)

Enum values for AnalysisSchemeLanguage

func (AnalysisSchemeLanguage) MarshalValue added in v0.3.0

func (enum AnalysisSchemeLanguage) MarshalValue() (string, error)

func (AnalysisSchemeLanguage) MarshalValueBuf added in v0.3.0

func (enum AnalysisSchemeLanguage) MarshalValueBuf(b []byte) ([]byte, error)

type AnalysisSchemeStatus

type AnalysisSchemeStatus struct {

	// Configuration information for an analysis scheme. Each analysis scheme has
	// a unique name and specifies the language of the text to be processed. The
	// following options can be configured for an analysis scheme: Synonyms, Stopwords,
	// StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.
	//
	// Options is a required field
	Options *AnalysisScheme `type:"structure" required:"true"`

	// The status of domain configuration option.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The status and configuration of an AnalysisScheme.

func (AnalysisSchemeStatus) GoString

func (s AnalysisSchemeStatus) GoString() string

GoString returns the string representation

func (AnalysisSchemeStatus) String

func (s AnalysisSchemeStatus) String() string

String returns the string representation

type AvailabilityOptionsStatus

type AvailabilityOptionsStatus struct {

	// The availability options configured for the domain.
	//
	// Options is a required field
	Options *bool `type:"boolean" required:"true"`

	// The status of domain configuration option.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The status and configuration of the domain's availability options.

func (AvailabilityOptionsStatus) GoString

func (s AvailabilityOptionsStatus) GoString() string

GoString returns the string representation

func (AvailabilityOptionsStatus) String

func (s AvailabilityOptionsStatus) String() string

String returns the string representation

type BuildSuggestersInput

type BuildSuggestersInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

func (BuildSuggestersInput) GoString

func (s BuildSuggestersInput) GoString() string

GoString returns the string representation

func (BuildSuggestersInput) String

func (s BuildSuggestersInput) String() string

String returns the string representation

func (*BuildSuggestersInput) Validate

func (s *BuildSuggestersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BuildSuggestersOutput

type BuildSuggestersOutput struct {

	// A list of field names.
	FieldNames []string `type:"list"`
	// contains filtered or unexported fields
}

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

func (BuildSuggestersOutput) GoString

func (s BuildSuggestersOutput) GoString() string

GoString returns the string representation

func (BuildSuggestersOutput) SDKResponseMetadata

func (s BuildSuggestersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BuildSuggestersOutput) String

func (s BuildSuggestersOutput) String() string

String returns the string representation

type BuildSuggestersRequest

type BuildSuggestersRequest struct {
	*aws.Request
	Input *BuildSuggestersInput
	Copy  func(*BuildSuggestersInput) BuildSuggestersRequest
}

BuildSuggestersRequest is a API request type for the BuildSuggesters API operation.

func (BuildSuggestersRequest) Send

Send marshals and sends the BuildSuggesters API request.

type CloudSearch

type CloudSearch struct {
	*aws.Client
}

CloudSearch provides the API operation methods for making requests to Amazon CloudSearch. See this package's package overview docs for details on the service.

CloudSearch methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *CloudSearch

New creates a new instance of the CloudSearch client with a config.

Example:

// Create a CloudSearch client from just a config.
svc := cloudsearch.New(myConfig)

func (*CloudSearch) BuildSuggestersRequest

func (c *CloudSearch) BuildSuggestersRequest(input *BuildSuggestersInput) BuildSuggestersRequest

BuildSuggestersRequest returns a request value for making API operation for Amazon CloudSearch.

Indexes the search suggestions. For more information, see Configuring Suggesters (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the BuildSuggestersRequest method.
req := client.BuildSuggestersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) CreateDomainRequest

func (c *CloudSearch) CreateDomainRequest(input *CreateDomainInput) CreateDomainRequest

CreateDomainRequest returns a request value for making API operation for Amazon CloudSearch.

Creates a new search domain. For more information, see Creating a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the CreateDomainRequest method.
req := client.CreateDomainRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DefineAnalysisSchemeRequest

func (c *CloudSearch) DefineAnalysisSchemeRequest(input *DefineAnalysisSchemeInput) DefineAnalysisSchemeRequest

DefineAnalysisSchemeRequest returns a request value for making API operation for Amazon CloudSearch.

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DefineAnalysisSchemeRequest method.
req := client.DefineAnalysisSchemeRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DefineExpressionRequest

func (c *CloudSearch) DefineExpressionRequest(input *DefineExpressionInput) DefineExpressionRequest

DefineExpressionRequest returns a request value for making API operation for Amazon CloudSearch.

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DefineExpressionRequest method.
req := client.DefineExpressionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DefineIndexFieldRequest

func (c *CloudSearch) DefineIndexFieldRequest(input *DefineIndexFieldInput) DefineIndexFieldRequest

DefineIndexFieldRequest returns a request value for making API operation for Amazon CloudSearch.

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DefineIndexFieldRequest method.
req := client.DefineIndexFieldRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DefineSuggesterRequest

func (c *CloudSearch) DefineSuggesterRequest(input *DefineSuggesterInput) DefineSuggesterRequest

DefineSuggesterRequest returns a request value for making API operation for Amazon CloudSearch.

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DefineSuggesterRequest method.
req := client.DefineSuggesterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DeleteAnalysisSchemeRequest

func (c *CloudSearch) DeleteAnalysisSchemeRequest(input *DeleteAnalysisSchemeInput) DeleteAnalysisSchemeRequest

DeleteAnalysisSchemeRequest returns a request value for making API operation for Amazon CloudSearch.

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DeleteAnalysisSchemeRequest method.
req := client.DeleteAnalysisSchemeRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DeleteDomainRequest

func (c *CloudSearch) DeleteDomainRequest(input *DeleteDomainInput) DeleteDomainRequest

DeleteDomainRequest returns a request value for making API operation for Amazon CloudSearch.

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DeleteDomainRequest method.
req := client.DeleteDomainRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DeleteExpressionRequest

func (c *CloudSearch) DeleteExpressionRequest(input *DeleteExpressionInput) DeleteExpressionRequest

DeleteExpressionRequest returns a request value for making API operation for Amazon CloudSearch.

Removes an Expression from the search domain. For more information, see Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DeleteExpressionRequest method.
req := client.DeleteExpressionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DeleteIndexFieldRequest

func (c *CloudSearch) DeleteIndexFieldRequest(input *DeleteIndexFieldInput) DeleteIndexFieldRequest

DeleteIndexFieldRequest returns a request value for making API operation for Amazon CloudSearch.

Removes an IndexField from the search domain. For more information, see Configuring Index Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DeleteIndexFieldRequest method.
req := client.DeleteIndexFieldRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DeleteSuggesterRequest

func (c *CloudSearch) DeleteSuggesterRequest(input *DeleteSuggesterInput) DeleteSuggesterRequest

DeleteSuggesterRequest returns a request value for making API operation for Amazon CloudSearch.

Deletes a suggester. For more information, see Getting Search Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DeleteSuggesterRequest method.
req := client.DeleteSuggesterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeAnalysisSchemesRequest

func (c *CloudSearch) DescribeAnalysisSchemesRequest(input *DescribeAnalysisSchemesInput) DescribeAnalysisSchemesRequest

DescribeAnalysisSchemesRequest returns a request value for making API operation for Amazon CloudSearch.

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeAnalysisSchemesRequest method.
req := client.DescribeAnalysisSchemesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeAvailabilityOptionsRequest

func (c *CloudSearch) DescribeAvailabilityOptionsRequest(input *DescribeAvailabilityOptionsInput) DescribeAvailabilityOptionsRequest

DescribeAvailabilityOptionsRequest returns a request value for making API operation for Amazon CloudSearch.

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeAvailabilityOptionsRequest method.
req := client.DescribeAvailabilityOptionsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeDomainsRequest

func (c *CloudSearch) DescribeDomainsRequest(input *DescribeDomainsInput) DescribeDomainsRequest

DescribeDomainsRequest returns a request value for making API operation for Amazon CloudSearch.

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeDomainsRequest method.
req := client.DescribeDomainsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeExpressionsRequest

func (c *CloudSearch) DescribeExpressionsRequest(input *DescribeExpressionsInput) DescribeExpressionsRequest

DescribeExpressionsRequest returns a request value for making API operation for Amazon CloudSearch.

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeExpressionsRequest method.
req := client.DescribeExpressionsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeIndexFieldsRequest

func (c *CloudSearch) DescribeIndexFieldsRequest(input *DescribeIndexFieldsInput) DescribeIndexFieldsRequest

DescribeIndexFieldsRequest returns a request value for making API operation for Amazon CloudSearch.

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeIndexFieldsRequest method.
req := client.DescribeIndexFieldsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeScalingParametersRequest

func (c *CloudSearch) DescribeScalingParametersRequest(input *DescribeScalingParametersInput) DescribeScalingParametersRequest

DescribeScalingParametersRequest returns a request value for making API operation for Amazon CloudSearch.

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeScalingParametersRequest method.
req := client.DescribeScalingParametersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeServiceAccessPoliciesRequest

func (c *CloudSearch) DescribeServiceAccessPoliciesRequest(input *DescribeServiceAccessPoliciesInput) DescribeServiceAccessPoliciesRequest

DescribeServiceAccessPoliciesRequest returns a request value for making API operation for Amazon CloudSearch.

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeServiceAccessPoliciesRequest method.
req := client.DescribeServiceAccessPoliciesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) DescribeSuggestersRequest

func (c *CloudSearch) DescribeSuggestersRequest(input *DescribeSuggestersInput) DescribeSuggestersRequest

DescribeSuggestersRequest returns a request value for making API operation for Amazon CloudSearch.

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the DescribeSuggestersRequest method.
req := client.DescribeSuggestersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) IndexDocumentsRequest

func (c *CloudSearch) IndexDocumentsRequest(input *IndexDocumentsInput) IndexDocumentsRequest

IndexDocumentsRequest returns a request value for making API operation for Amazon CloudSearch.

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

// Example sending a request using the IndexDocumentsRequest method.
req := client.IndexDocumentsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) ListDomainNamesRequest

func (c *CloudSearch) ListDomainNamesRequest(input *ListDomainNamesInput) ListDomainNamesRequest

ListDomainNamesRequest returns a request value for making API operation for Amazon CloudSearch.

Lists all search domains owned by an account.

// Example sending a request using the ListDomainNamesRequest method.
req := client.ListDomainNamesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) UpdateAvailabilityOptionsRequest

func (c *CloudSearch) UpdateAvailabilityOptionsRequest(input *UpdateAvailabilityOptionsInput) UpdateAvailabilityOptionsRequest

UpdateAvailabilityOptionsRequest returns a request value for making API operation for Amazon CloudSearch.

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the UpdateAvailabilityOptionsRequest method.
req := client.UpdateAvailabilityOptionsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) UpdateScalingParametersRequest

func (c *CloudSearch) UpdateScalingParametersRequest(input *UpdateScalingParametersInput) UpdateScalingParametersRequest

UpdateScalingParametersRequest returns a request value for making API operation for Amazon CloudSearch.

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the Amazon CloudSearch Developer Guide.

// Example sending a request using the UpdateScalingParametersRequest method.
req := client.UpdateScalingParametersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*CloudSearch) UpdateServiceAccessPoliciesRequest

func (c *CloudSearch) UpdateServiceAccessPoliciesRequest(input *UpdateServiceAccessPoliciesInput) UpdateServiceAccessPoliciesRequest

UpdateServiceAccessPoliciesRequest returns a request value for making API operation for Amazon CloudSearch.

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html).

// Example sending a request using the UpdateServiceAccessPoliciesRequest method.
req := client.UpdateServiceAccessPoliciesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

type CreateDomainInput

type CreateDomainInput struct {

	// A name for the domain you are creating. Allowed characters are a-z (lower-case
	// letters), 0-9, and hyphen (-). Domain names must start with a letter or number
	// and be at least 3 and no more than 28 characters long.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

func (CreateDomainInput) GoString

func (s CreateDomainInput) GoString() string

GoString returns the string representation

func (CreateDomainInput) String

func (s CreateDomainInput) String() string

String returns the string representation

func (*CreateDomainInput) Validate

func (s *CreateDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDomainOutput

type CreateDomainOutput struct {

	// The current status of the search domain.
	DomainStatus *DomainStatus `type:"structure"`
	// contains filtered or unexported fields
}

The result of a CreateDomainRequest. Contains the status of a newly created domain.

func (CreateDomainOutput) GoString

func (s CreateDomainOutput) GoString() string

GoString returns the string representation

func (CreateDomainOutput) SDKResponseMetadata

func (s CreateDomainOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateDomainOutput) String

func (s CreateDomainOutput) String() string

String returns the string representation

type CreateDomainRequest

type CreateDomainRequest struct {
	*aws.Request
	Input *CreateDomainInput
	Copy  func(*CreateDomainInput) CreateDomainRequest
}

CreateDomainRequest is a API request type for the CreateDomain API operation.

func (CreateDomainRequest) Send

Send marshals and sends the CreateDomain API request.

type DateArrayOptions

type DateArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string `type:"string"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// A list of source fields to map to the field.
	SourceFields *string `type:"string"`
	// contains filtered or unexported fields
}

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

func (DateArrayOptions) GoString

func (s DateArrayOptions) GoString() string

GoString returns the string representation

func (DateArrayOptions) String

func (s DateArrayOptions) String() string

String returns the string representation

type DateOptions

type DateOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string `type:"string"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// Whether the field can be used to sort the search results.
	SortEnabled *bool `type:"boolean"`

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines
	// a pattern that begins or ends with a wildcard. Any document fields that don't
	// map to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options.
	//
	// Regular field names begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin
	// or end with a wildcard (*). The wildcard can also be the only character in
	// a dynamic field name. Multiple wildcards, and wildcards embedded within a
	// string are not supported.
	//
	// The name score is reserved and cannot be used as a field name. To reference
	// a document's ID, you can use the name _id.
	SourceField *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

func (DateOptions) GoString

func (s DateOptions) GoString() string

GoString returns the string representation

func (DateOptions) String

func (s DateOptions) String() string

String returns the string representation

func (*DateOptions) Validate

func (s *DateOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DefineAnalysisSchemeInput

type DefineAnalysisSchemeInput struct {

	// Configuration information for an analysis scheme. Each analysis scheme has
	// a unique name and specifies the language of the text to be processed. The
	// following options can be configured for an analysis scheme: Synonyms, Stopwords,
	// StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.
	//
	// AnalysisScheme is a required field
	AnalysisScheme *AnalysisScheme `type:"structure" required:"true"`

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

func (DefineAnalysisSchemeInput) GoString

func (s DefineAnalysisSchemeInput) GoString() string

GoString returns the string representation

func (DefineAnalysisSchemeInput) String

func (s DefineAnalysisSchemeInput) String() string

String returns the string representation

func (*DefineAnalysisSchemeInput) Validate

func (s *DefineAnalysisSchemeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DefineAnalysisSchemeOutput

type DefineAnalysisSchemeOutput struct {

	// The status and configuration of an AnalysisScheme.
	//
	// AnalysisScheme is a required field
	AnalysisScheme *AnalysisSchemeStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

func (DefineAnalysisSchemeOutput) GoString

func (s DefineAnalysisSchemeOutput) GoString() string

GoString returns the string representation

func (DefineAnalysisSchemeOutput) SDKResponseMetadata

func (s DefineAnalysisSchemeOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DefineAnalysisSchemeOutput) String

String returns the string representation

type DefineAnalysisSchemeRequest

type DefineAnalysisSchemeRequest struct {
	*aws.Request
	Input *DefineAnalysisSchemeInput
	Copy  func(*DefineAnalysisSchemeInput) DefineAnalysisSchemeRequest
}

DefineAnalysisSchemeRequest is a API request type for the DefineAnalysisScheme API operation.

func (DefineAnalysisSchemeRequest) Send

Send marshals and sends the DefineAnalysisScheme API request.

type DefineExpressionInput

type DefineExpressionInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// A named expression that can be evaluated at search time. Can be used to sort
	// the search results, define other expressions, or return computed information
	// in the search results.
	//
	// Expression is a required field
	Expression *Expression `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

func (DefineExpressionInput) GoString

func (s DefineExpressionInput) GoString() string

GoString returns the string representation

func (DefineExpressionInput) String

func (s DefineExpressionInput) String() string

String returns the string representation

func (*DefineExpressionInput) Validate

func (s *DefineExpressionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DefineExpressionOutput

type DefineExpressionOutput struct {

	// The value of an Expression and its current status.
	//
	// Expression is a required field
	Expression *ExpressionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DefineExpression request. Contains the status of the newly-configured expression.

func (DefineExpressionOutput) GoString

func (s DefineExpressionOutput) GoString() string

GoString returns the string representation

func (DefineExpressionOutput) SDKResponseMetadata

func (s DefineExpressionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DefineExpressionOutput) String

func (s DefineExpressionOutput) String() string

String returns the string representation

type DefineExpressionRequest

type DefineExpressionRequest struct {
	*aws.Request
	Input *DefineExpressionInput
	Copy  func(*DefineExpressionInput) DefineExpressionRequest
}

DefineExpressionRequest is a API request type for the DefineExpression API operation.

func (DefineExpressionRequest) Send

Send marshals and sends the DefineExpression API request.

type DefineIndexFieldInput

type DefineIndexFieldInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// The index field and field options you want to configure.
	//
	// IndexField is a required field
	IndexField *IndexField `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

func (DefineIndexFieldInput) GoString

func (s DefineIndexFieldInput) GoString() string

GoString returns the string representation

func (DefineIndexFieldInput) String

func (s DefineIndexFieldInput) String() string

String returns the string representation

func (*DefineIndexFieldInput) Validate

func (s *DefineIndexFieldInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DefineIndexFieldOutput

type DefineIndexFieldOutput struct {

	// The value of an IndexField and its current status.
	//
	// IndexField is a required field
	IndexField *IndexFieldStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

func (DefineIndexFieldOutput) GoString

func (s DefineIndexFieldOutput) GoString() string

GoString returns the string representation

func (DefineIndexFieldOutput) SDKResponseMetadata

func (s DefineIndexFieldOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DefineIndexFieldOutput) String

func (s DefineIndexFieldOutput) String() string

String returns the string representation

type DefineIndexFieldRequest

type DefineIndexFieldRequest struct {
	*aws.Request
	Input *DefineIndexFieldInput
	Copy  func(*DefineIndexFieldInput) DefineIndexFieldRequest
}

DefineIndexFieldRequest is a API request type for the DefineIndexField API operation.

func (DefineIndexFieldRequest) Send

Send marshals and sends the DefineIndexField API request.

type DefineSuggesterInput

type DefineSuggesterInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// Configuration information for a search suggester. Each suggester has a unique
	// name and specifies the text field you want to use for suggestions. The following
	// options can be configured for a suggester: FuzzyMatching, SortExpression.
	//
	// Suggester is a required field
	Suggester *Suggester `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

func (DefineSuggesterInput) GoString

func (s DefineSuggesterInput) GoString() string

GoString returns the string representation

func (DefineSuggesterInput) String

func (s DefineSuggesterInput) String() string

String returns the string representation

func (*DefineSuggesterInput) Validate

func (s *DefineSuggesterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DefineSuggesterOutput

type DefineSuggesterOutput struct {

	// The value of a Suggester and its current status.
	//
	// Suggester is a required field
	Suggester *SuggesterStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

func (DefineSuggesterOutput) GoString

func (s DefineSuggesterOutput) GoString() string

GoString returns the string representation

func (DefineSuggesterOutput) SDKResponseMetadata

func (s DefineSuggesterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DefineSuggesterOutput) String

func (s DefineSuggesterOutput) String() string

String returns the string representation

type DefineSuggesterRequest

type DefineSuggesterRequest struct {
	*aws.Request
	Input *DefineSuggesterInput
	Copy  func(*DefineSuggesterInput) DefineSuggesterRequest
}

DefineSuggesterRequest is a API request type for the DefineSuggester API operation.

func (DefineSuggesterRequest) Send

Send marshals and sends the DefineSuggester API request.

type DeleteAnalysisSchemeInput

type DeleteAnalysisSchemeInput struct {

	// The name of the analysis scheme you want to delete.
	//
	// AnalysisSchemeName is a required field
	AnalysisSchemeName *string `min:"1" type:"string" required:"true"`

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

func (DeleteAnalysisSchemeInput) GoString

func (s DeleteAnalysisSchemeInput) GoString() string

GoString returns the string representation

func (DeleteAnalysisSchemeInput) String

func (s DeleteAnalysisSchemeInput) String() string

String returns the string representation

func (*DeleteAnalysisSchemeInput) Validate

func (s *DeleteAnalysisSchemeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAnalysisSchemeOutput

type DeleteAnalysisSchemeOutput struct {

	// The status of the analysis scheme being deleted.
	//
	// AnalysisScheme is a required field
	AnalysisScheme *AnalysisSchemeStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

func (DeleteAnalysisSchemeOutput) GoString

func (s DeleteAnalysisSchemeOutput) GoString() string

GoString returns the string representation

func (DeleteAnalysisSchemeOutput) SDKResponseMetadata

func (s DeleteAnalysisSchemeOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteAnalysisSchemeOutput) String

String returns the string representation

type DeleteAnalysisSchemeRequest

type DeleteAnalysisSchemeRequest struct {
	*aws.Request
	Input *DeleteAnalysisSchemeInput
	Copy  func(*DeleteAnalysisSchemeInput) DeleteAnalysisSchemeRequest
}

DeleteAnalysisSchemeRequest is a API request type for the DeleteAnalysisScheme API operation.

func (DeleteAnalysisSchemeRequest) Send

Send marshals and sends the DeleteAnalysisScheme API request.

type DeleteDomainInput

type DeleteDomainInput struct {

	// The name of the domain you want to permanently delete.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

func (DeleteDomainInput) GoString

func (s DeleteDomainInput) GoString() string

GoString returns the string representation

func (DeleteDomainInput) String

func (s DeleteDomainInput) String() string

String returns the string representation

func (*DeleteDomainInput) Validate

func (s *DeleteDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDomainOutput

type DeleteDomainOutput struct {

	// The current status of the search domain.
	DomainStatus *DomainStatus `type:"structure"`
	// contains filtered or unexported fields
}

The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

func (DeleteDomainOutput) GoString

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation

func (DeleteDomainOutput) SDKResponseMetadata

func (s DeleteDomainOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteDomainOutput) String

func (s DeleteDomainOutput) String() string

String returns the string representation

type DeleteDomainRequest

type DeleteDomainRequest struct {
	*aws.Request
	Input *DeleteDomainInput
	Copy  func(*DeleteDomainInput) DeleteDomainRequest
}

DeleteDomainRequest is a API request type for the DeleteDomain API operation.

func (DeleteDomainRequest) Send

Send marshals and sends the DeleteDomain API request.

type DeleteExpressionInput

type DeleteExpressionInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// The name of the Expression to delete.
	//
	// ExpressionName is a required field
	ExpressionName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

func (DeleteExpressionInput) GoString

func (s DeleteExpressionInput) GoString() string

GoString returns the string representation

func (DeleteExpressionInput) String

func (s DeleteExpressionInput) String() string

String returns the string representation

func (*DeleteExpressionInput) Validate

func (s *DeleteExpressionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteExpressionOutput

type DeleteExpressionOutput struct {

	// The status of the expression being deleted.
	//
	// Expression is a required field
	Expression *ExpressionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DeleteExpression request. Specifies the expression being deleted.

func (DeleteExpressionOutput) GoString

func (s DeleteExpressionOutput) GoString() string

GoString returns the string representation

func (DeleteExpressionOutput) SDKResponseMetadata

func (s DeleteExpressionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteExpressionOutput) String

func (s DeleteExpressionOutput) String() string

String returns the string representation

type DeleteExpressionRequest

type DeleteExpressionRequest struct {
	*aws.Request
	Input *DeleteExpressionInput
	Copy  func(*DeleteExpressionInput) DeleteExpressionRequest
}

DeleteExpressionRequest is a API request type for the DeleteExpression API operation.

func (DeleteExpressionRequest) Send

Send marshals and sends the DeleteExpression API request.

type DeleteIndexFieldInput

type DeleteIndexFieldInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// The name of the index field your want to remove from the domain's indexing
	// options.
	//
	// IndexFieldName is a required field
	IndexFieldName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

func (DeleteIndexFieldInput) GoString

func (s DeleteIndexFieldInput) GoString() string

GoString returns the string representation

func (DeleteIndexFieldInput) String

func (s DeleteIndexFieldInput) String() string

String returns the string representation

func (*DeleteIndexFieldInput) Validate

func (s *DeleteIndexFieldInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteIndexFieldOutput

type DeleteIndexFieldOutput struct {

	// The status of the index field being deleted.
	//
	// IndexField is a required field
	IndexField *IndexFieldStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DeleteIndexField request.

func (DeleteIndexFieldOutput) GoString

func (s DeleteIndexFieldOutput) GoString() string

GoString returns the string representation

func (DeleteIndexFieldOutput) SDKResponseMetadata

func (s DeleteIndexFieldOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteIndexFieldOutput) String

func (s DeleteIndexFieldOutput) String() string

String returns the string representation

type DeleteIndexFieldRequest

type DeleteIndexFieldRequest struct {
	*aws.Request
	Input *DeleteIndexFieldInput
	Copy  func(*DeleteIndexFieldInput) DeleteIndexFieldRequest
}

DeleteIndexFieldRequest is a API request type for the DeleteIndexField API operation.

func (DeleteIndexFieldRequest) Send

Send marshals and sends the DeleteIndexField API request.

type DeleteSuggesterInput

type DeleteSuggesterInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// Specifies the name of the suggester you want to delete.
	//
	// SuggesterName is a required field
	SuggesterName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

func (DeleteSuggesterInput) GoString

func (s DeleteSuggesterInput) GoString() string

GoString returns the string representation

func (DeleteSuggesterInput) String

func (s DeleteSuggesterInput) String() string

String returns the string representation

func (*DeleteSuggesterInput) Validate

func (s *DeleteSuggesterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSuggesterOutput

type DeleteSuggesterOutput struct {

	// The status of the suggester being deleted.
	//
	// Suggester is a required field
	Suggester *SuggesterStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

func (DeleteSuggesterOutput) GoString

func (s DeleteSuggesterOutput) GoString() string

GoString returns the string representation

func (DeleteSuggesterOutput) SDKResponseMetadata

func (s DeleteSuggesterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteSuggesterOutput) String

func (s DeleteSuggesterOutput) String() string

String returns the string representation

type DeleteSuggesterRequest

type DeleteSuggesterRequest struct {
	*aws.Request
	Input *DeleteSuggesterInput
	Copy  func(*DeleteSuggesterInput) DeleteSuggesterRequest
}

DeleteSuggesterRequest is a API request type for the DeleteSuggester API operation.

func (DeleteSuggesterRequest) Send

Send marshals and sends the DeleteSuggester API request.

type DescribeAnalysisSchemesInput

type DescribeAnalysisSchemesInput struct {

	// The analysis schemes you want to describe.
	AnalysisSchemeNames []string `type:"list"`

	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool `type:"boolean"`

	// The name of the domain you want to describe.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

func (DescribeAnalysisSchemesInput) GoString

func (s DescribeAnalysisSchemesInput) GoString() string

GoString returns the string representation

func (DescribeAnalysisSchemesInput) String

String returns the string representation

func (*DescribeAnalysisSchemesInput) Validate

func (s *DescribeAnalysisSchemesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAnalysisSchemesOutput

type DescribeAnalysisSchemesOutput struct {

	// The analysis scheme descriptions.
	//
	// AnalysisSchemes is a required field
	AnalysisSchemes []AnalysisSchemeStatus `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

func (DescribeAnalysisSchemesOutput) GoString

GoString returns the string representation

func (DescribeAnalysisSchemesOutput) SDKResponseMetadata

func (s DescribeAnalysisSchemesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeAnalysisSchemesOutput) String

String returns the string representation

type DescribeAnalysisSchemesRequest

type DescribeAnalysisSchemesRequest struct {
	*aws.Request
	Input *DescribeAnalysisSchemesInput
	Copy  func(*DescribeAnalysisSchemesInput) DescribeAnalysisSchemesRequest
}

DescribeAnalysisSchemesRequest is a API request type for the DescribeAnalysisSchemes API operation.

func (DescribeAnalysisSchemesRequest) Send

Send marshals and sends the DescribeAnalysisSchemes API request.

type DescribeAvailabilityOptionsInput

type DescribeAvailabilityOptionsInput struct {

	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool `type:"boolean"`

	// The name of the domain you want to describe.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

func (DescribeAvailabilityOptionsInput) GoString

GoString returns the string representation

func (DescribeAvailabilityOptionsInput) String

String returns the string representation

func (*DescribeAvailabilityOptionsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeAvailabilityOptionsOutput

type DescribeAvailabilityOptionsOutput struct {

	// The availability options configured for the domain. Indicates whether Multi-AZ
	// is enabled for the domain.
	AvailabilityOptions *AvailabilityOptionsStatus `type:"structure"`
	// contains filtered or unexported fields
}

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

func (DescribeAvailabilityOptionsOutput) GoString

GoString returns the string representation

func (DescribeAvailabilityOptionsOutput) SDKResponseMetadata

func (s DescribeAvailabilityOptionsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeAvailabilityOptionsOutput) String

String returns the string representation

type DescribeAvailabilityOptionsRequest

type DescribeAvailabilityOptionsRequest struct {
	*aws.Request
	Input *DescribeAvailabilityOptionsInput
	Copy  func(*DescribeAvailabilityOptionsInput) DescribeAvailabilityOptionsRequest
}

DescribeAvailabilityOptionsRequest is a API request type for the DescribeAvailabilityOptions API operation.

func (DescribeAvailabilityOptionsRequest) Send

Send marshals and sends the DescribeAvailabilityOptions API request.

type DescribeDomainsInput

type DescribeDomainsInput struct {

	// The names of the domains you want to include in the response.
	DomainNames []string `type:"list"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

func (DescribeDomainsInput) GoString

func (s DescribeDomainsInput) GoString() string

GoString returns the string representation

func (DescribeDomainsInput) String

func (s DescribeDomainsInput) String() string

String returns the string representation

type DescribeDomainsOutput

type DescribeDomainsOutput struct {

	// A list that contains the status of each requested domain.
	//
	// DomainStatusList is a required field
	DomainStatusList []DomainStatus `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

func (DescribeDomainsOutput) GoString

func (s DescribeDomainsOutput) GoString() string

GoString returns the string representation

func (DescribeDomainsOutput) SDKResponseMetadata

func (s DescribeDomainsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeDomainsOutput) String

func (s DescribeDomainsOutput) String() string

String returns the string representation

type DescribeDomainsRequest

type DescribeDomainsRequest struct {
	*aws.Request
	Input *DescribeDomainsInput
	Copy  func(*DescribeDomainsInput) DescribeDomainsRequest
}

DescribeDomainsRequest is a API request type for the DescribeDomains API operation.

func (DescribeDomainsRequest) Send

Send marshals and sends the DescribeDomains API request.

type DescribeExpressionsInput

type DescribeExpressionsInput struct {

	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool `type:"boolean"`

	// The name of the domain you want to describe.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// Limits the DescribeExpressions response to the specified expressions. If
	// not specified, all expressions are shown.
	ExpressionNames []string `type:"list"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

func (DescribeExpressionsInput) GoString

func (s DescribeExpressionsInput) GoString() string

GoString returns the string representation

func (DescribeExpressionsInput) String

func (s DescribeExpressionsInput) String() string

String returns the string representation

func (*DescribeExpressionsInput) Validate

func (s *DescribeExpressionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeExpressionsOutput

type DescribeExpressionsOutput struct {

	// The expressions configured for the domain.
	//
	// Expressions is a required field
	Expressions []ExpressionStatus `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

func (DescribeExpressionsOutput) GoString

func (s DescribeExpressionsOutput) GoString() string

GoString returns the string representation

func (DescribeExpressionsOutput) SDKResponseMetadata

func (s DescribeExpressionsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeExpressionsOutput) String

func (s DescribeExpressionsOutput) String() string

String returns the string representation

type DescribeExpressionsRequest

type DescribeExpressionsRequest struct {
	*aws.Request
	Input *DescribeExpressionsInput
	Copy  func(*DescribeExpressionsInput) DescribeExpressionsRequest
}

DescribeExpressionsRequest is a API request type for the DescribeExpressions API operation.

func (DescribeExpressionsRequest) Send

Send marshals and sends the DescribeExpressions API request.

type DescribeIndexFieldsInput

type DescribeIndexFieldsInput struct {

	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool `type:"boolean"`

	// The name of the domain you want to describe.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// A list of the index fields you want to describe. If not specified, information
	// is returned for all configured index fields.
	FieldNames []string `type:"list"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

func (DescribeIndexFieldsInput) GoString

func (s DescribeIndexFieldsInput) GoString() string

GoString returns the string representation

func (DescribeIndexFieldsInput) String

func (s DescribeIndexFieldsInput) String() string

String returns the string representation

func (*DescribeIndexFieldsInput) Validate

func (s *DescribeIndexFieldsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeIndexFieldsOutput

type DescribeIndexFieldsOutput struct {

	// The index fields configured for the domain.
	//
	// IndexFields is a required field
	IndexFields []IndexFieldStatus `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

func (DescribeIndexFieldsOutput) GoString

func (s DescribeIndexFieldsOutput) GoString() string

GoString returns the string representation

func (DescribeIndexFieldsOutput) SDKResponseMetadata

func (s DescribeIndexFieldsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeIndexFieldsOutput) String

func (s DescribeIndexFieldsOutput) String() string

String returns the string representation

type DescribeIndexFieldsRequest

type DescribeIndexFieldsRequest struct {
	*aws.Request
	Input *DescribeIndexFieldsInput
	Copy  func(*DescribeIndexFieldsInput) DescribeIndexFieldsRequest
}

DescribeIndexFieldsRequest is a API request type for the DescribeIndexFields API operation.

func (DescribeIndexFieldsRequest) Send

Send marshals and sends the DescribeIndexFields API request.

type DescribeScalingParametersInput

type DescribeScalingParametersInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

func (DescribeScalingParametersInput) GoString

GoString returns the string representation

func (DescribeScalingParametersInput) String

String returns the string representation

func (*DescribeScalingParametersInput) Validate

func (s *DescribeScalingParametersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeScalingParametersOutput

type DescribeScalingParametersOutput struct {

	// The status and configuration of a search domain's scaling parameters.
	//
	// ScalingParameters is a required field
	ScalingParameters *ScalingParametersStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

func (DescribeScalingParametersOutput) GoString

GoString returns the string representation

func (DescribeScalingParametersOutput) SDKResponseMetadata

func (s DescribeScalingParametersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeScalingParametersOutput) String

String returns the string representation

type DescribeScalingParametersRequest

type DescribeScalingParametersRequest struct {
	*aws.Request
	Input *DescribeScalingParametersInput
	Copy  func(*DescribeScalingParametersInput) DescribeScalingParametersRequest
}

DescribeScalingParametersRequest is a API request type for the DescribeScalingParameters API operation.

func (DescribeScalingParametersRequest) Send

Send marshals and sends the DescribeScalingParameters API request.

type DescribeServiceAccessPoliciesInput

type DescribeServiceAccessPoliciesInput struct {

	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool `type:"boolean"`

	// The name of the domain you want to describe.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

func (DescribeServiceAccessPoliciesInput) GoString

GoString returns the string representation

func (DescribeServiceAccessPoliciesInput) String

String returns the string representation

func (*DescribeServiceAccessPoliciesInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeServiceAccessPoliciesOutput

type DescribeServiceAccessPoliciesOutput struct {

	// The access rules configured for the domain specified in the request.
	//
	// AccessPolicies is a required field
	AccessPolicies *AccessPoliciesStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeServiceAccessPolicies request.

func (DescribeServiceAccessPoliciesOutput) GoString

GoString returns the string representation

func (DescribeServiceAccessPoliciesOutput) SDKResponseMetadata

func (s DescribeServiceAccessPoliciesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeServiceAccessPoliciesOutput) String

String returns the string representation

type DescribeServiceAccessPoliciesRequest

type DescribeServiceAccessPoliciesRequest struct {
	*aws.Request
	Input *DescribeServiceAccessPoliciesInput
	Copy  func(*DescribeServiceAccessPoliciesInput) DescribeServiceAccessPoliciesRequest
}

DescribeServiceAccessPoliciesRequest is a API request type for the DescribeServiceAccessPolicies API operation.

func (DescribeServiceAccessPoliciesRequest) Send

Send marshals and sends the DescribeServiceAccessPolicies API request.

type DescribeSuggestersInput

type DescribeSuggestersInput struct {

	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool `type:"boolean"`

	// The name of the domain you want to describe.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// The suggesters you want to describe.
	SuggesterNames []string `type:"list"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

func (DescribeSuggestersInput) GoString

func (s DescribeSuggestersInput) GoString() string

GoString returns the string representation

func (DescribeSuggestersInput) String

func (s DescribeSuggestersInput) String() string

String returns the string representation

func (*DescribeSuggestersInput) Validate

func (s *DescribeSuggestersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSuggestersOutput

type DescribeSuggestersOutput struct {

	// The suggesters configured for the domain specified in the request.
	//
	// Suggesters is a required field
	Suggesters []SuggesterStatus `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The result of a DescribeSuggesters request.

func (DescribeSuggestersOutput) GoString

func (s DescribeSuggestersOutput) GoString() string

GoString returns the string representation

func (DescribeSuggestersOutput) SDKResponseMetadata

func (s DescribeSuggestersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeSuggestersOutput) String

func (s DescribeSuggestersOutput) String() string

String returns the string representation

type DescribeSuggestersRequest

type DescribeSuggestersRequest struct {
	*aws.Request
	Input *DescribeSuggestersInput
	Copy  func(*DescribeSuggestersInput) DescribeSuggestersRequest
}

DescribeSuggestersRequest is a API request type for the DescribeSuggesters API operation.

func (DescribeSuggestersRequest) Send

Send marshals and sends the DescribeSuggesters API request.

type DocumentSuggesterOptions

type DocumentSuggesterOptions struct {

	// The level of fuzziness allowed when suggesting matches for a string: none,
	// low, or high. With none, the specified string is treated as an exact prefix.
	// With low, suggestions must differ from the specified string by no more than
	// one character. With high, suggestions can differ by up to two characters.
	// The default is none.
	FuzzyMatching SuggesterFuzzyMatching `type:"string" enum:"true"`

	// An expression that computes a score for each suggestion to control how they
	// are sorted. The scores are rounded to the nearest integer, with a floor of
	// 0 and a ceiling of 2^31-1. A document's relevance score is not computed for
	// suggestions, so sort expressions cannot reference the _score value. To sort
	// suggestions using a numeric field or existing expression, simply specify
	// the name of the field or expression. If no expression is configured for the
	// suggester, the suggestions are sorted with the closest matches listed first.
	SortExpression *string `type:"string"`

	// The name of the index field you want to use for suggestions.
	//
	// SourceField is a required field
	SourceField *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Options for a search suggester.

func (DocumentSuggesterOptions) GoString

func (s DocumentSuggesterOptions) GoString() string

GoString returns the string representation

func (DocumentSuggesterOptions) String

func (s DocumentSuggesterOptions) String() string

String returns the string representation

func (*DocumentSuggesterOptions) Validate

func (s *DocumentSuggesterOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DomainStatus

type DomainStatus struct {

	// The Amazon Resource Name (ARN) of the search domain. See Identifiers for
	// IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
	// in Using AWS Identity and Access Management for more information.
	ARN *string `type:"string"`

	// True if the search domain is created. It can take several minutes to initialize
	// a domain when CreateDomain is called. Newly created search domains are returned
	// from DescribeDomains with a false value for Created until domain creation
	// is complete.
	Created *bool `type:"boolean"`

	// True if the search domain has been deleted. The system must clean up resources
	// dedicated to the search domain when DeleteDomain is called. Newly deleted
	// search domains are returned from DescribeDomains with a true value for IsDeleted
	// for several minutes until resource cleanup is complete.
	Deleted *bool `type:"boolean"`

	// The service endpoint for updating documents in a search domain.
	DocService *ServiceEndpoint `type:"structure"`

	// An internally generated unique identifier for a domain.
	//
	// DomainId is a required field
	DomainId *string `min:"1" type:"string" required:"true"`

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	Limits *Limits `type:"structure"`

	// True if processing is being done to activate the current domain configuration.
	Processing *bool `type:"boolean"`

	// True if IndexDocuments needs to be called to activate the current domain
	// configuration.
	//
	// RequiresIndexDocuments is a required field
	RequiresIndexDocuments *bool `type:"boolean" required:"true"`

	// The number of search instances that are available to process search requests.
	SearchInstanceCount *int64 `min:"1" type:"integer"`

	// The instance type that is being used to process search requests.
	SearchInstanceType *string `type:"string"`

	// The number of partitions across which the search index is spread.
	SearchPartitionCount *int64 `min:"1" type:"integer"`

	// The service endpoint for requesting search results from a search domain.
	SearchService *ServiceEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

The current status of the search domain.

func (DomainStatus) GoString

func (s DomainStatus) GoString() string

GoString returns the string representation

func (DomainStatus) String

func (s DomainStatus) String() string

String returns the string representation

type DoubleArrayOptions

type DoubleArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *float64 `type:"double"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// A list of source fields to map to the field.
	SourceFields *string `type:"string"`
	// contains filtered or unexported fields
}

Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

func (DoubleArrayOptions) GoString

func (s DoubleArrayOptions) GoString() string

GoString returns the string representation

func (DoubleArrayOptions) String

func (s DoubleArrayOptions) String() string

String returns the string representation

type DoubleOptions

type DoubleOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	// This can be important if you are using the field in an expression and that
	// field is not present in every document.
	DefaultValue *float64 `type:"double"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// Whether the field can be used to sort the search results.
	SortEnabled *bool `type:"boolean"`

	// The name of the source field to map to the field.
	SourceField *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

func (DoubleOptions) GoString

func (s DoubleOptions) GoString() string

GoString returns the string representation

func (DoubleOptions) String

func (s DoubleOptions) String() string

String returns the string representation

func (*DoubleOptions) Validate

func (s *DoubleOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Expression

type Expression struct {

	// Names must begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore).
	//
	// ExpressionName is a required field
	ExpressionName *string `min:"1" type:"string" required:"true"`

	// The expression to evaluate for sorting while processing a search request.
	// The Expression syntax is based on JavaScript expressions. For more information,
	// see Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)
	// in the Amazon CloudSearch Developer Guide.
	//
	// ExpressionValue is a required field
	ExpressionValue *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

func (Expression) GoString

func (s Expression) GoString() string

GoString returns the string representation

func (Expression) String

func (s Expression) String() string

String returns the string representation

func (*Expression) Validate

func (s *Expression) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExpressionStatus

type ExpressionStatus struct {

	// The expression that is evaluated for sorting while processing a search request.
	//
	// Options is a required field
	Options *Expression `type:"structure" required:"true"`

	// The status of domain configuration option.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The value of an Expression and its current status.

func (ExpressionStatus) GoString

func (s ExpressionStatus) GoString() string

GoString returns the string representation

func (ExpressionStatus) String

func (s ExpressionStatus) String() string

String returns the string representation

type IndexDocumentsInput

type IndexDocumentsInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

func (IndexDocumentsInput) GoString

func (s IndexDocumentsInput) GoString() string

GoString returns the string representation

func (IndexDocumentsInput) String

func (s IndexDocumentsInput) String() string

String returns the string representation

func (*IndexDocumentsInput) Validate

func (s *IndexDocumentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IndexDocumentsOutput

type IndexDocumentsOutput struct {

	// The names of the fields that are currently being indexed.
	FieldNames []string `type:"list"`
	// contains filtered or unexported fields
}

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

func (IndexDocumentsOutput) GoString

func (s IndexDocumentsOutput) GoString() string

GoString returns the string representation

func (IndexDocumentsOutput) SDKResponseMetadata

func (s IndexDocumentsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (IndexDocumentsOutput) String

func (s IndexDocumentsOutput) String() string

String returns the string representation

type IndexDocumentsRequest

type IndexDocumentsRequest struct {
	*aws.Request
	Input *IndexDocumentsInput
	Copy  func(*IndexDocumentsInput) IndexDocumentsRequest
}

IndexDocumentsRequest is a API request type for the IndexDocuments API operation.

func (IndexDocumentsRequest) Send

Send marshals and sends the IndexDocuments API request.

type IndexField

type IndexField struct {

	// Options for a field that contains an array of dates. Present if IndexFieldType
	// specifies the field is of type date-array. All options are enabled by default.
	DateArrayOptions *DateArrayOptions `type:"structure"`

	// Options for a date field. Dates and times are specified in UTC (Coordinated
	// Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present
	// if IndexFieldType specifies the field is of type date. All options are enabled
	// by default.
	DateOptions *DateOptions `type:"structure"`

	// Options for a field that contains an array of double-precision 64-bit floating
	// point values. Present if IndexFieldType specifies the field is of type double-array.
	// All options are enabled by default.
	DoubleArrayOptions *DoubleArrayOptions `type:"structure"`

	// Options for a double-precision 64-bit floating point field. Present if IndexFieldType
	// specifies the field is of type double. All options are enabled by default.
	DoubleOptions *DoubleOptions `type:"structure"`

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines
	// a pattern that begins or ends with a wildcard. Any document fields that don't
	// map to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options.
	//
	// Regular field names begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin
	// or end with a wildcard (*). The wildcard can also be the only character in
	// a dynamic field name. Multiple wildcards, and wildcards embedded within a
	// string are not supported.
	//
	// The name score is reserved and cannot be used as a field name. To reference
	// a document's ID, you can use the name _id.
	//
	// IndexFieldName is a required field
	IndexFieldName *string `min:"1" type:"string" required:"true"`

	// The type of field. The valid options for a field depend on the field type.
	// For more information about the supported field types, see Configuring Index
	// Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)
	// in the Amazon CloudSearch Developer Guide.
	//
	// IndexFieldType is a required field
	IndexFieldType IndexFieldType `type:"string" required:"true" enum:"true"`

	// Options for a field that contains an array of 64-bit signed integers. Present
	// if IndexFieldType specifies the field is of type int-array. All options are
	// enabled by default.
	IntArrayOptions *IntArrayOptions `type:"structure"`

	// Options for a 64-bit signed integer field. Present if IndexFieldType specifies
	// the field is of type int. All options are enabled by default.
	IntOptions *IntOptions `type:"structure"`

	// Options for a latlon field. A latlon field contains a location stored as
	// a latitude and longitude value pair. Present if IndexFieldType specifies
	// the field is of type latlon. All options are enabled by default.
	LatLonOptions *LatLonOptions `type:"structure"`

	// Options for a field that contains an array of literal strings. Present if
	// IndexFieldType specifies the field is of type literal-array. All options
	// are enabled by default.
	LiteralArrayOptions *LiteralArrayOptions `type:"structure"`

	// Options for literal field. Present if IndexFieldType specifies the field
	// is of type literal. All options are enabled by default.
	LiteralOptions *LiteralOptions `type:"structure"`

	// Options for a field that contains an array of text strings. Present if IndexFieldType
	// specifies the field is of type text-array. A text-array field is always searchable.
	// All options are enabled by default.
	TextArrayOptions *TextArrayOptions `type:"structure"`

	// Options for text field. Present if IndexFieldType specifies the field is
	// of type text. A text field is always searchable. All options are enabled
	// by default.
	TextOptions *TextOptions `type:"structure"`
	// contains filtered or unexported fields
}

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

func (IndexField) GoString

func (s IndexField) GoString() string

GoString returns the string representation

func (IndexField) String

func (s IndexField) String() string

String returns the string representation

func (*IndexField) Validate

func (s *IndexField) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IndexFieldStatus

type IndexFieldStatus struct {

	// Configuration information for a field in the index, including its name, type,
	// and options. The supported options depend on the IndexFieldType.
	//
	// Options is a required field
	Options *IndexField `type:"structure" required:"true"`

	// The status of domain configuration option.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The value of an IndexField and its current status.

func (IndexFieldStatus) GoString

func (s IndexFieldStatus) GoString() string

GoString returns the string representation

func (IndexFieldStatus) String

func (s IndexFieldStatus) String() string

String returns the string representation

type IndexFieldType

type IndexFieldType string

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the Amazon CloudSearch Developer Guide.

const (
	IndexFieldTypeInt          IndexFieldType = "int"
	IndexFieldTypeDouble       IndexFieldType = "double"
	IndexFieldTypeLiteral      IndexFieldType = "literal"
	IndexFieldTypeText         IndexFieldType = "text"
	IndexFieldTypeDate         IndexFieldType = "date"
	IndexFieldTypeLatlon       IndexFieldType = "latlon"
	IndexFieldTypeIntArray     IndexFieldType = "int-array"
	IndexFieldTypeDoubleArray  IndexFieldType = "double-array"
	IndexFieldTypeLiteralArray IndexFieldType = "literal-array"
	IndexFieldTypeTextArray    IndexFieldType = "text-array"
	IndexFieldTypeDateArray    IndexFieldType = "date-array"
)

Enum values for IndexFieldType

func (IndexFieldType) MarshalValue added in v0.3.0

func (enum IndexFieldType) MarshalValue() (string, error)

func (IndexFieldType) MarshalValueBuf added in v0.3.0

func (enum IndexFieldType) MarshalValueBuf(b []byte) ([]byte, error)

type IntArrayOptions

type IntArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *int64 `type:"long"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// A list of source fields to map to the field.
	SourceFields *string `type:"string"`
	// contains filtered or unexported fields
}

Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

func (IntArrayOptions) GoString

func (s IntArrayOptions) GoString() string

GoString returns the string representation

func (IntArrayOptions) String

func (s IntArrayOptions) String() string

String returns the string representation

type IntOptions

type IntOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	// This can be important if you are using the field in an expression and that
	// field is not present in every document.
	DefaultValue *int64 `type:"long"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// Whether the field can be used to sort the search results.
	SortEnabled *bool `type:"boolean"`

	// The name of the source field to map to the field.
	SourceField *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

func (IntOptions) GoString

func (s IntOptions) GoString() string

GoString returns the string representation

func (IntOptions) String

func (s IntOptions) String() string

String returns the string representation

func (*IntOptions) Validate

func (s *IntOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LatLonOptions

type LatLonOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string `type:"string"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// Whether the field can be used to sort the search results.
	SortEnabled *bool `type:"boolean"`

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines
	// a pattern that begins or ends with a wildcard. Any document fields that don't
	// map to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options.
	//
	// Regular field names begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin
	// or end with a wildcard (*). The wildcard can also be the only character in
	// a dynamic field name. Multiple wildcards, and wildcards embedded within a
	// string are not supported.
	//
	// The name score is reserved and cannot be used as a field name. To reference
	// a document's ID, you can use the name _id.
	SourceField *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

func (LatLonOptions) GoString

func (s LatLonOptions) GoString() string

GoString returns the string representation

func (LatLonOptions) String

func (s LatLonOptions) String() string

String returns the string representation

func (*LatLonOptions) Validate

func (s *LatLonOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Limits

type Limits struct {

	// MaximumPartitionCount is a required field
	MaximumPartitionCount *int64 `min:"1" type:"integer" required:"true"`

	// MaximumReplicationCount is a required field
	MaximumReplicationCount *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (Limits) GoString

func (s Limits) GoString() string

GoString returns the string representation

func (Limits) String

func (s Limits) String() string

String returns the string representation

type ListDomainNamesInput

type ListDomainNamesInput struct {
	// contains filtered or unexported fields
}

func (ListDomainNamesInput) GoString

func (s ListDomainNamesInput) GoString() string

GoString returns the string representation

func (ListDomainNamesInput) String

func (s ListDomainNamesInput) String() string

String returns the string representation

type ListDomainNamesOutput

type ListDomainNamesOutput struct {

	// The names of the search domains owned by an account.
	DomainNames map[string]string `type:"map"`
	// contains filtered or unexported fields
}

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

func (ListDomainNamesOutput) GoString

func (s ListDomainNamesOutput) GoString() string

GoString returns the string representation

func (ListDomainNamesOutput) SDKResponseMetadata

func (s ListDomainNamesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListDomainNamesOutput) String

func (s ListDomainNamesOutput) String() string

String returns the string representation

type ListDomainNamesRequest

type ListDomainNamesRequest struct {
	*aws.Request
	Input *ListDomainNamesInput
	Copy  func(*ListDomainNamesInput) ListDomainNamesRequest
}

ListDomainNamesRequest is a API request type for the ListDomainNames API operation.

func (ListDomainNamesRequest) Send

Send marshals and sends the ListDomainNames API request.

type LiteralArrayOptions

type LiteralArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string `type:"string"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// A list of source fields to map to the field.
	SourceFields *string `type:"string"`
	// contains filtered or unexported fields
}

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

func (LiteralArrayOptions) GoString

func (s LiteralArrayOptions) GoString() string

GoString returns the string representation

func (LiteralArrayOptions) String

func (s LiteralArrayOptions) String() string

String returns the string representation

type LiteralOptions

type LiteralOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string `type:"string"`

	// Whether facet information can be returned for the field.
	FacetEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the contents of the field are searchable.
	SearchEnabled *bool `type:"boolean"`

	// Whether the field can be used to sort the search results.
	SortEnabled *bool `type:"boolean"`

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines
	// a pattern that begins or ends with a wildcard. Any document fields that don't
	// map to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options.
	//
	// Regular field names begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin
	// or end with a wildcard (*). The wildcard can also be the only character in
	// a dynamic field name. Multiple wildcards, and wildcards embedded within a
	// string are not supported.
	//
	// The name score is reserved and cannot be used as a field name. To reference
	// a document's ID, you can use the name _id.
	SourceField *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

func (LiteralOptions) GoString

func (s LiteralOptions) GoString() string

GoString returns the string representation

func (LiteralOptions) String

func (s LiteralOptions) String() string

String returns the string representation

func (*LiteralOptions) Validate

func (s *LiteralOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OptionState

type OptionState string

The state of processing a change to an option. One of:

  • RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.

  • Processing: The option's latest value is in the process of being activated.

  • Active: The option's latest value is fully deployed.

  • FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

const (
	OptionStateRequiresIndexDocuments OptionState = "RequiresIndexDocuments"
	OptionStateProcessing             OptionState = "Processing"
	OptionStateActive                 OptionState = "Active"
	OptionStateFailedToValidate       OptionState = "FailedToValidate"
)

Enum values for OptionState

func (OptionState) MarshalValue added in v0.3.0

func (enum OptionState) MarshalValue() (string, error)

func (OptionState) MarshalValueBuf added in v0.3.0

func (enum OptionState) MarshalValueBuf(b []byte) ([]byte, error)

type OptionStatus

type OptionStatus struct {

	// A timestamp for when this option was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Indicates that the option will be deleted once processing is complete.
	PendingDeletion *bool `type:"boolean"`

	// The state of processing a change to an option. Possible values:
	//
	//    * RequiresIndexDocuments: the option's latest value will not be deployed
	//    until IndexDocuments has been called and indexing is complete.
	//    * Processing: the option's latest value is in the process of being activated.
	//
	//    * Active: the option's latest value is completely deployed.
	//    * FailedToValidate: the option value is not compatible with the domain's
	//    data and cannot be used to index the data. You must either modify the
	//    option value or update or remove the incompatible documents.
	//
	// State is a required field
	State OptionState `type:"string" required:"true" enum:"true"`

	// A timestamp for when this option was last updated.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// A unique integer that indicates when this option was last updated.
	UpdateVersion *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The status of domain configuration option.

func (OptionStatus) GoString

func (s OptionStatus) GoString() string

GoString returns the string representation

func (OptionStatus) String

func (s OptionStatus) String() string

String returns the string representation

type PartitionInstanceType

type PartitionInstanceType string

The instance type (such as search.m1.small) on which an index partition is hosted.

const (
	PartitionInstanceTypeSearchM1Small   PartitionInstanceType = "search.m1.small"
	PartitionInstanceTypeSearchM1Large   PartitionInstanceType = "search.m1.large"
	PartitionInstanceTypeSearchM2Xlarge  PartitionInstanceType = "search.m2.xlarge"
	PartitionInstanceTypeSearchM22xlarge PartitionInstanceType = "search.m2.2xlarge"
	PartitionInstanceTypeSearchM3Medium  PartitionInstanceType = "search.m3.medium"
	PartitionInstanceTypeSearchM3Large   PartitionInstanceType = "search.m3.large"
	PartitionInstanceTypeSearchM3Xlarge  PartitionInstanceType = "search.m3.xlarge"
	PartitionInstanceTypeSearchM32xlarge PartitionInstanceType = "search.m3.2xlarge"
)

Enum values for PartitionInstanceType

func (PartitionInstanceType) MarshalValue added in v0.3.0

func (enum PartitionInstanceType) MarshalValue() (string, error)

func (PartitionInstanceType) MarshalValueBuf added in v0.3.0

func (enum PartitionInstanceType) MarshalValueBuf(b []byte) ([]byte, error)

type ScalingParameters

type ScalingParameters struct {

	// The instance type that you want to preconfigure for your domain. For example,
	// search.m1.small.
	DesiredInstanceType PartitionInstanceType `type:"string" enum:"true"`

	// The number of partitions you want to preconfigure for your domain. Only valid
	// when you select m2.2xlarge as the desired instance type.
	DesiredPartitionCount *int64 `type:"integer"`

	// The number of replicas you want to preconfigure for each index partition.
	DesiredReplicationCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The desired instance type and desired number of replicas of each index partition.

func (ScalingParameters) GoString

func (s ScalingParameters) GoString() string

GoString returns the string representation

func (ScalingParameters) String

func (s ScalingParameters) String() string

String returns the string representation

type ScalingParametersStatus

type ScalingParametersStatus struct {

	// The desired instance type and desired number of replicas of each index partition.
	//
	// Options is a required field
	Options *ScalingParameters `type:"structure" required:"true"`

	// The status of domain configuration option.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The status and configuration of a search domain's scaling parameters.

func (ScalingParametersStatus) GoString

func (s ScalingParametersStatus) GoString() string

GoString returns the string representation

func (ScalingParametersStatus) String

func (s ScalingParametersStatus) String() string

String returns the string representation

type ServiceEndpoint

type ServiceEndpoint struct {

	// The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
	// or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.
	Endpoint *string `type:"string"`
	// contains filtered or unexported fields
}

The endpoint to which service requests can be submitted.

func (ServiceEndpoint) GoString

func (s ServiceEndpoint) GoString() string

GoString returns the string representation

func (ServiceEndpoint) String

func (s ServiceEndpoint) String() string

String returns the string representation

type Suggester

type Suggester struct {

	// Options for a search suggester.
	//
	// DocumentSuggesterOptions is a required field
	DocumentSuggesterOptions *DocumentSuggesterOptions `type:"structure" required:"true"`

	// Names must begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore).
	//
	// SuggesterName is a required field
	SuggesterName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

func (Suggester) GoString

func (s Suggester) GoString() string

GoString returns the string representation

func (Suggester) String

func (s Suggester) String() string

String returns the string representation

func (*Suggester) Validate

func (s *Suggester) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SuggesterFuzzyMatching

type SuggesterFuzzyMatching string
const (
	SuggesterFuzzyMatchingNone SuggesterFuzzyMatching = "none"
	SuggesterFuzzyMatchingLow  SuggesterFuzzyMatching = "low"
	SuggesterFuzzyMatchingHigh SuggesterFuzzyMatching = "high"
)

Enum values for SuggesterFuzzyMatching

func (SuggesterFuzzyMatching) MarshalValue added in v0.3.0

func (enum SuggesterFuzzyMatching) MarshalValue() (string, error)

func (SuggesterFuzzyMatching) MarshalValueBuf added in v0.3.0

func (enum SuggesterFuzzyMatching) MarshalValueBuf(b []byte) ([]byte, error)

type SuggesterStatus

type SuggesterStatus struct {

	// Configuration information for a search suggester. Each suggester has a unique
	// name and specifies the text field you want to use for suggestions. The following
	// options can be configured for a suggester: FuzzyMatching, SortExpression.
	//
	// Options is a required field
	Options *Suggester `type:"structure" required:"true"`

	// The status of domain configuration option.
	//
	// Status is a required field
	Status *OptionStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The value of a Suggester and its current status.

func (SuggesterStatus) GoString

func (s SuggesterStatus) GoString() string

GoString returns the string representation

func (SuggesterStatus) String

func (s SuggesterStatus) String() string

String returns the string representation

type TextArrayOptions

type TextArrayOptions struct {

	// The name of an analysis scheme for a text-array field.
	AnalysisScheme *string `type:"string"`

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string `type:"string"`

	// Whether highlights can be returned for the field.
	HighlightEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// A list of source fields to map to the field.
	SourceFields *string `type:"string"`
	// contains filtered or unexported fields
}

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

func (TextArrayOptions) GoString

func (s TextArrayOptions) GoString() string

GoString returns the string representation

func (TextArrayOptions) String

func (s TextArrayOptions) String() string

String returns the string representation

type TextOptions

type TextOptions struct {

	// The name of an analysis scheme for a text field.
	AnalysisScheme *string `type:"string"`

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string `type:"string"`

	// Whether highlights can be returned for the field.
	HighlightEnabled *bool `type:"boolean"`

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool `type:"boolean"`

	// Whether the field can be used to sort the search results.
	SortEnabled *bool `type:"boolean"`

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines
	// a pattern that begins or ends with a wildcard. Any document fields that don't
	// map to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options.
	//
	// Regular field names begin with a letter and can contain the following characters:
	// a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin
	// or end with a wildcard (*). The wildcard can also be the only character in
	// a dynamic field name. Multiple wildcards, and wildcards embedded within a
	// string are not supported.
	//
	// The name score is reserved and cannot be used as a field name. To reference
	// a document's ID, you can use the name _id.
	SourceField *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

func (TextOptions) GoString

func (s TextOptions) GoString() string

GoString returns the string representation

func (TextOptions) String

func (s TextOptions) String() string

String returns the string representation

func (*TextOptions) Validate

func (s *TextOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAvailabilityOptionsInput

type UpdateAvailabilityOptionsInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// You expand an existing search domain to a second Availability Zone by setting
	// the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option
	// to downgrade the domain to a single Availability Zone by setting the Multi-AZ
	// option to false.
	//
	// MultiAZ is a required field
	MultiAZ *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

func (UpdateAvailabilityOptionsInput) GoString

GoString returns the string representation

func (UpdateAvailabilityOptionsInput) String

String returns the string representation

func (*UpdateAvailabilityOptionsInput) Validate

func (s *UpdateAvailabilityOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAvailabilityOptionsOutput

type UpdateAvailabilityOptionsOutput struct {

	// The newly-configured availability options. Indicates whether Multi-AZ is
	// enabled for the domain.
	AvailabilityOptions *AvailabilityOptionsStatus `type:"structure"`
	// contains filtered or unexported fields
}

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

func (UpdateAvailabilityOptionsOutput) GoString

GoString returns the string representation

func (UpdateAvailabilityOptionsOutput) SDKResponseMetadata

func (s UpdateAvailabilityOptionsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateAvailabilityOptionsOutput) String

String returns the string representation

type UpdateAvailabilityOptionsRequest

type UpdateAvailabilityOptionsRequest struct {
	*aws.Request
	Input *UpdateAvailabilityOptionsInput
	Copy  func(*UpdateAvailabilityOptionsInput) UpdateAvailabilityOptionsRequest
}

UpdateAvailabilityOptionsRequest is a API request type for the UpdateAvailabilityOptions API operation.

func (UpdateAvailabilityOptionsRequest) Send

Send marshals and sends the UpdateAvailabilityOptions API request.

type UpdateScalingParametersInput

type UpdateScalingParametersInput struct {

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`

	// The desired instance type and desired number of replicas of each index partition.
	//
	// ScalingParameters is a required field
	ScalingParameters *ScalingParameters `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

func (UpdateScalingParametersInput) GoString

func (s UpdateScalingParametersInput) GoString() string

GoString returns the string representation

func (UpdateScalingParametersInput) String

String returns the string representation

func (*UpdateScalingParametersInput) Validate

func (s *UpdateScalingParametersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateScalingParametersOutput

type UpdateScalingParametersOutput struct {

	// The status and configuration of a search domain's scaling parameters.
	//
	// ScalingParameters is a required field
	ScalingParameters *ScalingParametersStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

func (UpdateScalingParametersOutput) GoString

GoString returns the string representation

func (UpdateScalingParametersOutput) SDKResponseMetadata

func (s UpdateScalingParametersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateScalingParametersOutput) String

String returns the string representation

type UpdateScalingParametersRequest

type UpdateScalingParametersRequest struct {
	*aws.Request
	Input *UpdateScalingParametersInput
	Copy  func(*UpdateScalingParametersInput) UpdateScalingParametersRequest
}

UpdateScalingParametersRequest is a API request type for the UpdateScalingParameters API operation.

func (UpdateScalingParametersRequest) Send

Send marshals and sends the UpdateScalingParameters API request.

type UpdateServiceAccessPoliciesInput

type UpdateServiceAccessPoliciesInput struct {

	// The access rules you want to configure. These rules replace any existing
	// rules.
	//
	// AccessPolicies is a required field
	AccessPolicies *string `type:"string" required:"true"`

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start
	// with a letter or number and can contain the following characters: a-z (lowercase),
	// 0-9, and - (hyphen).
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

func (UpdateServiceAccessPoliciesInput) GoString

GoString returns the string representation

func (UpdateServiceAccessPoliciesInput) String

String returns the string representation

func (*UpdateServiceAccessPoliciesInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateServiceAccessPoliciesOutput

type UpdateServiceAccessPoliciesOutput struct {

	// The access rules configured for the domain.
	//
	// AccessPolicies is a required field
	AccessPolicies *AccessPoliciesStatus `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

func (UpdateServiceAccessPoliciesOutput) GoString

GoString returns the string representation

func (UpdateServiceAccessPoliciesOutput) SDKResponseMetadata

func (s UpdateServiceAccessPoliciesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateServiceAccessPoliciesOutput) String

String returns the string representation

type UpdateServiceAccessPoliciesRequest

type UpdateServiceAccessPoliciesRequest struct {
	*aws.Request
	Input *UpdateServiceAccessPoliciesInput
	Copy  func(*UpdateServiceAccessPoliciesInput) UpdateServiceAccessPoliciesRequest
}

UpdateServiceAccessPoliciesRequest is a API request type for the UpdateServiceAccessPolicies API operation.

func (UpdateServiceAccessPoliciesRequest) Send

Send marshals and sends the UpdateServiceAccessPolicies API request.

Directories

Path Synopsis
Package cloudsearchiface provides an interface to enable mocking the Amazon CloudSearch service client for testing your code.
Package cloudsearchiface provides an interface to enable mocking the Amazon CloudSearch service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL