cloudsearch

package
v1.38.68 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2021 License: Apache-2.0 Imports: 8 Imported by: 90

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 contact 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 (
	// AlgorithmicStemmingNone is a AlgorithmicStemming enum value
	AlgorithmicStemmingNone = "none"

	// AlgorithmicStemmingMinimal is a AlgorithmicStemming enum value
	AlgorithmicStemmingMinimal = "minimal"

	// AlgorithmicStemmingLight is a AlgorithmicStemming enum value
	AlgorithmicStemmingLight = "light"

	// AlgorithmicStemmingFull is a AlgorithmicStemming enum value
	AlgorithmicStemmingFull = "full"
)
View Source 
const (
	// AnalysisSchemeLanguageAr is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageAr = "ar"

	// AnalysisSchemeLanguageBg is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageBg = "bg"

	// AnalysisSchemeLanguageCa is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageCa = "ca"

	// AnalysisSchemeLanguageCs is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageCs = "cs"

	// AnalysisSchemeLanguageDa is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageDa = "da"

	// AnalysisSchemeLanguageDe is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageDe = "de"

	// AnalysisSchemeLanguageEl is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageEl = "el"

	// AnalysisSchemeLanguageEn is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageEn = "en"

	// AnalysisSchemeLanguageEs is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageEs = "es"

	// AnalysisSchemeLanguageEu is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageEu = "eu"

	// AnalysisSchemeLanguageFa is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageFa = "fa"

	// AnalysisSchemeLanguageFi is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageFi = "fi"

	// AnalysisSchemeLanguageFr is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageFr = "fr"

	// AnalysisSchemeLanguageGa is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageGa = "ga"

	// AnalysisSchemeLanguageGl is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageGl = "gl"

	// AnalysisSchemeLanguageHe is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageHe = "he"

	// AnalysisSchemeLanguageHi is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageHi = "hi"

	// AnalysisSchemeLanguageHu is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageHu = "hu"

	// AnalysisSchemeLanguageHy is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageHy = "hy"

	// AnalysisSchemeLanguageId is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageId = "id"

	// AnalysisSchemeLanguageIt is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageIt = "it"

	// AnalysisSchemeLanguageJa is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageJa = "ja"

	// AnalysisSchemeLanguageKo is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageKo = "ko"

	// AnalysisSchemeLanguageLv is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageLv = "lv"

	// AnalysisSchemeLanguageMul is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageMul = "mul"

	// AnalysisSchemeLanguageNl is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageNl = "nl"

	// AnalysisSchemeLanguageNo is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageNo = "no"

	// AnalysisSchemeLanguagePt is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguagePt = "pt"

	// AnalysisSchemeLanguageRo is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageRo = "ro"

	// AnalysisSchemeLanguageRu is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageRu = "ru"

	// AnalysisSchemeLanguageSv is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageSv = "sv"

	// AnalysisSchemeLanguageTh is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageTh = "th"

	// AnalysisSchemeLanguageTr is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageTr = "tr"

	// AnalysisSchemeLanguageZhHans is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageZhHans = "zh-Hans"

	// AnalysisSchemeLanguageZhHant is a AnalysisSchemeLanguage enum value
	AnalysisSchemeLanguageZhHant = "zh-Hant"
)

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

View Source 
const (
	// IndexFieldTypeInt is a IndexFieldType enum value
	IndexFieldTypeInt = "int"

	// IndexFieldTypeDouble is a IndexFieldType enum value
	IndexFieldTypeDouble = "double"

	// IndexFieldTypeLiteral is a IndexFieldType enum value
	IndexFieldTypeLiteral = "literal"

	// IndexFieldTypeText is a IndexFieldType enum value
	IndexFieldTypeText = "text"

	// IndexFieldTypeDate is a IndexFieldType enum value
	IndexFieldTypeDate = "date"

	// IndexFieldTypeLatlon is a IndexFieldType enum value
	IndexFieldTypeLatlon = "latlon"

	// IndexFieldTypeIntArray is a IndexFieldType enum value
	IndexFieldTypeIntArray = "int-array"

	// IndexFieldTypeDoubleArray is a IndexFieldType enum value
	IndexFieldTypeDoubleArray = "double-array"

	// IndexFieldTypeLiteralArray is a IndexFieldType enum value
	IndexFieldTypeLiteralArray = "literal-array"

	// IndexFieldTypeTextArray is a IndexFieldType enum value
	IndexFieldTypeTextArray = "text-array"

	// IndexFieldTypeDateArray is a IndexFieldType enum value
	IndexFieldTypeDateArray = "date-array"
)

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.

View Source 
const (
	// OptionStateRequiresIndexDocuments is a OptionState enum value
	OptionStateRequiresIndexDocuments = "RequiresIndexDocuments"

	// OptionStateProcessing is a OptionState enum value
	OptionStateProcessing = "Processing"

	// OptionStateActive is a OptionState enum value
	OptionStateActive = "Active"

	// OptionStateFailedToValidate is a OptionState enum value
	OptionStateFailedToValidate = "FailedToValidate"
)

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.

View Source 
const (
	// PartitionInstanceTypeSearchM1Small is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM1Small = "search.m1.small"

	// PartitionInstanceTypeSearchM1Large is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM1Large = "search.m1.large"

	// PartitionInstanceTypeSearchM2Xlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM2Xlarge = "search.m2.xlarge"

	// PartitionInstanceTypeSearchM22xlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM22xlarge = "search.m2.2xlarge"

	// PartitionInstanceTypeSearchM3Medium is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM3Medium = "search.m3.medium"

	// PartitionInstanceTypeSearchM3Large is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM3Large = "search.m3.large"

	// PartitionInstanceTypeSearchM3Xlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM3Xlarge = "search.m3.xlarge"

	// PartitionInstanceTypeSearchM32xlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchM32xlarge = "search.m3.2xlarge"

	// PartitionInstanceTypeSearchSmall is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchSmall = "search.small"

	// PartitionInstanceTypeSearchMedium is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchMedium = "search.medium"

	// PartitionInstanceTypeSearchLarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchLarge = "search.large"

	// PartitionInstanceTypeSearchXlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchXlarge = "search.xlarge"

	// PartitionInstanceTypeSearch2xlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearch2xlarge = "search.2xlarge"

	// PartitionInstanceTypeSearchPreviousgenerationSmall is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchPreviousgenerationSmall = "search.previousgeneration.small"

	// PartitionInstanceTypeSearchPreviousgenerationLarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchPreviousgenerationLarge = "search.previousgeneration.large"

	// PartitionInstanceTypeSearchPreviousgenerationXlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchPreviousgenerationXlarge = "search.previousgeneration.xlarge"

	// PartitionInstanceTypeSearchPreviousgeneration2xlarge is a PartitionInstanceType enum value
	PartitionInstanceTypeSearchPreviousgeneration2xlarge = "search.previousgeneration.2xlarge"
)

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

View Source 
const (
	// SuggesterFuzzyMatchingNone is a SuggesterFuzzyMatching enum value
	SuggesterFuzzyMatchingNone = "none"

	// SuggesterFuzzyMatchingLow is a SuggesterFuzzyMatching enum value
	SuggesterFuzzyMatchingLow = "low"

	// SuggesterFuzzyMatchingHigh is a SuggesterFuzzyMatching enum value
	SuggesterFuzzyMatchingHigh = "high"
)
View Source 
const (
	// TLSSecurityPolicyPolicyMinTls10201907 is a TLSSecurityPolicy enum value
	TLSSecurityPolicyPolicyMinTls10201907 = "Policy-Min-TLS-1-0-2019-07"

	// TLSSecurityPolicyPolicyMinTls12201907 is a TLSSecurityPolicy enum value
	TLSSecurityPolicyPolicyMinTls12201907 = "Policy-Min-TLS-1-2-2019-07"
)

The minimum required TLS version.

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"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExists".
	//
	// The request was rejected because it attempted to create a resource that already
	// exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExists"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFound".
	//
	// The request was rejected because it attempted to reference a resource that
	// does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFound"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The request was rejected because it has invalid parameters.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "cloudsearch" // Name of service.
	EndpointsID = ServiceName   // ID to lookup a service endpoint with.
	ServiceID   = "CloudSearch" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AlgorithmicStemming_Values added in v1.34.3 

func AlgorithmicStemming_Values() []string

AlgorithmicStemming_Values returns all elements of the AlgorithmicStemming enum

func AnalysisSchemeLanguage_Values added in v1.34.3 

func AnalysisSchemeLanguage_Values() []string

AnalysisSchemeLanguage_Values returns all elements of the AnalysisSchemeLanguage enum

func IndexFieldType_Values added in v1.34.3 

func IndexFieldType_Values() []string

IndexFieldType_Values returns all elements of the IndexFieldType enum

func OptionState_Values added in v1.34.3 

func OptionState_Values() []string

OptionState_Values returns all elements of the OptionState enum

func PartitionInstanceType_Values added in v1.34.3 

func PartitionInstanceType_Values() []string

PartitionInstanceType_Values returns all elements of the PartitionInstanceType enum

func SuggesterFuzzyMatching_Values added in v1.34.3 

func SuggesterFuzzyMatching_Values() []string

SuggesterFuzzyMatching_Values returns all elements of the SuggesterFuzzyMatching enum

func TLSSecurityPolicy_Values added in v1.34.3 

func TLSSecurityPolicy_Values() []string

TLSSecurityPolicy_Values returns all elements of the TLSSecurityPolicy enum

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 added in v0.6.5 

func (s AccessPoliciesStatus) GoString() string

GoString returns the string representation

func (*AccessPoliciesStatus) SetOptions added in v1.5.0 

func (s *AccessPoliciesStatus) SetOptions(v string) *AccessPoliciesStatus

SetOptions sets the Options field's value.

func (*AccessPoliciesStatus) SetStatus added in v1.5.0 

func (s *AccessPoliciesStatus) SetStatus(v *OptionStatus) *AccessPoliciesStatus

SetStatus sets the Status field's value.

func (AccessPoliciesStatus) String added in v0.6.5 

func (s AccessPoliciesStatus) String() string

String returns the string representation

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 *string `type:"string" enum:"AlgorithmicStemming"`

	// 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 added in v0.6.5 

func (s AnalysisOptions) GoString() string

GoString returns the string representation

func (*AnalysisOptions) SetAlgorithmicStemming added in v1.5.0 

func (s *AnalysisOptions) SetAlgorithmicStemming(v string) *AnalysisOptions

SetAlgorithmicStemming sets the AlgorithmicStemming field's value.

func (*AnalysisOptions) SetJapaneseTokenizationDictionary added in v1.5.0 

func (s *AnalysisOptions) SetJapaneseTokenizationDictionary(v string) *AnalysisOptions

SetJapaneseTokenizationDictionary sets the JapaneseTokenizationDictionary field's value.

func (*AnalysisOptions) SetStemmingDictionary added in v1.5.0 

func (s *AnalysisOptions) SetStemmingDictionary(v string) *AnalysisOptions

SetStemmingDictionary sets the StemmingDictionary field's value.

func (*AnalysisOptions) SetStopwords added in v1.5.0 

func (s *AnalysisOptions) SetStopwords(v string) *AnalysisOptions

SetStopwords sets the Stopwords field's value.

func (*AnalysisOptions) SetSynonyms added in v1.5.0 

func (s *AnalysisOptions) SetSynonyms(v string) *AnalysisOptions

SetSynonyms sets the Synonyms field's value.

func (AnalysisOptions) String added in v0.6.5 

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 *string `type:"string" required:"true" enum:"AnalysisSchemeLanguage"`

	// 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 added in v0.6.5 

func (s AnalysisScheme) GoString() string

GoString returns the string representation

func (*AnalysisScheme) SetAnalysisOptions added in v1.5.0 

func (s *AnalysisScheme) SetAnalysisOptions(v *AnalysisOptions) *AnalysisScheme

SetAnalysisOptions sets the AnalysisOptions field's value.

func (*AnalysisScheme) SetAnalysisSchemeLanguage added in v1.5.0 

func (s *AnalysisScheme) SetAnalysisSchemeLanguage(v string) *AnalysisScheme

SetAnalysisSchemeLanguage sets the AnalysisSchemeLanguage field's value.

func (*AnalysisScheme) SetAnalysisSchemeName added in v1.5.0 

func (s *AnalysisScheme) SetAnalysisSchemeName(v string) *AnalysisScheme

SetAnalysisSchemeName sets the AnalysisSchemeName field's value.

func (AnalysisScheme) String added in v0.6.5 

func (s AnalysisScheme) String() string

String returns the string representation

func (*AnalysisScheme) Validate added in v1.1.21 

func (s *AnalysisScheme) Validate() error

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

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 added in v0.6.5 

func (s AnalysisSchemeStatus) GoString() string

GoString returns the string representation

func (*AnalysisSchemeStatus) SetOptions added in v1.5.0 

func (s *AnalysisSchemeStatus) SetOptions(v *AnalysisScheme) *AnalysisSchemeStatus

SetOptions sets the Options field's value.

func (*AnalysisSchemeStatus) SetStatus added in v1.5.0 

func (s *AnalysisSchemeStatus) SetStatus(v *OptionStatus) *AnalysisSchemeStatus

SetStatus sets the Status field's value.

func (AnalysisSchemeStatus) String added in v0.6.5 

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 added in v0.6.5 

func (s AvailabilityOptionsStatus) GoString() string

GoString returns the string representation

func (*AvailabilityOptionsStatus) SetOptions added in v1.5.0 

func (s *AvailabilityOptionsStatus) SetOptions(v bool) *AvailabilityOptionsStatus

SetOptions sets the Options field's value.

func (*AvailabilityOptionsStatus) SetStatus added in v1.5.0 

func (s *AvailabilityOptionsStatus) SetStatus(v *OptionStatus) *AvailabilityOptionsStatus

SetStatus sets the Status field's value.

func (AvailabilityOptionsStatus) String added in v0.6.5 

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 added in v0.6.5 

func (s BuildSuggestersInput) GoString() string

GoString returns the string representation

func (*BuildSuggestersInput) SetDomainName added in v1.5.0 

func (s *BuildSuggestersInput) SetDomainName(v string) *BuildSuggestersInput

SetDomainName sets the DomainName field's value.

func (BuildSuggestersInput) String added in v0.6.5 

func (s BuildSuggestersInput) String() string

String returns the string representation

func (*BuildSuggestersInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s BuildSuggestersOutput) GoString() string

GoString returns the string representation

func (*BuildSuggestersOutput) SetFieldNames added in v1.5.0 

func (s *BuildSuggestersOutput) SetFieldNames(v []*string) *BuildSuggestersOutput

SetFieldNames sets the FieldNames field's value.

func (BuildSuggestersOutput) String added in v0.6.5 

func (s BuildSuggestersOutput) String() string

String returns the string representation

type CloudSearch 

type CloudSearch struct {
	*client.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(p client.ConfigProvider, cfgs ...*aws.Config) *CloudSearch

New creates a new instance of the CloudSearch client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a CloudSearch client from just a session.
svc := cloudsearch.New(mySession)

// Create a CloudSearch client with additional configuration
svc := cloudsearch.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudSearch) BuildSuggesters 

func (c *CloudSearch) BuildSuggesters(input *BuildSuggestersInput) (*BuildSuggestersOutput, error)

BuildSuggesters 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation BuildSuggesters for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) BuildSuggestersRequest 

func (c *CloudSearch) BuildSuggestersRequest(input *BuildSuggestersInput) (req *request.Request, output *BuildSuggestersOutput)

BuildSuggestersRequest generates a "aws/request.Request" representing the client's request for the BuildSuggesters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BuildSuggesters for more information on using the BuildSuggesters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BuildSuggestersRequest method.
req, resp := client.BuildSuggestersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) BuildSuggestersWithContext added in v1.8.0 

func (c *CloudSearch) BuildSuggestersWithContext(ctx aws.Context, input *BuildSuggestersInput, opts ...request.Option) (*BuildSuggestersOutput, error)

BuildSuggestersWithContext is the same as BuildSuggesters with the addition of the ability to pass a context and additional request options.

See BuildSuggesters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) CreateDomain 

func (c *CloudSearch) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)

CreateDomain 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation CreateDomain for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExists" The request was rejected because it attempted to create a resource that already exists.

  • ErrCodeValidationException "ValidationException" The request was rejected because it has invalid parameters.

func (*CloudSearch) CreateDomainRequest 

func (c *CloudSearch) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)

CreateDomainRequest generates a "aws/request.Request" representing the client's request for the CreateDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDomain for more information on using the CreateDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDomainRequest method.
req, resp := client.CreateDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) CreateDomainWithContext added in v1.8.0 

func (c *CloudSearch) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)

CreateDomainWithContext is the same as CreateDomain with the addition of the ability to pass a context and additional request options.

See CreateDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DefineAnalysisScheme 

func (c *CloudSearch) DefineAnalysisScheme(input *DefineAnalysisSchemeInput) (*DefineAnalysisSchemeOutput, error)

DefineAnalysisScheme 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DefineAnalysisScheme for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DefineAnalysisSchemeRequest 

func (c *CloudSearch) DefineAnalysisSchemeRequest(input *DefineAnalysisSchemeInput) (req *request.Request, output *DefineAnalysisSchemeOutput)

DefineAnalysisSchemeRequest generates a "aws/request.Request" representing the client's request for the DefineAnalysisScheme operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DefineAnalysisScheme for more information on using the DefineAnalysisScheme API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DefineAnalysisSchemeRequest method.
req, resp := client.DefineAnalysisSchemeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DefineAnalysisSchemeWithContext added in v1.8.0 

func (c *CloudSearch) DefineAnalysisSchemeWithContext(ctx aws.Context, input *DefineAnalysisSchemeInput, opts ...request.Option) (*DefineAnalysisSchemeOutput, error)

DefineAnalysisSchemeWithContext is the same as DefineAnalysisScheme with the addition of the ability to pass a context and additional request options.

See DefineAnalysisScheme for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DefineExpression 

func (c *CloudSearch) DefineExpression(input *DefineExpressionInput) (*DefineExpressionOutput, error)

DefineExpression 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DefineExpression for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DefineExpressionRequest 

func (c *CloudSearch) DefineExpressionRequest(input *DefineExpressionInput) (req *request.Request, output *DefineExpressionOutput)

DefineExpressionRequest generates a "aws/request.Request" representing the client's request for the DefineExpression operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DefineExpression for more information on using the DefineExpression API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DefineExpressionRequest method.
req, resp := client.DefineExpressionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DefineExpressionWithContext added in v1.8.0 

func (c *CloudSearch) DefineExpressionWithContext(ctx aws.Context, input *DefineExpressionInput, opts ...request.Option) (*DefineExpressionOutput, error)

DefineExpressionWithContext is the same as DefineExpression with the addition of the ability to pass a context and additional request options.

See DefineExpression for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DefineIndexField 

func (c *CloudSearch) DefineIndexField(input *DefineIndexFieldInput) (*DefineIndexFieldOutput, error)

DefineIndexField 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DefineIndexField for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DefineIndexFieldRequest 

func (c *CloudSearch) DefineIndexFieldRequest(input *DefineIndexFieldInput) (req *request.Request, output *DefineIndexFieldOutput)

DefineIndexFieldRequest generates a "aws/request.Request" representing the client's request for the DefineIndexField operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DefineIndexField for more information on using the DefineIndexField API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DefineIndexFieldRequest method.
req, resp := client.DefineIndexFieldRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DefineIndexFieldWithContext added in v1.8.0 

func (c *CloudSearch) DefineIndexFieldWithContext(ctx aws.Context, input *DefineIndexFieldInput, opts ...request.Option) (*DefineIndexFieldOutput, error)

DefineIndexFieldWithContext is the same as DefineIndexField with the addition of the ability to pass a context and additional request options.

See DefineIndexField for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DefineSuggester 

func (c *CloudSearch) DefineSuggester(input *DefineSuggesterInput) (*DefineSuggesterOutput, error)

DefineSuggester 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DefineSuggester for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DefineSuggesterRequest 

func (c *CloudSearch) DefineSuggesterRequest(input *DefineSuggesterInput) (req *request.Request, output *DefineSuggesterOutput)

DefineSuggesterRequest generates a "aws/request.Request" representing the client's request for the DefineSuggester operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DefineSuggester for more information on using the DefineSuggester API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DefineSuggesterRequest method.
req, resp := client.DefineSuggesterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DefineSuggesterWithContext added in v1.8.0 

func (c *CloudSearch) DefineSuggesterWithContext(ctx aws.Context, input *DefineSuggesterInput, opts ...request.Option) (*DefineSuggesterOutput, error)

DefineSuggesterWithContext is the same as DefineSuggester with the addition of the ability to pass a context and additional request options.

See DefineSuggester for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DeleteAnalysisScheme 

func (c *CloudSearch) DeleteAnalysisScheme(input *DeleteAnalysisSchemeInput) (*DeleteAnalysisSchemeOutput, error)

DeleteAnalysisScheme 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DeleteAnalysisScheme for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DeleteAnalysisSchemeRequest 

func (c *CloudSearch) DeleteAnalysisSchemeRequest(input *DeleteAnalysisSchemeInput) (req *request.Request, output *DeleteAnalysisSchemeOutput)

DeleteAnalysisSchemeRequest generates a "aws/request.Request" representing the client's request for the DeleteAnalysisScheme operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAnalysisScheme for more information on using the DeleteAnalysisScheme API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAnalysisSchemeRequest method.
req, resp := client.DeleteAnalysisSchemeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DeleteAnalysisSchemeWithContext added in v1.8.0 

func (c *CloudSearch) DeleteAnalysisSchemeWithContext(ctx aws.Context, input *DeleteAnalysisSchemeInput, opts ...request.Option) (*DeleteAnalysisSchemeOutput, error)

DeleteAnalysisSchemeWithContext is the same as DeleteAnalysisScheme with the addition of the ability to pass a context and additional request options.

See DeleteAnalysisScheme for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DeleteDomain 

func (c *CloudSearch) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)

DeleteDomain 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DeleteDomain for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

func (*CloudSearch) DeleteDomainRequest 

func (c *CloudSearch) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)

DeleteDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDomain for more information on using the DeleteDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDomainRequest method.
req, resp := client.DeleteDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DeleteDomainWithContext added in v1.8.0 

func (c *CloudSearch) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)

DeleteDomainWithContext is the same as DeleteDomain with the addition of the ability to pass a context and additional request options.

See DeleteDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DeleteExpression 

func (c *CloudSearch) DeleteExpression(input *DeleteExpressionInput) (*DeleteExpressionOutput, error)

DeleteExpression 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DeleteExpression for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DeleteExpressionRequest 

func (c *CloudSearch) DeleteExpressionRequest(input *DeleteExpressionInput) (req *request.Request, output *DeleteExpressionOutput)

DeleteExpressionRequest generates a "aws/request.Request" representing the client's request for the DeleteExpression operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteExpression for more information on using the DeleteExpression API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteExpressionRequest method.
req, resp := client.DeleteExpressionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DeleteExpressionWithContext added in v1.8.0 

func (c *CloudSearch) DeleteExpressionWithContext(ctx aws.Context, input *DeleteExpressionInput, opts ...request.Option) (*DeleteExpressionOutput, error)

DeleteExpressionWithContext is the same as DeleteExpression with the addition of the ability to pass a context and additional request options.

See DeleteExpression for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DeleteIndexField 

func (c *CloudSearch) DeleteIndexField(input *DeleteIndexFieldInput) (*DeleteIndexFieldOutput, error)

DeleteIndexField 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DeleteIndexField for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DeleteIndexFieldRequest 

func (c *CloudSearch) DeleteIndexFieldRequest(input *DeleteIndexFieldInput) (req *request.Request, output *DeleteIndexFieldOutput)

DeleteIndexFieldRequest generates a "aws/request.Request" representing the client's request for the DeleteIndexField operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIndexField for more information on using the DeleteIndexField API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteIndexFieldRequest method.
req, resp := client.DeleteIndexFieldRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DeleteIndexFieldWithContext added in v1.8.0 

func (c *CloudSearch) DeleteIndexFieldWithContext(ctx aws.Context, input *DeleteIndexFieldInput, opts ...request.Option) (*DeleteIndexFieldOutput, error)

DeleteIndexFieldWithContext is the same as DeleteIndexField with the addition of the ability to pass a context and additional request options.

See DeleteIndexField for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DeleteSuggester 

func (c *CloudSearch) DeleteSuggester(input *DeleteSuggesterInput) (*DeleteSuggesterOutput, error)

DeleteSuggester 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DeleteSuggester for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DeleteSuggesterRequest 

func (c *CloudSearch) DeleteSuggesterRequest(input *DeleteSuggesterInput) (req *request.Request, output *DeleteSuggesterOutput)

DeleteSuggesterRequest generates a "aws/request.Request" representing the client's request for the DeleteSuggester operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSuggester for more information on using the DeleteSuggester API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSuggesterRequest method.
req, resp := client.DeleteSuggesterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DeleteSuggesterWithContext added in v1.8.0 

func (c *CloudSearch) DeleteSuggesterWithContext(ctx aws.Context, input *DeleteSuggesterInput, opts ...request.Option) (*DeleteSuggesterOutput, error)

DeleteSuggesterWithContext is the same as DeleteSuggester with the addition of the ability to pass a context and additional request options.

See DeleteSuggester for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeAnalysisSchemes 

func (c *CloudSearch) DescribeAnalysisSchemes(input *DescribeAnalysisSchemesInput) (*DescribeAnalysisSchemesOutput, error)

DescribeAnalysisSchemes 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeAnalysisSchemes for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DescribeAnalysisSchemesRequest 

func (c *CloudSearch) DescribeAnalysisSchemesRequest(input *DescribeAnalysisSchemesInput) (req *request.Request, output *DescribeAnalysisSchemesOutput)

DescribeAnalysisSchemesRequest generates a "aws/request.Request" representing the client's request for the DescribeAnalysisSchemes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAnalysisSchemes for more information on using the DescribeAnalysisSchemes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAnalysisSchemesRequest method.
req, resp := client.DescribeAnalysisSchemesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeAnalysisSchemesWithContext added in v1.8.0 

func (c *CloudSearch) DescribeAnalysisSchemesWithContext(ctx aws.Context, input *DescribeAnalysisSchemesInput, opts ...request.Option) (*DescribeAnalysisSchemesOutput, error)

DescribeAnalysisSchemesWithContext is the same as DescribeAnalysisSchemes with the addition of the ability to pass a context and additional request options.

See DescribeAnalysisSchemes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeAvailabilityOptions 

func (c *CloudSearch) DescribeAvailabilityOptions(input *DescribeAvailabilityOptionsInput) (*DescribeAvailabilityOptionsOutput, error)

DescribeAvailabilityOptions 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeAvailabilityOptions for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

  • ErrCodeDisabledOperationException "DisabledAction" The request was rejected because it attempted an operation which is not enabled.

func (*CloudSearch) DescribeAvailabilityOptionsRequest 

func (c *CloudSearch) DescribeAvailabilityOptionsRequest(input *DescribeAvailabilityOptionsInput) (req *request.Request, output *DescribeAvailabilityOptionsOutput)

DescribeAvailabilityOptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeAvailabilityOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAvailabilityOptions for more information on using the DescribeAvailabilityOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAvailabilityOptionsRequest method.
req, resp := client.DescribeAvailabilityOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeAvailabilityOptionsWithContext added in v1.8.0 

func (c *CloudSearch) DescribeAvailabilityOptionsWithContext(ctx aws.Context, input *DescribeAvailabilityOptionsInput, opts ...request.Option) (*DescribeAvailabilityOptionsOutput, error)

DescribeAvailabilityOptionsWithContext is the same as DescribeAvailabilityOptions with the addition of the ability to pass a context and additional request options.

See DescribeAvailabilityOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeDomainEndpointOptions added in v1.25.34 

func (c *CloudSearch) DescribeDomainEndpointOptions(input *DescribeDomainEndpointOptionsInput) (*DescribeDomainEndpointOptionsOutput, error)

DescribeDomainEndpointOptions API operation for Amazon CloudSearch.

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the Amazon CloudSearch Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeDomainEndpointOptions for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

  • ErrCodeDisabledOperationException "DisabledAction" The request was rejected because it attempted an operation which is not enabled.

func (*CloudSearch) DescribeDomainEndpointOptionsRequest added in v1.25.34 

func (c *CloudSearch) DescribeDomainEndpointOptionsRequest(input *DescribeDomainEndpointOptionsInput) (req *request.Request, output *DescribeDomainEndpointOptionsOutput)

DescribeDomainEndpointOptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainEndpointOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDomainEndpointOptions for more information on using the DescribeDomainEndpointOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDomainEndpointOptionsRequest method.
req, resp := client.DescribeDomainEndpointOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeDomainEndpointOptionsWithContext added in v1.25.34 

func (c *CloudSearch) DescribeDomainEndpointOptionsWithContext(ctx aws.Context, input *DescribeDomainEndpointOptionsInput, opts ...request.Option) (*DescribeDomainEndpointOptionsOutput, error)

DescribeDomainEndpointOptionsWithContext is the same as DescribeDomainEndpointOptions with the addition of the ability to pass a context and additional request options.

See DescribeDomainEndpointOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeDomains 

func (c *CloudSearch) DescribeDomains(input *DescribeDomainsInput) (*DescribeDomainsOutput, error)

DescribeDomains 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeDomains for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

func (*CloudSearch) DescribeDomainsRequest 

func (c *CloudSearch) DescribeDomainsRequest(input *DescribeDomainsInput) (req *request.Request, output *DescribeDomainsOutput)

DescribeDomainsRequest generates a "aws/request.Request" representing the client's request for the DescribeDomains operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDomains for more information on using the DescribeDomains API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDomainsRequest method.
req, resp := client.DescribeDomainsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeDomainsWithContext added in v1.8.0 

func (c *CloudSearch) DescribeDomainsWithContext(ctx aws.Context, input *DescribeDomainsInput, opts ...request.Option) (*DescribeDomainsOutput, error)

DescribeDomainsWithContext is the same as DescribeDomains with the addition of the ability to pass a context and additional request options.

See DescribeDomains for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeExpressions 

func (c *CloudSearch) DescribeExpressions(input *DescribeExpressionsInput) (*DescribeExpressionsOutput, error)

DescribeExpressions 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeExpressions for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DescribeExpressionsRequest 

func (c *CloudSearch) DescribeExpressionsRequest(input *DescribeExpressionsInput) (req *request.Request, output *DescribeExpressionsOutput)

DescribeExpressionsRequest generates a "aws/request.Request" representing the client's request for the DescribeExpressions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExpressions for more information on using the DescribeExpressions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeExpressionsRequest method.
req, resp := client.DescribeExpressionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeExpressionsWithContext added in v1.8.0 

func (c *CloudSearch) DescribeExpressionsWithContext(ctx aws.Context, input *DescribeExpressionsInput, opts ...request.Option) (*DescribeExpressionsOutput, error)

DescribeExpressionsWithContext is the same as DescribeExpressions with the addition of the ability to pass a context and additional request options.

See DescribeExpressions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeIndexFields 

func (c *CloudSearch) DescribeIndexFields(input *DescribeIndexFieldsInput) (*DescribeIndexFieldsOutput, error)

DescribeIndexFields 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeIndexFields for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DescribeIndexFieldsRequest 

func (c *CloudSearch) DescribeIndexFieldsRequest(input *DescribeIndexFieldsInput) (req *request.Request, output *DescribeIndexFieldsOutput)

DescribeIndexFieldsRequest generates a "aws/request.Request" representing the client's request for the DescribeIndexFields operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIndexFields for more information on using the DescribeIndexFields API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeIndexFieldsRequest method.
req, resp := client.DescribeIndexFieldsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeIndexFieldsWithContext added in v1.8.0 

func (c *CloudSearch) DescribeIndexFieldsWithContext(ctx aws.Context, input *DescribeIndexFieldsInput, opts ...request.Option) (*DescribeIndexFieldsOutput, error)

DescribeIndexFieldsWithContext is the same as DescribeIndexFields with the addition of the ability to pass a context and additional request options.

See DescribeIndexFields for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeScalingParameters 

func (c *CloudSearch) DescribeScalingParameters(input *DescribeScalingParametersInput) (*DescribeScalingParametersOutput, error)

DescribeScalingParameters 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeScalingParameters for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DescribeScalingParametersRequest 

func (c *CloudSearch) DescribeScalingParametersRequest(input *DescribeScalingParametersInput) (req *request.Request, output *DescribeScalingParametersOutput)

DescribeScalingParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScalingParameters for more information on using the DescribeScalingParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeScalingParametersRequest method.
req, resp := client.DescribeScalingParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeScalingParametersWithContext added in v1.8.0 

func (c *CloudSearch) DescribeScalingParametersWithContext(ctx aws.Context, input *DescribeScalingParametersInput, opts ...request.Option) (*DescribeScalingParametersOutput, error)

DescribeScalingParametersWithContext is the same as DescribeScalingParameters with the addition of the ability to pass a context and additional request options.

See DescribeScalingParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeServiceAccessPolicies 

func (c *CloudSearch) DescribeServiceAccessPolicies(input *DescribeServiceAccessPoliciesInput) (*DescribeServiceAccessPoliciesOutput, error)

DescribeServiceAccessPolicies 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeServiceAccessPolicies for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DescribeServiceAccessPoliciesRequest 

func (c *CloudSearch) DescribeServiceAccessPoliciesRequest(input *DescribeServiceAccessPoliciesInput) (req *request.Request, output *DescribeServiceAccessPoliciesOutput)

DescribeServiceAccessPoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribeServiceAccessPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeServiceAccessPolicies for more information on using the DescribeServiceAccessPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeServiceAccessPoliciesRequest method.
req, resp := client.DescribeServiceAccessPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeServiceAccessPoliciesWithContext added in v1.8.0 

func (c *CloudSearch) DescribeServiceAccessPoliciesWithContext(ctx aws.Context, input *DescribeServiceAccessPoliciesInput, opts ...request.Option) (*DescribeServiceAccessPoliciesOutput, error)

DescribeServiceAccessPoliciesWithContext is the same as DescribeServiceAccessPolicies with the addition of the ability to pass a context and additional request options.

See DescribeServiceAccessPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) DescribeSuggesters 

func (c *CloudSearch) DescribeSuggesters(input *DescribeSuggestersInput) (*DescribeSuggestersOutput, error)

DescribeSuggesters 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation DescribeSuggesters for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) DescribeSuggestersRequest 

func (c *CloudSearch) DescribeSuggestersRequest(input *DescribeSuggestersInput) (req *request.Request, output *DescribeSuggestersOutput)

DescribeSuggestersRequest generates a "aws/request.Request" representing the client's request for the DescribeSuggesters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSuggesters for more information on using the DescribeSuggesters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeSuggestersRequest method.
req, resp := client.DescribeSuggestersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) DescribeSuggestersWithContext added in v1.8.0 

func (c *CloudSearch) DescribeSuggestersWithContext(ctx aws.Context, input *DescribeSuggestersInput, opts ...request.Option) (*DescribeSuggestersOutput, error)

DescribeSuggestersWithContext is the same as DescribeSuggesters with the addition of the ability to pass a context and additional request options.

See DescribeSuggesters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) IndexDocuments 

func (c *CloudSearch) IndexDocuments(input *IndexDocumentsInput) (*IndexDocumentsOutput, error)

IndexDocuments 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation IndexDocuments for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

func (*CloudSearch) IndexDocumentsRequest 

func (c *CloudSearch) IndexDocumentsRequest(input *IndexDocumentsInput) (req *request.Request, output *IndexDocumentsOutput)

IndexDocumentsRequest generates a "aws/request.Request" representing the client's request for the IndexDocuments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IndexDocuments for more information on using the IndexDocuments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the IndexDocumentsRequest method.
req, resp := client.IndexDocumentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) IndexDocumentsWithContext added in v1.8.0 

func (c *CloudSearch) IndexDocumentsWithContext(ctx aws.Context, input *IndexDocumentsInput, opts ...request.Option) (*IndexDocumentsOutput, error)

IndexDocumentsWithContext is the same as IndexDocuments with the addition of the ability to pass a context and additional request options.

See IndexDocuments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) ListDomainNames 

func (c *CloudSearch) ListDomainNames(input *ListDomainNamesInput) (*ListDomainNamesOutput, error)

ListDomainNames API operation for Amazon CloudSearch.

Lists all search domains owned by an account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation ListDomainNames for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

func (*CloudSearch) ListDomainNamesRequest 

func (c *CloudSearch) ListDomainNamesRequest(input *ListDomainNamesInput) (req *request.Request, output *ListDomainNamesOutput)

ListDomainNamesRequest generates a "aws/request.Request" representing the client's request for the ListDomainNames operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDomainNames for more information on using the ListDomainNames API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDomainNamesRequest method.
req, resp := client.ListDomainNamesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) ListDomainNamesWithContext added in v1.8.0 

func (c *CloudSearch) ListDomainNamesWithContext(ctx aws.Context, input *ListDomainNamesInput, opts ...request.Option) (*ListDomainNamesOutput, error)

ListDomainNamesWithContext is the same as ListDomainNames with the addition of the ability to pass a context and additional request options.

See ListDomainNames for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) UpdateAvailabilityOptions 

func (c *CloudSearch) UpdateAvailabilityOptions(input *UpdateAvailabilityOptionsInput) (*UpdateAvailabilityOptionsOutput, error)

UpdateAvailabilityOptions 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation UpdateAvailabilityOptions for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

  • ErrCodeDisabledOperationException "DisabledAction" The request was rejected because it attempted an operation which is not enabled.

  • ErrCodeValidationException "ValidationException" The request was rejected because it has invalid parameters.

func (*CloudSearch) UpdateAvailabilityOptionsRequest 

func (c *CloudSearch) UpdateAvailabilityOptionsRequest(input *UpdateAvailabilityOptionsInput) (req *request.Request, output *UpdateAvailabilityOptionsOutput)

UpdateAvailabilityOptionsRequest generates a "aws/request.Request" representing the client's request for the UpdateAvailabilityOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAvailabilityOptions for more information on using the UpdateAvailabilityOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAvailabilityOptionsRequest method.
req, resp := client.UpdateAvailabilityOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) UpdateAvailabilityOptionsWithContext added in v1.8.0 

func (c *CloudSearch) UpdateAvailabilityOptionsWithContext(ctx aws.Context, input *UpdateAvailabilityOptionsInput, opts ...request.Option) (*UpdateAvailabilityOptionsOutput, error)

UpdateAvailabilityOptionsWithContext is the same as UpdateAvailabilityOptions with the addition of the ability to pass a context and additional request options.

See UpdateAvailabilityOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) UpdateDomainEndpointOptions added in v1.25.34 

func (c *CloudSearch) UpdateDomainEndpointOptions(input *UpdateDomainEndpointOptionsInput) (*UpdateDomainEndpointOptionsOutput, error)

UpdateDomainEndpointOptions API operation for Amazon CloudSearch.

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the Amazon CloudSearch Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation UpdateDomainEndpointOptions for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

  • ErrCodeDisabledOperationException "DisabledAction" The request was rejected because it attempted an operation which is not enabled.

  • ErrCodeValidationException "ValidationException" The request was rejected because it has invalid parameters.

func (*CloudSearch) UpdateDomainEndpointOptionsRequest added in v1.25.34 

func (c *CloudSearch) UpdateDomainEndpointOptionsRequest(input *UpdateDomainEndpointOptionsInput) (req *request.Request, output *UpdateDomainEndpointOptionsOutput)

UpdateDomainEndpointOptionsRequest generates a "aws/request.Request" representing the client's request for the UpdateDomainEndpointOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDomainEndpointOptions for more information on using the UpdateDomainEndpointOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDomainEndpointOptionsRequest method.
req, resp := client.UpdateDomainEndpointOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) UpdateDomainEndpointOptionsWithContext added in v1.25.34 

func (c *CloudSearch) UpdateDomainEndpointOptionsWithContext(ctx aws.Context, input *UpdateDomainEndpointOptionsInput, opts ...request.Option) (*UpdateDomainEndpointOptionsOutput, error)

UpdateDomainEndpointOptionsWithContext is the same as UpdateDomainEndpointOptions with the addition of the ability to pass a context and additional request options.

See UpdateDomainEndpointOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) UpdateScalingParameters 

func (c *CloudSearch) UpdateScalingParameters(input *UpdateScalingParametersInput) (*UpdateScalingParametersOutput, error)

UpdateScalingParameters 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation UpdateScalingParameters for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

func (*CloudSearch) UpdateScalingParametersRequest 

func (c *CloudSearch) UpdateScalingParametersRequest(input *UpdateScalingParametersInput) (req *request.Request, output *UpdateScalingParametersOutput)

UpdateScalingParametersRequest generates a "aws/request.Request" representing the client's request for the UpdateScalingParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateScalingParameters for more information on using the UpdateScalingParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateScalingParametersRequest method.
req, resp := client.UpdateScalingParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) UpdateScalingParametersWithContext added in v1.8.0 

func (c *CloudSearch) UpdateScalingParametersWithContext(ctx aws.Context, input *UpdateScalingParametersInput, opts ...request.Option) (*UpdateScalingParametersOutput, error)

UpdateScalingParametersWithContext is the same as UpdateScalingParameters with the addition of the ability to pass a context and additional request options.

See UpdateScalingParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudSearch) UpdateServiceAccessPolicies 

func (c *CloudSearch) UpdateServiceAccessPolicies(input *UpdateServiceAccessPoliciesInput) (*UpdateServiceAccessPoliciesOutput, error)

UpdateServiceAccessPolicies 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudSearch's API operation UpdateServiceAccessPolicies for usage and error information.

Returned Error Codes:

  • ErrCodeBaseException "BaseException" An error occurred while processing the request.

  • ErrCodeInternalException "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/).

  • ErrCodeLimitExceededException "LimitExceeded" The request was rejected because a resource limit has already been met.

  • ErrCodeResourceNotFoundException "ResourceNotFound" The request was rejected because it attempted to reference a resource that does not exist.

  • ErrCodeInvalidTypeException "InvalidType" The request was rejected because it specified an invalid type definition.

func (*CloudSearch) UpdateServiceAccessPoliciesRequest 

func (c *CloudSearch) UpdateServiceAccessPoliciesRequest(input *UpdateServiceAccessPoliciesInput) (req *request.Request, output *UpdateServiceAccessPoliciesOutput)

UpdateServiceAccessPoliciesRequest generates a "aws/request.Request" representing the client's request for the UpdateServiceAccessPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateServiceAccessPolicies for more information on using the UpdateServiceAccessPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateServiceAccessPoliciesRequest method.
req, resp := client.UpdateServiceAccessPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*CloudSearch) UpdateServiceAccessPoliciesWithContext added in v1.8.0 

func (c *CloudSearch) UpdateServiceAccessPoliciesWithContext(ctx aws.Context, input *UpdateServiceAccessPoliciesInput, opts ...request.Option) (*UpdateServiceAccessPoliciesOutput, error)

UpdateServiceAccessPoliciesWithContext is the same as UpdateServiceAccessPolicies with the addition of the ability to pass a context and additional request options.

See UpdateServiceAccessPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 added in v0.6.5 

func (s CreateDomainInput) GoString() string

GoString returns the string representation

func (*CreateDomainInput) SetDomainName added in v1.5.0 

func (s *CreateDomainInput) SetDomainName(v string) *CreateDomainInput

SetDomainName sets the DomainName field's value.

func (CreateDomainInput) String added in v0.6.5 

func (s CreateDomainInput) String() string

String returns the string representation

func (*CreateDomainInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s CreateDomainOutput) GoString() string

GoString returns the string representation

func (*CreateDomainOutput) SetDomainStatus added in v1.5.0 

func (s *CreateDomainOutput) SetDomainStatus(v *DomainStatus) *CreateDomainOutput

SetDomainStatus sets the DomainStatus field's value.

func (CreateDomainOutput) String added in v0.6.5 

func (s CreateDomainOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DateArrayOptions) GoString() string

GoString returns the string representation

func (*DateArrayOptions) SetDefaultValue added in v1.5.0 

func (s *DateArrayOptions) SetDefaultValue(v string) *DateArrayOptions

SetDefaultValue sets the DefaultValue field's value.

func (*DateArrayOptions) SetFacetEnabled added in v1.5.0 

func (s *DateArrayOptions) SetFacetEnabled(v bool) *DateArrayOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*DateArrayOptions) SetReturnEnabled added in v1.5.0 

func (s *DateArrayOptions) SetReturnEnabled(v bool) *DateArrayOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*DateArrayOptions) SetSearchEnabled added in v1.5.0 

func (s *DateArrayOptions) SetSearchEnabled(v bool) *DateArrayOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*DateArrayOptions) SetSourceFields added in v1.5.0 

func (s *DateArrayOptions) SetSourceFields(v string) *DateArrayOptions

SetSourceFields sets the SourceFields field's value.

func (DateArrayOptions) String added in v0.6.5 

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 added in v0.6.5 

func (s DateOptions) GoString() string

GoString returns the string representation

func (*DateOptions) SetDefaultValue added in v1.5.0 

func (s *DateOptions) SetDefaultValue(v string) *DateOptions

SetDefaultValue sets the DefaultValue field's value.

func (*DateOptions) SetFacetEnabled added in v1.5.0 

func (s *DateOptions) SetFacetEnabled(v bool) *DateOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*DateOptions) SetReturnEnabled added in v1.5.0 

func (s *DateOptions) SetReturnEnabled(v bool) *DateOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*DateOptions) SetSearchEnabled added in v1.5.0 

func (s *DateOptions) SetSearchEnabled(v bool) *DateOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*DateOptions) SetSortEnabled added in v1.5.0 

func (s *DateOptions) SetSortEnabled(v bool) *DateOptions

SetSortEnabled sets the SortEnabled field's value.

func (*DateOptions) SetSourceField added in v1.5.0 

func (s *DateOptions) SetSourceField(v string) *DateOptions

SetSourceField sets the SourceField field's value.

func (DateOptions) String added in v0.6.5 

func (s DateOptions) String() string

String returns the string representation

func (*DateOptions) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DefineAnalysisSchemeInput) GoString() string

GoString returns the string representation

func (*DefineAnalysisSchemeInput) SetAnalysisScheme added in v1.5.0 

func (s *DefineAnalysisSchemeInput) SetAnalysisScheme(v *AnalysisScheme) *DefineAnalysisSchemeInput

SetAnalysisScheme sets the AnalysisScheme field's value.

func (*DefineAnalysisSchemeInput) SetDomainName added in v1.5.0 

func (s *DefineAnalysisSchemeInput) SetDomainName(v string) *DefineAnalysisSchemeInput

SetDomainName sets the DomainName field's value.

func (DefineAnalysisSchemeInput) String added in v0.6.5 

func (s DefineAnalysisSchemeInput) String() string

String returns the string representation

func (*DefineAnalysisSchemeInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DefineAnalysisSchemeOutput) GoString() string

GoString returns the string representation

func (*DefineAnalysisSchemeOutput) SetAnalysisScheme added in v1.5.0 

func (s *DefineAnalysisSchemeOutput) SetAnalysisScheme(v *AnalysisSchemeStatus) *DefineAnalysisSchemeOutput

SetAnalysisScheme sets the AnalysisScheme field's value.

func (DefineAnalysisSchemeOutput) String added in v0.6.5 

func (s DefineAnalysisSchemeOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DefineExpressionInput) GoString() string

GoString returns the string representation

func (*DefineExpressionInput) SetDomainName added in v1.5.0 

func (s *DefineExpressionInput) SetDomainName(v string) *DefineExpressionInput

SetDomainName sets the DomainName field's value.

func (*DefineExpressionInput) SetExpression added in v1.5.0 

func (s *DefineExpressionInput) SetExpression(v *Expression) *DefineExpressionInput

SetExpression sets the Expression field's value.

func (DefineExpressionInput) String added in v0.6.5 

func (s DefineExpressionInput) String() string

String returns the string representation

func (*DefineExpressionInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DefineExpressionOutput) GoString() string

GoString returns the string representation

func (*DefineExpressionOutput) SetExpression added in v1.5.0 

func (s *DefineExpressionOutput) SetExpression(v *ExpressionStatus) *DefineExpressionOutput

SetExpression sets the Expression field's value.

func (DefineExpressionOutput) String added in v0.6.5 

func (s DefineExpressionOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DefineIndexFieldInput) GoString() string

GoString returns the string representation

func (*DefineIndexFieldInput) SetDomainName added in v1.5.0 

func (s *DefineIndexFieldInput) SetDomainName(v string) *DefineIndexFieldInput

SetDomainName sets the DomainName field's value.

func (*DefineIndexFieldInput) SetIndexField added in v1.5.0 

func (s *DefineIndexFieldInput) SetIndexField(v *IndexField) *DefineIndexFieldInput

SetIndexField sets the IndexField field's value.

func (DefineIndexFieldInput) String added in v0.6.5 

func (s DefineIndexFieldInput) String() string

String returns the string representation

func (*DefineIndexFieldInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DefineIndexFieldOutput) GoString() string

GoString returns the string representation

func (*DefineIndexFieldOutput) SetIndexField added in v1.5.0 

func (s *DefineIndexFieldOutput) SetIndexField(v *IndexFieldStatus) *DefineIndexFieldOutput

SetIndexField sets the IndexField field's value.

func (DefineIndexFieldOutput) String added in v0.6.5 

func (s DefineIndexFieldOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DefineSuggesterInput) GoString() string

GoString returns the string representation

func (*DefineSuggesterInput) SetDomainName added in v1.5.0 

func (s *DefineSuggesterInput) SetDomainName(v string) *DefineSuggesterInput

SetDomainName sets the DomainName field's value.

func (*DefineSuggesterInput) SetSuggester added in v1.5.0 

func (s *DefineSuggesterInput) SetSuggester(v *Suggester) *DefineSuggesterInput

SetSuggester sets the Suggester field's value.

func (DefineSuggesterInput) String added in v0.6.5 

func (s DefineSuggesterInput) String() string

String returns the string representation

func (*DefineSuggesterInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DefineSuggesterOutput) GoString() string

GoString returns the string representation

func (*DefineSuggesterOutput) SetSuggester added in v1.5.0 

func (s *DefineSuggesterOutput) SetSuggester(v *SuggesterStatus) *DefineSuggesterOutput

SetSuggester sets the Suggester field's value.

func (DefineSuggesterOutput) String added in v0.6.5 

func (s DefineSuggesterOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DeleteAnalysisSchemeInput) GoString() string

GoString returns the string representation

func (*DeleteAnalysisSchemeInput) SetAnalysisSchemeName added in v1.5.0 

func (s *DeleteAnalysisSchemeInput) SetAnalysisSchemeName(v string) *DeleteAnalysisSchemeInput

SetAnalysisSchemeName sets the AnalysisSchemeName field's value.

func (*DeleteAnalysisSchemeInput) SetDomainName added in v1.5.0 

func (s *DeleteAnalysisSchemeInput) SetDomainName(v string) *DeleteAnalysisSchemeInput

SetDomainName sets the DomainName field's value.

func (DeleteAnalysisSchemeInput) String added in v0.6.5 

func (s DeleteAnalysisSchemeInput) String() string

String returns the string representation

func (*DeleteAnalysisSchemeInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteAnalysisSchemeOutput) GoString() string

GoString returns the string representation

func (*DeleteAnalysisSchemeOutput) SetAnalysisScheme added in v1.5.0 

func (s *DeleteAnalysisSchemeOutput) SetAnalysisScheme(v *AnalysisSchemeStatus) *DeleteAnalysisSchemeOutput

SetAnalysisScheme sets the AnalysisScheme field's value.

func (DeleteAnalysisSchemeOutput) String added in v0.6.5 

func (s DeleteAnalysisSchemeOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DeleteDomainInput) GoString() string

GoString returns the string representation

func (*DeleteDomainInput) SetDomainName added in v1.5.0 

func (s *DeleteDomainInput) SetDomainName(v string) *DeleteDomainInput

SetDomainName sets the DomainName field's value.

func (DeleteDomainInput) String added in v0.6.5 

func (s DeleteDomainInput) String() string

String returns the string representation

func (*DeleteDomainInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation

func (*DeleteDomainOutput) SetDomainStatus added in v1.5.0 

func (s *DeleteDomainOutput) SetDomainStatus(v *DomainStatus) *DeleteDomainOutput

SetDomainStatus sets the DomainStatus field's value.

func (DeleteDomainOutput) String added in v0.6.5 

func (s DeleteDomainOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DeleteExpressionInput) GoString() string

GoString returns the string representation

func (*DeleteExpressionInput) SetDomainName added in v1.5.0 

func (s *DeleteExpressionInput) SetDomainName(v string) *DeleteExpressionInput

SetDomainName sets the DomainName field's value.

func (*DeleteExpressionInput) SetExpressionName added in v1.5.0 

func (s *DeleteExpressionInput) SetExpressionName(v string) *DeleteExpressionInput

SetExpressionName sets the ExpressionName field's value.

func (DeleteExpressionInput) String added in v0.6.5 

func (s DeleteExpressionInput) String() string

String returns the string representation

func (*DeleteExpressionInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteExpressionOutput) GoString() string

GoString returns the string representation

func (*DeleteExpressionOutput) SetExpression added in v1.5.0 

func (s *DeleteExpressionOutput) SetExpression(v *ExpressionStatus) *DeleteExpressionOutput

SetExpression sets the Expression field's value.

func (DeleteExpressionOutput) String added in v0.6.5 

func (s DeleteExpressionOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DeleteIndexFieldInput) GoString() string

GoString returns the string representation

func (*DeleteIndexFieldInput) SetDomainName added in v1.5.0 

func (s *DeleteIndexFieldInput) SetDomainName(v string) *DeleteIndexFieldInput

SetDomainName sets the DomainName field's value.

func (*DeleteIndexFieldInput) SetIndexFieldName added in v1.5.0 

func (s *DeleteIndexFieldInput) SetIndexFieldName(v string) *DeleteIndexFieldInput

SetIndexFieldName sets the IndexFieldName field's value.

func (DeleteIndexFieldInput) String added in v0.6.5 

func (s DeleteIndexFieldInput) String() string

String returns the string representation

func (*DeleteIndexFieldInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteIndexFieldOutput) GoString() string

GoString returns the string representation

func (*DeleteIndexFieldOutput) SetIndexField added in v1.5.0 

func (s *DeleteIndexFieldOutput) SetIndexField(v *IndexFieldStatus) *DeleteIndexFieldOutput

SetIndexField sets the IndexField field's value.

func (DeleteIndexFieldOutput) String added in v0.6.5 

func (s DeleteIndexFieldOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DeleteSuggesterInput) GoString() string

GoString returns the string representation

func (*DeleteSuggesterInput) SetDomainName added in v1.5.0 

func (s *DeleteSuggesterInput) SetDomainName(v string) *DeleteSuggesterInput

SetDomainName sets the DomainName field's value.

func (*DeleteSuggesterInput) SetSuggesterName added in v1.5.0 

func (s *DeleteSuggesterInput) SetSuggesterName(v string) *DeleteSuggesterInput

SetSuggesterName sets the SuggesterName field's value.

func (DeleteSuggesterInput) String added in v0.6.5 

func (s DeleteSuggesterInput) String() string

String returns the string representation

func (*DeleteSuggesterInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteSuggesterOutput) GoString() string

GoString returns the string representation

func (*DeleteSuggesterOutput) SetSuggester added in v1.5.0 

func (s *DeleteSuggesterOutput) SetSuggester(v *SuggesterStatus) *DeleteSuggesterOutput

SetSuggester sets the Suggester field's value.

func (DeleteSuggesterOutput) String added in v0.6.5 

func (s DeleteSuggesterOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeAnalysisSchemesInput) GoString() string

GoString returns the string representation

func (*DescribeAnalysisSchemesInput) SetAnalysisSchemeNames added in v1.5.0 

func (s *DescribeAnalysisSchemesInput) SetAnalysisSchemeNames(v []*string) *DescribeAnalysisSchemesInput

SetAnalysisSchemeNames sets the AnalysisSchemeNames field's value.

func (*DescribeAnalysisSchemesInput) SetDeployed added in v1.5.0 

func (s *DescribeAnalysisSchemesInput) SetDeployed(v bool) *DescribeAnalysisSchemesInput

SetDeployed sets the Deployed field's value.

func (*DescribeAnalysisSchemesInput) SetDomainName added in v1.5.0 

func (s *DescribeAnalysisSchemesInput) SetDomainName(v string) *DescribeAnalysisSchemesInput

SetDomainName sets the DomainName field's value.

func (DescribeAnalysisSchemesInput) String added in v0.6.5 

func (s DescribeAnalysisSchemesInput) String() string

String returns the string representation

func (*DescribeAnalysisSchemesInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeAnalysisSchemesOutput) GoString() string

GoString returns the string representation

func (*DescribeAnalysisSchemesOutput) SetAnalysisSchemes added in v1.5.0 

func (s *DescribeAnalysisSchemesOutput) SetAnalysisSchemes(v []*AnalysisSchemeStatus) *DescribeAnalysisSchemesOutput

SetAnalysisSchemes sets the AnalysisSchemes field's value.

func (DescribeAnalysisSchemesOutput) String added in v0.6.5 

func (s DescribeAnalysisSchemesOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeAvailabilityOptionsInput) GoString() string

GoString returns the string representation

func (*DescribeAvailabilityOptionsInput) SetDeployed added in v1.5.0 

func (s *DescribeAvailabilityOptionsInput) SetDeployed(v bool) *DescribeAvailabilityOptionsInput

SetDeployed sets the Deployed field's value.

func (*DescribeAvailabilityOptionsInput) SetDomainName added in v1.5.0 

func (s *DescribeAvailabilityOptionsInput) SetDomainName(v string) *DescribeAvailabilityOptionsInput

SetDomainName sets the DomainName field's value.

func (DescribeAvailabilityOptionsInput) String added in v0.6.5 

func (s DescribeAvailabilityOptionsInput) String() string

String returns the string representation

func (*DescribeAvailabilityOptionsInput) Validate added in v1.1.21 

func (s *DescribeAvailabilityOptionsInput) Validate() error

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 added in v0.6.5 

func (s DescribeAvailabilityOptionsOutput) GoString() string

GoString returns the string representation

func (*DescribeAvailabilityOptionsOutput) SetAvailabilityOptions added in v1.5.0 

func (s *DescribeAvailabilityOptionsOutput) SetAvailabilityOptions(v *AvailabilityOptionsStatus) *DescribeAvailabilityOptionsOutput

SetAvailabilityOptions sets the AvailabilityOptions field's value.

func (DescribeAvailabilityOptionsOutput) String added in v0.6.5 

func (s DescribeAvailabilityOptionsOutput) String() string

String returns the string representation

type DescribeDomainEndpointOptionsInput added in v1.25.34 

type DescribeDomainEndpointOptionsInput struct {

	// Whether to retrieve the latest configuration (which might be in a Processing
	// state) or the current, active configuration. Defaults to false.
	Deployed *bool `type:"boolean"`

	// A string that represents the name of a domain.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainEndpointOptions operation. Specify 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 (DescribeDomainEndpointOptionsInput) GoString added in v1.25.34 

func (s DescribeDomainEndpointOptionsInput) GoString() string

GoString returns the string representation

func (*DescribeDomainEndpointOptionsInput) SetDeployed added in v1.25.34 

func (s *DescribeDomainEndpointOptionsInput) SetDeployed(v bool) *DescribeDomainEndpointOptionsInput

SetDeployed sets the Deployed field's value.

func (*DescribeDomainEndpointOptionsInput) SetDomainName added in v1.25.34 

func (s *DescribeDomainEndpointOptionsInput) SetDomainName(v string) *DescribeDomainEndpointOptionsInput

SetDomainName sets the DomainName field's value.

func (DescribeDomainEndpointOptionsInput) String added in v1.25.34 

func (s DescribeDomainEndpointOptionsInput) String() string

String returns the string representation

func (*DescribeDomainEndpointOptionsInput) Validate added in v1.25.34 

func (s *DescribeDomainEndpointOptionsInput) Validate() error

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

type DescribeDomainEndpointOptionsOutput added in v1.25.34 

type DescribeDomainEndpointOptionsOutput struct {

	// The status and configuration of a search domain's endpoint options.
	DomainEndpointOptions *DomainEndpointOptionsStatus `type:"structure"`
	// contains filtered or unexported fields
}

The result of a DescribeDomainEndpointOptions request. Contains the status and configuration of a search domain's endpoint options.

func (DescribeDomainEndpointOptionsOutput) GoString added in v1.25.34 

func (s DescribeDomainEndpointOptionsOutput) GoString() string

GoString returns the string representation

func (*DescribeDomainEndpointOptionsOutput) SetDomainEndpointOptions added in v1.25.34 

func (s *DescribeDomainEndpointOptionsOutput) SetDomainEndpointOptions(v *DomainEndpointOptionsStatus) *DescribeDomainEndpointOptionsOutput

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (DescribeDomainEndpointOptionsOutput) String added in v1.25.34 

func (s DescribeDomainEndpointOptionsOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeDomainsInput) GoString() string

GoString returns the string representation

func (*DescribeDomainsInput) SetDomainNames added in v1.5.0 

func (s *DescribeDomainsInput) SetDomainNames(v []*string) *DescribeDomainsInput

SetDomainNames sets the DomainNames field's value.

func (DescribeDomainsInput) String added in v0.6.5 

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 added in v0.6.5 

func (s DescribeDomainsOutput) GoString() string

GoString returns the string representation

func (*DescribeDomainsOutput) SetDomainStatusList added in v1.5.0 

func (s *DescribeDomainsOutput) SetDomainStatusList(v []*DomainStatus) *DescribeDomainsOutput

SetDomainStatusList sets the DomainStatusList field's value.

func (DescribeDomainsOutput) String added in v0.6.5 

func (s DescribeDomainsOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeExpressionsInput) GoString() string

GoString returns the string representation

func (*DescribeExpressionsInput) SetDeployed added in v1.5.0 

func (s *DescribeExpressionsInput) SetDeployed(v bool) *DescribeExpressionsInput

SetDeployed sets the Deployed field's value.

func (*DescribeExpressionsInput) SetDomainName added in v1.5.0 

func (s *DescribeExpressionsInput) SetDomainName(v string) *DescribeExpressionsInput

SetDomainName sets the DomainName field's value.

func (*DescribeExpressionsInput) SetExpressionNames added in v1.5.0 

func (s *DescribeExpressionsInput) SetExpressionNames(v []*string) *DescribeExpressionsInput

SetExpressionNames sets the ExpressionNames field's value.

func (DescribeExpressionsInput) String added in v0.6.5 

func (s DescribeExpressionsInput) String() string

String returns the string representation

func (*DescribeExpressionsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeExpressionsOutput) GoString() string

GoString returns the string representation

func (*DescribeExpressionsOutput) SetExpressions added in v1.5.0 

func (s *DescribeExpressionsOutput) SetExpressions(v []*ExpressionStatus) *DescribeExpressionsOutput

SetExpressions sets the Expressions field's value.

func (DescribeExpressionsOutput) String added in v0.6.5 

func (s DescribeExpressionsOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeIndexFieldsInput) GoString() string

GoString returns the string representation

func (*DescribeIndexFieldsInput) SetDeployed added in v1.5.0 

func (s *DescribeIndexFieldsInput) SetDeployed(v bool) *DescribeIndexFieldsInput

SetDeployed sets the Deployed field's value.

func (*DescribeIndexFieldsInput) SetDomainName added in v1.5.0 

func (s *DescribeIndexFieldsInput) SetDomainName(v string) *DescribeIndexFieldsInput

SetDomainName sets the DomainName field's value.

func (*DescribeIndexFieldsInput) SetFieldNames added in v1.5.0 

func (s *DescribeIndexFieldsInput) SetFieldNames(v []*string) *DescribeIndexFieldsInput

SetFieldNames sets the FieldNames field's value.

func (DescribeIndexFieldsInput) String added in v0.6.5 

func (s DescribeIndexFieldsInput) String() string

String returns the string representation

func (*DescribeIndexFieldsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeIndexFieldsOutput) GoString() string

GoString returns the string representation

func (*DescribeIndexFieldsOutput) SetIndexFields added in v1.5.0 

func (s *DescribeIndexFieldsOutput) SetIndexFields(v []*IndexFieldStatus) *DescribeIndexFieldsOutput

SetIndexFields sets the IndexFields field's value.

func (DescribeIndexFieldsOutput) String added in v0.6.5 

func (s DescribeIndexFieldsOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeScalingParametersInput) GoString() string

GoString returns the string representation

func (*DescribeScalingParametersInput) SetDomainName added in v1.5.0 

func (s *DescribeScalingParametersInput) SetDomainName(v string) *DescribeScalingParametersInput

SetDomainName sets the DomainName field's value.

func (DescribeScalingParametersInput) String added in v0.6.5 

func (s DescribeScalingParametersInput) String() string

String returns the string representation

func (*DescribeScalingParametersInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeScalingParametersOutput) GoString() string

GoString returns the string representation

func (*DescribeScalingParametersOutput) SetScalingParameters added in v1.5.0 

func (s *DescribeScalingParametersOutput) SetScalingParameters(v *ScalingParametersStatus) *DescribeScalingParametersOutput

SetScalingParameters sets the ScalingParameters field's value.

func (DescribeScalingParametersOutput) String added in v0.6.5 

func (s DescribeScalingParametersOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeServiceAccessPoliciesInput) GoString() string

GoString returns the string representation

func (*DescribeServiceAccessPoliciesInput) SetDeployed added in v1.5.0 

func (s *DescribeServiceAccessPoliciesInput) SetDeployed(v bool) *DescribeServiceAccessPoliciesInput

SetDeployed sets the Deployed field's value.

func (*DescribeServiceAccessPoliciesInput) SetDomainName added in v1.5.0 

func (s *DescribeServiceAccessPoliciesInput) SetDomainName(v string) *DescribeServiceAccessPoliciesInput

SetDomainName sets the DomainName field's value.

func (DescribeServiceAccessPoliciesInput) String added in v0.6.5 

func (s DescribeServiceAccessPoliciesInput) String() string

String returns the string representation

func (*DescribeServiceAccessPoliciesInput) Validate added in v1.1.21 

func (s *DescribeServiceAccessPoliciesInput) Validate() error

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 added in v0.6.5 

func (s DescribeServiceAccessPoliciesOutput) GoString() string

GoString returns the string representation

func (*DescribeServiceAccessPoliciesOutput) SetAccessPolicies added in v1.5.0 

func (s *DescribeServiceAccessPoliciesOutput) SetAccessPolicies(v *AccessPoliciesStatus) *DescribeServiceAccessPoliciesOutput

SetAccessPolicies sets the AccessPolicies field's value.

func (DescribeServiceAccessPoliciesOutput) String added in v0.6.5 

func (s DescribeServiceAccessPoliciesOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s DescribeSuggestersInput) GoString() string

GoString returns the string representation

func (*DescribeSuggestersInput) SetDeployed added in v1.5.0 

func (s *DescribeSuggestersInput) SetDeployed(v bool) *DescribeSuggestersInput

SetDeployed sets the Deployed field's value.

func (*DescribeSuggestersInput) SetDomainName added in v1.5.0 

func (s *DescribeSuggestersInput) SetDomainName(v string) *DescribeSuggestersInput

SetDomainName sets the DomainName field's value.

func (*DescribeSuggestersInput) SetSuggesterNames added in v1.5.0 

func (s *DescribeSuggestersInput) SetSuggesterNames(v []*string) *DescribeSuggestersInput

SetSuggesterNames sets the SuggesterNames field's value.

func (DescribeSuggestersInput) String added in v0.6.5 

func (s DescribeSuggestersInput) String() string

String returns the string representation

func (*DescribeSuggestersInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeSuggestersOutput) GoString() string

GoString returns the string representation

func (*DescribeSuggestersOutput) SetSuggesters added in v1.5.0 

func (s *DescribeSuggestersOutput) SetSuggesters(v []*SuggesterStatus) *DescribeSuggestersOutput

SetSuggesters sets the Suggesters field's value.

func (DescribeSuggestersOutput) String added in v0.6.5 

func (s DescribeSuggestersOutput) String() string

String returns the string representation

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 *string `type:"string" enum:"SuggesterFuzzyMatching"`

	// 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 added in v0.6.5 

func (s DocumentSuggesterOptions) GoString() string

GoString returns the string representation

func (*DocumentSuggesterOptions) SetFuzzyMatching added in v1.5.0 

func (s *DocumentSuggesterOptions) SetFuzzyMatching(v string) *DocumentSuggesterOptions

SetFuzzyMatching sets the FuzzyMatching field's value.

func (*DocumentSuggesterOptions) SetSortExpression added in v1.5.0 

func (s *DocumentSuggesterOptions) SetSortExpression(v string) *DocumentSuggesterOptions

SetSortExpression sets the SortExpression field's value.

func (*DocumentSuggesterOptions) SetSourceField added in v1.5.0 

func (s *DocumentSuggesterOptions) SetSourceField(v string) *DocumentSuggesterOptions

SetSourceField sets the SourceField field's value.

func (DocumentSuggesterOptions) String added in v0.6.5 

func (s DocumentSuggesterOptions) String() string

String returns the string representation

func (*DocumentSuggesterOptions) Validate added in v1.1.21 

func (s *DocumentSuggesterOptions) Validate() error

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

type DomainEndpointOptions added in v1.25.34 

type DomainEndpointOptions struct {

	// Whether the domain is HTTPS only enabled.
	EnforceHTTPS *bool `type:"boolean"`

	// The minimum required TLS version
	TLSSecurityPolicy *string `type:"string" enum:"TLSSecurityPolicy"`
	// contains filtered or unexported fields
}

The domain's endpoint options.

func (DomainEndpointOptions) GoString added in v1.25.34 

func (s DomainEndpointOptions) GoString() string

GoString returns the string representation

func (*DomainEndpointOptions) SetEnforceHTTPS added in v1.25.34 

func (s *DomainEndpointOptions) SetEnforceHTTPS(v bool) *DomainEndpointOptions

SetEnforceHTTPS sets the EnforceHTTPS field's value.

func (*DomainEndpointOptions) SetTLSSecurityPolicy added in v1.25.34 

func (s *DomainEndpointOptions) SetTLSSecurityPolicy(v string) *DomainEndpointOptions

SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.

func (DomainEndpointOptions) String added in v1.25.34 

func (s DomainEndpointOptions) String() string

String returns the string representation

type DomainEndpointOptionsStatus added in v1.25.34 

type DomainEndpointOptionsStatus struct {

	// The domain endpoint options configured for the domain.
	//
	// Options is a required field
	Options *DomainEndpointOptions `type:"structure" required:"true"`

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

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

func (DomainEndpointOptionsStatus) GoString added in v1.25.34 

func (s DomainEndpointOptionsStatus) GoString() string

GoString returns the string representation

func (*DomainEndpointOptionsStatus) SetOptions added in v1.25.34 

func (s *DomainEndpointOptionsStatus) SetOptions(v *DomainEndpointOptions) *DomainEndpointOptionsStatus

SetOptions sets the Options field's value.

func (*DomainEndpointOptionsStatus) SetStatus added in v1.25.34 

func (s *DomainEndpointOptionsStatus) SetStatus(v *OptionStatus) *DomainEndpointOptionsStatus

SetStatus sets the Status field's value.

func (DomainEndpointOptionsStatus) String added in v1.25.34 

func (s DomainEndpointOptionsStatus) String() string

String returns the string representation

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 added in v0.6.5 

func (s DomainStatus) GoString() string

GoString returns the string representation

func (*DomainStatus) SetARN added in v1.5.0 

func (s *DomainStatus) SetARN(v string) *DomainStatus

SetARN sets the ARN field's value.

func (*DomainStatus) SetCreated added in v1.5.0 

func (s *DomainStatus) SetCreated(v bool) *DomainStatus

SetCreated sets the Created field's value.

func (*DomainStatus) SetDeleted added in v1.5.0 

func (s *DomainStatus) SetDeleted(v bool) *DomainStatus

SetDeleted sets the Deleted field's value.

func (*DomainStatus) SetDocService added in v1.5.0 

func (s *DomainStatus) SetDocService(v *ServiceEndpoint) *DomainStatus

SetDocService sets the DocService field's value.

func (*DomainStatus) SetDomainId added in v1.5.0 

func (s *DomainStatus) SetDomainId(v string) *DomainStatus

SetDomainId sets the DomainId field's value.

func (*DomainStatus) SetDomainName added in v1.5.0 

func (s *DomainStatus) SetDomainName(v string) *DomainStatus

SetDomainName sets the DomainName field's value.

func (*DomainStatus) SetLimits added in v1.5.0 

func (s *DomainStatus) SetLimits(v *Limits) *DomainStatus

SetLimits sets the Limits field's value.

func (*DomainStatus) SetProcessing added in v1.5.0 

func (s *DomainStatus) SetProcessing(v bool) *DomainStatus

SetProcessing sets the Processing field's value.

func (*DomainStatus) SetRequiresIndexDocuments added in v1.5.0 

func (s *DomainStatus) SetRequiresIndexDocuments(v bool) *DomainStatus

SetRequiresIndexDocuments sets the RequiresIndexDocuments field's value.

func (*DomainStatus) SetSearchInstanceCount added in v1.5.0 

func (s *DomainStatus) SetSearchInstanceCount(v int64) *DomainStatus

SetSearchInstanceCount sets the SearchInstanceCount field's value.

func (*DomainStatus) SetSearchInstanceType added in v1.5.0 

func (s *DomainStatus) SetSearchInstanceType(v string) *DomainStatus

SetSearchInstanceType sets the SearchInstanceType field's value.

func (*DomainStatus) SetSearchPartitionCount added in v1.5.0 

func (s *DomainStatus) SetSearchPartitionCount(v int64) *DomainStatus

SetSearchPartitionCount sets the SearchPartitionCount field's value.

func (*DomainStatus) SetSearchService added in v1.5.0 

func (s *DomainStatus) SetSearchService(v *ServiceEndpoint) *DomainStatus

SetSearchService sets the SearchService field's value.

func (DomainStatus) String added in v0.6.5 

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 added in v0.6.5 

func (s DoubleArrayOptions) GoString() string

GoString returns the string representation

func (*DoubleArrayOptions) SetDefaultValue added in v1.5.0 

func (s *DoubleArrayOptions) SetDefaultValue(v float64) *DoubleArrayOptions

SetDefaultValue sets the DefaultValue field's value.

func (*DoubleArrayOptions) SetFacetEnabled added in v1.5.0 

func (s *DoubleArrayOptions) SetFacetEnabled(v bool) *DoubleArrayOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*DoubleArrayOptions) SetReturnEnabled added in v1.5.0 

func (s *DoubleArrayOptions) SetReturnEnabled(v bool) *DoubleArrayOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*DoubleArrayOptions) SetSearchEnabled added in v1.5.0 

func (s *DoubleArrayOptions) SetSearchEnabled(v bool) *DoubleArrayOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*DoubleArrayOptions) SetSourceFields added in v1.5.0 

func (s *DoubleArrayOptions) SetSourceFields(v string) *DoubleArrayOptions

SetSourceFields sets the SourceFields field's value.

func (DoubleArrayOptions) String added in v0.6.5 

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 added in v0.6.5 

func (s DoubleOptions) GoString() string

GoString returns the string representation

func (*DoubleOptions) SetDefaultValue added in v1.5.0 

func (s *DoubleOptions) SetDefaultValue(v float64) *DoubleOptions

SetDefaultValue sets the DefaultValue field's value.

func (*DoubleOptions) SetFacetEnabled added in v1.5.0 

func (s *DoubleOptions) SetFacetEnabled(v bool) *DoubleOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*DoubleOptions) SetReturnEnabled added in v1.5.0 

func (s *DoubleOptions) SetReturnEnabled(v bool) *DoubleOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*DoubleOptions) SetSearchEnabled added in v1.5.0 

func (s *DoubleOptions) SetSearchEnabled(v bool) *DoubleOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*DoubleOptions) SetSortEnabled added in v1.5.0 

func (s *DoubleOptions) SetSortEnabled(v bool) *DoubleOptions

SetSortEnabled sets the SortEnabled field's value.

func (*DoubleOptions) SetSourceField added in v1.5.0 

func (s *DoubleOptions) SetSourceField(v string) *DoubleOptions

SetSourceField sets the SourceField field's value.

func (DoubleOptions) String added in v0.6.5 

func (s DoubleOptions) String() string

String returns the string representation

func (*DoubleOptions) Validate added in v1.1.21 

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 added in v0.6.5 

func (s Expression) GoString() string

GoString returns the string representation

func (*Expression) SetExpressionName added in v1.5.0 

func (s *Expression) SetExpressionName(v string) *Expression

SetExpressionName sets the ExpressionName field's value.

func (*Expression) SetExpressionValue added in v1.5.0 

func (s *Expression) SetExpressionValue(v string) *Expression

SetExpressionValue sets the ExpressionValue field's value.

func (Expression) String added in v0.6.5 

func (s Expression) String() string

String returns the string representation

func (*Expression) Validate added in v1.1.21 

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 added in v0.6.5 

func (s ExpressionStatus) GoString() string

GoString returns the string representation

func (*ExpressionStatus) SetOptions added in v1.5.0 

func (s *ExpressionStatus) SetOptions(v *Expression) *ExpressionStatus

SetOptions sets the Options field's value.

func (*ExpressionStatus) SetStatus added in v1.5.0 

func (s *ExpressionStatus) SetStatus(v *OptionStatus) *ExpressionStatus

SetStatus sets the Status field's value.

func (ExpressionStatus) String added in v0.6.5 

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 added in v0.6.5 

func (s IndexDocumentsInput) GoString() string

GoString returns the string representation

func (*IndexDocumentsInput) SetDomainName added in v1.5.0 

func (s *IndexDocumentsInput) SetDomainName(v string) *IndexDocumentsInput

SetDomainName sets the DomainName field's value.

func (IndexDocumentsInput) String added in v0.6.5 

func (s IndexDocumentsInput) String() string

String returns the string representation

func (*IndexDocumentsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s IndexDocumentsOutput) GoString() string

GoString returns the string representation

func (*IndexDocumentsOutput) SetFieldNames added in v1.5.0 

func (s *IndexDocumentsOutput) SetFieldNames(v []*string) *IndexDocumentsOutput

SetFieldNames sets the FieldNames field's value.

func (IndexDocumentsOutput) String added in v0.6.5 

func (s IndexDocumentsOutput) String() string

String returns the string representation

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 *string `type:"string" required:"true" enum:"IndexFieldType"`

	// 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 added in v0.6.5 

func (s IndexField) GoString() string

GoString returns the string representation

func (*IndexField) SetDateArrayOptions added in v1.5.0 

func (s *IndexField) SetDateArrayOptions(v *DateArrayOptions) *IndexField

SetDateArrayOptions sets the DateArrayOptions field's value.

func (*IndexField) SetDateOptions added in v1.5.0 

func (s *IndexField) SetDateOptions(v *DateOptions) *IndexField

SetDateOptions sets the DateOptions field's value.

func (*IndexField) SetDoubleArrayOptions added in v1.5.0 

func (s *IndexField) SetDoubleArrayOptions(v *DoubleArrayOptions) *IndexField

SetDoubleArrayOptions sets the DoubleArrayOptions field's value.

func (*IndexField) SetDoubleOptions added in v1.5.0 

func (s *IndexField) SetDoubleOptions(v *DoubleOptions) *IndexField

SetDoubleOptions sets the DoubleOptions field's value.

func (*IndexField) SetIndexFieldName added in v1.5.0 

func (s *IndexField) SetIndexFieldName(v string) *IndexField

SetIndexFieldName sets the IndexFieldName field's value.

func (*IndexField) SetIndexFieldType added in v1.5.0 

func (s *IndexField) SetIndexFieldType(v string) *IndexField

SetIndexFieldType sets the IndexFieldType field's value.

func (*IndexField) SetIntArrayOptions added in v1.5.0 

func (s *IndexField) SetIntArrayOptions(v *IntArrayOptions) *IndexField

SetIntArrayOptions sets the IntArrayOptions field's value.

func (*IndexField) SetIntOptions added in v1.5.0 

func (s *IndexField) SetIntOptions(v *IntOptions) *IndexField

SetIntOptions sets the IntOptions field's value.

func (*IndexField) SetLatLonOptions added in v1.5.0 

func (s *IndexField) SetLatLonOptions(v *LatLonOptions) *IndexField

SetLatLonOptions sets the LatLonOptions field's value.

func (*IndexField) SetLiteralArrayOptions added in v1.5.0 

func (s *IndexField) SetLiteralArrayOptions(v *LiteralArrayOptions) *IndexField

SetLiteralArrayOptions sets the LiteralArrayOptions field's value.

func (*IndexField) SetLiteralOptions added in v1.5.0 

func (s *IndexField) SetLiteralOptions(v *LiteralOptions) *IndexField

SetLiteralOptions sets the LiteralOptions field's value.

func (*IndexField) SetTextArrayOptions added in v1.5.0 

func (s *IndexField) SetTextArrayOptions(v *TextArrayOptions) *IndexField

SetTextArrayOptions sets the TextArrayOptions field's value.

func (*IndexField) SetTextOptions added in v1.5.0 

func (s *IndexField) SetTextOptions(v *TextOptions) *IndexField

SetTextOptions sets the TextOptions field's value.

func (IndexField) String added in v0.6.5 

func (s IndexField) String() string

String returns the string representation

func (*IndexField) Validate added in v1.1.21 

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 added in v0.6.5 

func (s IndexFieldStatus) GoString() string

GoString returns the string representation

func (*IndexFieldStatus) SetOptions added in v1.5.0 

func (s *IndexFieldStatus) SetOptions(v *IndexField) *IndexFieldStatus

SetOptions sets the Options field's value.

func (*IndexFieldStatus) SetStatus added in v1.5.0 

func (s *IndexFieldStatus) SetStatus(v *OptionStatus) *IndexFieldStatus

SetStatus sets the Status field's value.

func (IndexFieldStatus) String added in v0.6.5 

func (s IndexFieldStatus) String() string

String returns the string representation

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 added in v0.6.5 

func (s IntArrayOptions) GoString() string

GoString returns the string representation

func (*IntArrayOptions) SetDefaultValue added in v1.5.0 

func (s *IntArrayOptions) SetDefaultValue(v int64) *IntArrayOptions

SetDefaultValue sets the DefaultValue field's value.

func (*IntArrayOptions) SetFacetEnabled added in v1.5.0 

func (s *IntArrayOptions) SetFacetEnabled(v bool) *IntArrayOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*IntArrayOptions) SetReturnEnabled added in v1.5.0 

func (s *IntArrayOptions) SetReturnEnabled(v bool) *IntArrayOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*IntArrayOptions) SetSearchEnabled added in v1.5.0 

func (s *IntArrayOptions) SetSearchEnabled(v bool) *IntArrayOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*IntArrayOptions) SetSourceFields added in v1.5.0 

func (s *IntArrayOptions) SetSourceFields(v string) *IntArrayOptions

SetSourceFields sets the SourceFields field's value.

func (IntArrayOptions) String added in v0.6.5 

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 added in v0.6.5 

func (s IntOptions) GoString() string

GoString returns the string representation

func (*IntOptions) SetDefaultValue added in v1.5.0 

func (s *IntOptions) SetDefaultValue(v int64) *IntOptions

SetDefaultValue sets the DefaultValue field's value.

func (*IntOptions) SetFacetEnabled added in v1.5.0 

func (s *IntOptions) SetFacetEnabled(v bool) *IntOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*IntOptions) SetReturnEnabled added in v1.5.0 

func (s *IntOptions) SetReturnEnabled(v bool) *IntOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*IntOptions) SetSearchEnabled added in v1.5.0 

func (s *IntOptions) SetSearchEnabled(v bool) *IntOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*IntOptions) SetSortEnabled added in v1.5.0 

func (s *IntOptions) SetSortEnabled(v bool) *IntOptions

SetSortEnabled sets the SortEnabled field's value.

func (*IntOptions) SetSourceField added in v1.5.0 

func (s *IntOptions) SetSourceField(v string) *IntOptions

SetSourceField sets the SourceField field's value.

func (IntOptions) String added in v0.6.5 

func (s IntOptions) String() string

String returns the string representation

func (*IntOptions) Validate added in v1.1.21 

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 added in v0.6.5 

func (s LatLonOptions) GoString() string

GoString returns the string representation

func (*LatLonOptions) SetDefaultValue added in v1.5.0 

func (s *LatLonOptions) SetDefaultValue(v string) *LatLonOptions

SetDefaultValue sets the DefaultValue field's value.

func (*LatLonOptions) SetFacetEnabled added in v1.5.0 

func (s *LatLonOptions) SetFacetEnabled(v bool) *LatLonOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*LatLonOptions) SetReturnEnabled added in v1.5.0 

func (s *LatLonOptions) SetReturnEnabled(v bool) *LatLonOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*LatLonOptions) SetSearchEnabled added in v1.5.0 

func (s *LatLonOptions) SetSearchEnabled(v bool) *LatLonOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*LatLonOptions) SetSortEnabled added in v1.5.0 

func (s *LatLonOptions) SetSortEnabled(v bool) *LatLonOptions

SetSortEnabled sets the SortEnabled field's value.

func (*LatLonOptions) SetSourceField added in v1.5.0 

func (s *LatLonOptions) SetSourceField(v string) *LatLonOptions

SetSourceField sets the SourceField field's value.

func (LatLonOptions) String added in v0.6.5 

func (s LatLonOptions) String() string

String returns the string representation

func (*LatLonOptions) Validate added in v1.1.21 

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 added in v0.6.5 

func (s Limits) GoString() string

GoString returns the string representation

func (*Limits) SetMaximumPartitionCount added in v1.5.0 

func (s *Limits) SetMaximumPartitionCount(v int64) *Limits

SetMaximumPartitionCount sets the MaximumPartitionCount field's value.

func (*Limits) SetMaximumReplicationCount added in v1.5.0 

func (s *Limits) SetMaximumReplicationCount(v int64) *Limits

SetMaximumReplicationCount sets the MaximumReplicationCount field's value.

func (Limits) String added in v0.6.5 

func (s Limits) String() string

String returns the string representation

type ListDomainNamesInput 

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

func (ListDomainNamesInput) GoString added in v0.6.5 

func (s ListDomainNamesInput) GoString() string

GoString returns the string representation

func (ListDomainNamesInput) String added in v0.6.5 

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 added in v0.6.5 

func (s ListDomainNamesOutput) GoString() string

GoString returns the string representation

func (*ListDomainNamesOutput) SetDomainNames added in v1.5.0 

func (s *ListDomainNamesOutput) SetDomainNames(v map[string]*string) *ListDomainNamesOutput

SetDomainNames sets the DomainNames field's value.

func (ListDomainNamesOutput) String added in v0.6.5 

func (s ListDomainNamesOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s LiteralArrayOptions) GoString() string

GoString returns the string representation

func (*LiteralArrayOptions) SetDefaultValue added in v1.5.0 

func (s *LiteralArrayOptions) SetDefaultValue(v string) *LiteralArrayOptions

SetDefaultValue sets the DefaultValue field's value.

func (*LiteralArrayOptions) SetFacetEnabled added in v1.5.0 

func (s *LiteralArrayOptions) SetFacetEnabled(v bool) *LiteralArrayOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*LiteralArrayOptions) SetReturnEnabled added in v1.5.0 

func (s *LiteralArrayOptions) SetReturnEnabled(v bool) *LiteralArrayOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*LiteralArrayOptions) SetSearchEnabled added in v1.5.0 

func (s *LiteralArrayOptions) SetSearchEnabled(v bool) *LiteralArrayOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*LiteralArrayOptions) SetSourceFields added in v1.5.0 

func (s *LiteralArrayOptions) SetSourceFields(v string) *LiteralArrayOptions

SetSourceFields sets the SourceFields field's value.

func (LiteralArrayOptions) String added in v0.6.5 

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 added in v0.6.5 

func (s LiteralOptions) GoString() string

GoString returns the string representation

func (*LiteralOptions) SetDefaultValue added in v1.5.0 

func (s *LiteralOptions) SetDefaultValue(v string) *LiteralOptions

SetDefaultValue sets the DefaultValue field's value.

func (*LiteralOptions) SetFacetEnabled added in v1.5.0 

func (s *LiteralOptions) SetFacetEnabled(v bool) *LiteralOptions

SetFacetEnabled sets the FacetEnabled field's value.

func (*LiteralOptions) SetReturnEnabled added in v1.5.0 

func (s *LiteralOptions) SetReturnEnabled(v bool) *LiteralOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*LiteralOptions) SetSearchEnabled added in v1.5.0 

func (s *LiteralOptions) SetSearchEnabled(v bool) *LiteralOptions

SetSearchEnabled sets the SearchEnabled field's value.

func (*LiteralOptions) SetSortEnabled added in v1.5.0 

func (s *LiteralOptions) SetSortEnabled(v bool) *LiteralOptions

SetSortEnabled sets the SortEnabled field's value.

func (*LiteralOptions) SetSourceField added in v1.5.0 

func (s *LiteralOptions) SetSourceField(v string) *LiteralOptions

SetSourceField sets the SourceField field's value.

func (LiteralOptions) String added in v0.6.5 

func (s LiteralOptions) String() string

String returns the string representation

func (*LiteralOptions) Validate added in v1.1.21 

func (s *LiteralOptions) Validate() error

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

type OptionStatus 

type OptionStatus struct {

	// A timestamp for when this option was created.
	//
	// CreationDate is a required field
	CreationDate *time.Time `type:"timestamp" 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 *string `type:"string" required:"true" enum:"OptionState"`

	// A timestamp for when this option was last updated.
	//
	// UpdateDate is a required field
	UpdateDate *time.Time `type:"timestamp" 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 added in v0.6.5 

func (s OptionStatus) GoString() string

GoString returns the string representation

func (*OptionStatus) SetCreationDate added in v1.5.0 

func (s *OptionStatus) SetCreationDate(v time.Time) *OptionStatus

SetCreationDate sets the CreationDate field's value.

func (*OptionStatus) SetPendingDeletion added in v1.5.0 

func (s *OptionStatus) SetPendingDeletion(v bool) *OptionStatus

SetPendingDeletion sets the PendingDeletion field's value.

func (*OptionStatus) SetState added in v1.5.0 

func (s *OptionStatus) SetState(v string) *OptionStatus

SetState sets the State field's value.

func (*OptionStatus) SetUpdateDate added in v1.5.0 

func (s *OptionStatus) SetUpdateDate(v time.Time) *OptionStatus

SetUpdateDate sets the UpdateDate field's value.

func (*OptionStatus) SetUpdateVersion added in v1.5.0 

func (s *OptionStatus) SetUpdateVersion(v int64) *OptionStatus

SetUpdateVersion sets the UpdateVersion field's value.

func (OptionStatus) String added in v0.6.5 

func (s OptionStatus) String() string

String returns the string representation

type ScalingParameters 

type ScalingParameters struct {

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

	// 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 added in v0.6.5 

func (s ScalingParameters) GoString() string

GoString returns the string representation

func (*ScalingParameters) SetDesiredInstanceType added in v1.5.0 

func (s *ScalingParameters) SetDesiredInstanceType(v string) *ScalingParameters

SetDesiredInstanceType sets the DesiredInstanceType field's value.

func (*ScalingParameters) SetDesiredPartitionCount added in v1.5.0 

func (s *ScalingParameters) SetDesiredPartitionCount(v int64) *ScalingParameters

SetDesiredPartitionCount sets the DesiredPartitionCount field's value.

func (*ScalingParameters) SetDesiredReplicationCount added in v1.5.0 

func (s *ScalingParameters) SetDesiredReplicationCount(v int64) *ScalingParameters

SetDesiredReplicationCount sets the DesiredReplicationCount field's value.

func (ScalingParameters) String added in v0.6.5 

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 added in v0.6.5 

func (s ScalingParametersStatus) GoString() string

GoString returns the string representation

func (*ScalingParametersStatus) SetOptions added in v1.5.0 

func (s *ScalingParametersStatus) SetOptions(v *ScalingParameters) *ScalingParametersStatus

SetOptions sets the Options field's value.

func (*ScalingParametersStatus) SetStatus added in v1.5.0 

func (s *ScalingParametersStatus) SetStatus(v *OptionStatus) *ScalingParametersStatus

SetStatus sets the Status field's value.

func (ScalingParametersStatus) String added in v0.6.5 

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 added in v0.6.5 

func (s ServiceEndpoint) GoString() string

GoString returns the string representation

func (*ServiceEndpoint) SetEndpoint added in v1.5.0 

func (s *ServiceEndpoint) SetEndpoint(v string) *ServiceEndpoint

SetEndpoint sets the Endpoint field's value.

func (ServiceEndpoint) String added in v0.6.5 

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 added in v0.6.5 

func (s Suggester) GoString() string

GoString returns the string representation

func (*Suggester) SetDocumentSuggesterOptions added in v1.5.0 

func (s *Suggester) SetDocumentSuggesterOptions(v *DocumentSuggesterOptions) *Suggester

SetDocumentSuggesterOptions sets the DocumentSuggesterOptions field's value.

func (*Suggester) SetSuggesterName added in v1.5.0 

func (s *Suggester) SetSuggesterName(v string) *Suggester

SetSuggesterName sets the SuggesterName field's value.

func (Suggester) String added in v0.6.5 

func (s Suggester) String() string

String returns the string representation

func (*Suggester) Validate added in v1.1.21 

func (s *Suggester) Validate() error

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

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 added in v0.6.5 

func (s SuggesterStatus) GoString() string

GoString returns the string representation

func (*SuggesterStatus) SetOptions added in v1.5.0 

func (s *SuggesterStatus) SetOptions(v *Suggester) *SuggesterStatus

SetOptions sets the Options field's value.

func (*SuggesterStatus) SetStatus added in v1.5.0 

func (s *SuggesterStatus) SetStatus(v *OptionStatus) *SuggesterStatus

SetStatus sets the Status field's value.

func (SuggesterStatus) String added in v0.6.5 

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 added in v0.6.5 

func (s TextArrayOptions) GoString() string

GoString returns the string representation

func (*TextArrayOptions) SetAnalysisScheme added in v1.5.0 

func (s *TextArrayOptions) SetAnalysisScheme(v string) *TextArrayOptions

SetAnalysisScheme sets the AnalysisScheme field's value.

func (*TextArrayOptions) SetDefaultValue added in v1.5.0 

func (s *TextArrayOptions) SetDefaultValue(v string) *TextArrayOptions

SetDefaultValue sets the DefaultValue field's value.

func (*TextArrayOptions) SetHighlightEnabled added in v1.5.0 

func (s *TextArrayOptions) SetHighlightEnabled(v bool) *TextArrayOptions

SetHighlightEnabled sets the HighlightEnabled field's value.

func (*TextArrayOptions) SetReturnEnabled added in v1.5.0 

func (s *TextArrayOptions) SetReturnEnabled(v bool) *TextArrayOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*TextArrayOptions) SetSourceFields added in v1.5.0 

func (s *TextArrayOptions) SetSourceFields(v string) *TextArrayOptions

SetSourceFields sets the SourceFields field's value.

func (TextArrayOptions) String added in v0.6.5 

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 added in v0.6.5 

func (s TextOptions) GoString() string

GoString returns the string representation

func (*TextOptions) SetAnalysisScheme added in v1.5.0 

func (s *TextOptions) SetAnalysisScheme(v string) *TextOptions

SetAnalysisScheme sets the AnalysisScheme field's value.

func (*TextOptions) SetDefaultValue added in v1.5.0 

func (s *TextOptions) SetDefaultValue(v string) *TextOptions

SetDefaultValue sets the DefaultValue field's value.

func (*TextOptions) SetHighlightEnabled added in v1.5.0 

func (s *TextOptions) SetHighlightEnabled(v bool) *TextOptions

SetHighlightEnabled sets the HighlightEnabled field's value.

func (*TextOptions) SetReturnEnabled added in v1.5.0 

func (s *TextOptions) SetReturnEnabled(v bool) *TextOptions

SetReturnEnabled sets the ReturnEnabled field's value.

func (*TextOptions) SetSortEnabled added in v1.5.0 

func (s *TextOptions) SetSortEnabled(v bool) *TextOptions

SetSortEnabled sets the SortEnabled field's value.

func (*TextOptions) SetSourceField added in v1.5.0 

func (s *TextOptions) SetSourceField(v string) *TextOptions

SetSourceField sets the SourceField field's value.

func (TextOptions) String added in v0.6.5 

func (s TextOptions) String() string

String returns the string representation

func (*TextOptions) Validate added in v1.1.21 

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 added in v0.6.5 

func (s UpdateAvailabilityOptionsInput) GoString() string

GoString returns the string representation

func (*UpdateAvailabilityOptionsInput) SetDomainName added in v1.5.0 

func (s *UpdateAvailabilityOptionsInput) SetDomainName(v string) *UpdateAvailabilityOptionsInput

SetDomainName sets the DomainName field's value.

func (*UpdateAvailabilityOptionsInput) SetMultiAZ added in v1.5.0 

func (s *UpdateAvailabilityOptionsInput) SetMultiAZ(v bool) *UpdateAvailabilityOptionsInput

SetMultiAZ sets the MultiAZ field's value.

func (UpdateAvailabilityOptionsInput) String added in v0.6.5 

func (s UpdateAvailabilityOptionsInput) String() string

String returns the string representation

func (*UpdateAvailabilityOptionsInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s UpdateAvailabilityOptionsOutput) GoString() string

GoString returns the string representation

func (*UpdateAvailabilityOptionsOutput) SetAvailabilityOptions added in v1.5.0 

func (s *UpdateAvailabilityOptionsOutput) SetAvailabilityOptions(v *AvailabilityOptionsStatus) *UpdateAvailabilityOptionsOutput

SetAvailabilityOptions sets the AvailabilityOptions field's value.

func (UpdateAvailabilityOptionsOutput) String added in v0.6.5 

func (s UpdateAvailabilityOptionsOutput) String() string

String returns the string representation

type UpdateDomainEndpointOptionsInput added in v1.25.34 

type UpdateDomainEndpointOptionsInput struct {

	// Whether to require that all requests to the domain arrive over HTTPS. We
	// recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility
	// with older clients, the default is Policy-Min-TLS-1-0-2019-07.
	//
	// DomainEndpointOptions is a required field
	DomainEndpointOptions *DomainEndpointOptions `type:"structure" required:"true"`

	// A string that represents the name of a domain.
	//
	// DomainName is a required field
	DomainName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the UpdateDomainEndpointOptions operation. Specifies the name of the domain you want to update and the domain endpoint options.

func (UpdateDomainEndpointOptionsInput) GoString added in v1.25.34 

func (s UpdateDomainEndpointOptionsInput) GoString() string

GoString returns the string representation

func (*UpdateDomainEndpointOptionsInput) SetDomainEndpointOptions added in v1.25.34 

func (s *UpdateDomainEndpointOptionsInput) SetDomainEndpointOptions(v *DomainEndpointOptions) *UpdateDomainEndpointOptionsInput

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*UpdateDomainEndpointOptionsInput) SetDomainName added in v1.25.34 

func (s *UpdateDomainEndpointOptionsInput) SetDomainName(v string) *UpdateDomainEndpointOptionsInput

SetDomainName sets the DomainName field's value.

func (UpdateDomainEndpointOptionsInput) String added in v1.25.34 

func (s UpdateDomainEndpointOptionsInput) String() string

String returns the string representation

func (*UpdateDomainEndpointOptionsInput) Validate added in v1.25.34 

func (s *UpdateDomainEndpointOptionsInput) Validate() error

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

type UpdateDomainEndpointOptionsOutput added in v1.25.34 

type UpdateDomainEndpointOptionsOutput struct {

	// The newly-configured domain endpoint options.
	DomainEndpointOptions *DomainEndpointOptionsStatus `type:"structure"`
	// contains filtered or unexported fields
}

The result of a UpdateDomainEndpointOptions request. Contains the configuration and status of the domain's endpoint options.

func (UpdateDomainEndpointOptionsOutput) GoString added in v1.25.34 

func (s UpdateDomainEndpointOptionsOutput) GoString() string

GoString returns the string representation

func (*UpdateDomainEndpointOptionsOutput) SetDomainEndpointOptions added in v1.25.34 

func (s *UpdateDomainEndpointOptionsOutput) SetDomainEndpointOptions(v *DomainEndpointOptionsStatus) *UpdateDomainEndpointOptionsOutput

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (UpdateDomainEndpointOptionsOutput) String added in v1.25.34 

func (s UpdateDomainEndpointOptionsOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s UpdateScalingParametersInput) GoString() string

GoString returns the string representation

func (*UpdateScalingParametersInput) SetDomainName added in v1.5.0 

func (s *UpdateScalingParametersInput) SetDomainName(v string) *UpdateScalingParametersInput

SetDomainName sets the DomainName field's value.

func (*UpdateScalingParametersInput) SetScalingParameters added in v1.5.0 

func (s *UpdateScalingParametersInput) SetScalingParameters(v *ScalingParameters) *UpdateScalingParametersInput

SetScalingParameters sets the ScalingParameters field's value.

func (UpdateScalingParametersInput) String added in v0.6.5 

func (s UpdateScalingParametersInput) String() string

String returns the string representation

func (*UpdateScalingParametersInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s UpdateScalingParametersOutput) GoString() string

GoString returns the string representation

func (*UpdateScalingParametersOutput) SetScalingParameters added in v1.5.0 

func (s *UpdateScalingParametersOutput) SetScalingParameters(v *ScalingParametersStatus) *UpdateScalingParametersOutput

SetScalingParameters sets the ScalingParameters field's value.

func (UpdateScalingParametersOutput) String added in v0.6.5 

func (s UpdateScalingParametersOutput) String() string

String returns the string representation

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 added in v0.6.5 

func (s UpdateServiceAccessPoliciesInput) GoString() string

GoString returns the string representation

func (*UpdateServiceAccessPoliciesInput) SetAccessPolicies added in v1.5.0 

func (s *UpdateServiceAccessPoliciesInput) SetAccessPolicies(v string) *UpdateServiceAccessPoliciesInput

SetAccessPolicies sets the AccessPolicies field's value.

func (*UpdateServiceAccessPoliciesInput) SetDomainName added in v1.5.0 

func (s *UpdateServiceAccessPoliciesInput) SetDomainName(v string) *UpdateServiceAccessPoliciesInput

SetDomainName sets the DomainName field's value.

func (UpdateServiceAccessPoliciesInput) String added in v0.6.5 

func (s UpdateServiceAccessPoliciesInput) String() string

String returns the string representation

func (*UpdateServiceAccessPoliciesInput) Validate added in v1.1.21 

func (s *UpdateServiceAccessPoliciesInput) Validate() error

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 added in v0.6.5 

func (s UpdateServiceAccessPoliciesOutput) GoString() string

GoString returns the string representation

func (*UpdateServiceAccessPoliciesOutput) SetAccessPolicies added in v1.5.0 

func (s *UpdateServiceAccessPoliciesOutput) SetAccessPolicies(v *AccessPoliciesStatus) *UpdateServiceAccessPoliciesOutput

SetAccessPolicies sets the AccessPolicies field's value.

func (UpdateServiceAccessPoliciesOutput) String added in v0.6.5 

func (s UpdateServiceAccessPoliciesOutput) String() string

String returns the string representation

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.