cloudsearch – github.com/aws/aws-sdk-go-v2/service/cloudsearch Index | Files | Directories

package cloudsearch

import "github.com/aws/aws-sdk-go-v2/service/cloudsearch"

Index

Constants 

const ServiceAPIVersion = "2013-01-01"
const ServiceID = "CloudSearch"

Functions

func AddResolveEndpointMiddleware 

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware 

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

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 *string
}

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

type BuildSuggestersOutput 

type BuildSuggestersOutput struct {
	// A list of field names.
	FieldNames []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type Client 

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

Amazon CloudSearch Configuration Service 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).

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BuildSuggesters 

func (c *Client) BuildSuggesters(ctx context.Context, params *BuildSuggestersInput, optFns ...func(*Options)) (*BuildSuggestersOutput, error)

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.

func (*Client) CreateDomain 

func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error)

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.

func (*Client) DefineAnalysisScheme 

func (c *Client) DefineAnalysisScheme(ctx context.Context, params *DefineAnalysisSchemeInput, optFns ...func(*Options)) (*DefineAnalysisSchemeOutput, error)

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.

func (*Client) DefineExpression 

func (c *Client) DefineExpression(ctx context.Context, params *DefineExpressionInput, optFns ...func(*Options)) (*DefineExpressionOutput, error)

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.

func (*Client) DefineIndexField 

func (c *Client) DefineIndexField(ctx context.Context, params *DefineIndexFieldInput, optFns ...func(*Options)) (*DefineIndexFieldOutput, error)

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.

func (*Client) DefineSuggester 

func (c *Client) DefineSuggester(ctx context.Context, params *DefineSuggesterInput, optFns ...func(*Options)) (*DefineSuggesterOutput, error)

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.

func (*Client) DeleteAnalysisScheme 

func (c *Client) DeleteAnalysisScheme(ctx context.Context, params *DeleteAnalysisSchemeInput, optFns ...func(*Options)) (*DeleteAnalysisSchemeOutput, error)

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.

func (*Client) DeleteDomain 

func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error)

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.

func (*Client) DeleteExpression 

func (c *Client) DeleteExpression(ctx context.Context, params *DeleteExpressionInput, optFns ...func(*Options)) (*DeleteExpressionOutput, error)

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.

func (*Client) DeleteIndexField 

func (c *Client) DeleteIndexField(ctx context.Context, params *DeleteIndexFieldInput, optFns ...func(*Options)) (*DeleteIndexFieldOutput, error)

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.

func (*Client) DeleteSuggester 

func (c *Client) DeleteSuggester(ctx context.Context, params *DeleteSuggesterInput, optFns ...func(*Options)) (*DeleteSuggesterOutput, error)

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.

func (*Client) DescribeAnalysisSchemes 

func (c *Client) DescribeAnalysisSchemes(ctx context.Context, params *DescribeAnalysisSchemesInput, optFns ...func(*Options)) (*DescribeAnalysisSchemesOutput, error)

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.

func (*Client) DescribeAvailabilityOptions 

func (c *Client) DescribeAvailabilityOptions(ctx context.Context, params *DescribeAvailabilityOptionsInput, optFns ...func(*Options)) (*DescribeAvailabilityOptionsOutput, error)

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.

func (*Client) DescribeDomainEndpointOptions 

func (c *Client) DescribeDomainEndpointOptions(ctx context.Context, params *DescribeDomainEndpointOptionsInput, optFns ...func(*Options)) (*DescribeDomainEndpointOptionsOutput, error)

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.

func (*Client) DescribeDomains 

func (c *Client) DescribeDomains(ctx context.Context, params *DescribeDomainsInput, optFns ...func(*Options)) (*DescribeDomainsOutput, error)

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.

func (*Client) DescribeExpressions 

func (c *Client) DescribeExpressions(ctx context.Context, params *DescribeExpressionsInput, optFns ...func(*Options)) (*DescribeExpressionsOutput, error)

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.

func (*Client) DescribeIndexFields 

func (c *Client) DescribeIndexFields(ctx context.Context, params *DescribeIndexFieldsInput, optFns ...func(*Options)) (*DescribeIndexFieldsOutput, error)

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.

func (*Client) DescribeScalingParameters 

func (c *Client) DescribeScalingParameters(ctx context.Context, params *DescribeScalingParametersInput, optFns ...func(*Options)) (*DescribeScalingParametersOutput, error)

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.

func (*Client) DescribeServiceAccessPolicies 

func (c *Client) DescribeServiceAccessPolicies(ctx context.Context, params *DescribeServiceAccessPoliciesInput, optFns ...func(*Options)) (*DescribeServiceAccessPoliciesOutput, error)

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.

func (*Client) DescribeSuggesters 

func (c *Client) DescribeSuggesters(ctx context.Context, params *DescribeSuggestersInput, optFns ...func(*Options)) (*DescribeSuggestersOutput, error)

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.

func (*Client) IndexDocuments 

func (c *Client) IndexDocuments(ctx context.Context, params *IndexDocumentsInput, optFns ...func(*Options)) (*IndexDocumentsOutput, error)

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.

func (*Client) ListDomainNames 

func (c *Client) ListDomainNames(ctx context.Context, params *ListDomainNamesInput, optFns ...func(*Options)) (*ListDomainNamesOutput, error)

Lists all search domains owned by an account.

func (*Client) UpdateAvailabilityOptions 

func (c *Client) UpdateAvailabilityOptions(ctx context.Context, params *UpdateAvailabilityOptionsInput, optFns ...func(*Options)) (*UpdateAvailabilityOptionsOutput, error)

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.

func (*Client) UpdateDomainEndpointOptions 

func (c *Client) UpdateDomainEndpointOptions(ctx context.Context, params *UpdateDomainEndpointOptionsInput, optFns ...func(*Options)) (*UpdateDomainEndpointOptionsOutput, error)

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.

func (*Client) UpdateScalingParameters 

func (c *Client) UpdateScalingParameters(ctx context.Context, params *UpdateScalingParametersInput, optFns ...func(*Options)) (*UpdateScalingParametersOutput, error)

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.

func (*Client) UpdateServiceAccessPolicies 

func (c *Client) UpdateServiceAccessPolicies(ctx context.Context, params *UpdateServiceAccessPoliciesInput, optFns ...func(*Options)) (*UpdateServiceAccessPoliciesOutput, error)

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

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 *string
}

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

type CreateDomainOutput 

type CreateDomainOutput struct {
	// The current status of the search domain.
	DomainStatus *types.DomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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 *types.AnalysisScheme
	// 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 *string
}

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

type DefineAnalysisSchemeOutput 

type DefineAnalysisSchemeOutput struct {
	// The status and configuration of an AnalysisScheme.
	AnalysisScheme *types.AnalysisSchemeStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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 *string
	// 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 *types.Expression
}

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.

type DefineExpressionOutput 

type DefineExpressionOutput struct {
	// The value of an Expression and its current status.
	Expression *types.ExpressionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DefineIndexFieldInput 

type DefineIndexFieldInput struct {
	// The index field and field options you want to configure.
	IndexField *types.IndexField
	// 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 *string
}

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

type DefineIndexFieldOutput 

type DefineIndexFieldOutput struct {
	// The value of an IndexField and its current status.
	IndexField *types.IndexFieldStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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 *string
	// 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 *types.Suggester
}

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

type DefineSuggesterOutput 

type DefineSuggesterOutput struct {
	// The value of a Suggester and its current status.
	Suggester *types.SuggesterStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DeleteAnalysisSchemeInput 

type DeleteAnalysisSchemeInput 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 *string
	// The name of the analysis scheme you want to delete.
	AnalysisSchemeName *string
}

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.

type DeleteAnalysisSchemeOutput 

type DeleteAnalysisSchemeOutput struct {
	// The status of the analysis scheme being deleted.
	AnalysisScheme *types.AnalysisSchemeStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DeleteDomainInput 

type DeleteDomainInput struct {
	// The name of the domain you want to permanently delete.
	DomainName *string
}

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

type DeleteDomainOutput 

type DeleteDomainOutput struct {
	// The current status of the search domain.
	DomainStatus *types.DomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.

type DeleteExpressionInput 

type DeleteExpressionInput struct {
	// The name of the Expression () to delete.
	ExpressionName *string
	// 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 *string
}

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.

type DeleteExpressionOutput 

type DeleteExpressionOutput struct {
	// The status of the expression being deleted.
	Expression *types.ExpressionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DeleteIndexFieldInput 

type DeleteIndexFieldInput struct {
	// The name of the index field your want to remove from the domain's indexing
	// options.
	IndexFieldName *string
	// 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 *string
}

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.

type DeleteIndexFieldOutput 

type DeleteIndexFieldOutput struct {
	// The status of the index field being deleted.
	IndexField *types.IndexFieldStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DeleteIndexField () request.

type DeleteSuggesterInput 

type DeleteSuggesterInput struct {
	// Specifies the name of the suggester you want to delete.
	SuggesterName *string
	// 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 *string
}

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.

type DeleteSuggesterOutput 

type DeleteSuggesterOutput struct {
	// The status of the suggester being deleted.
	Suggester *types.SuggesterStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeAnalysisSchemesInput 

type DescribeAnalysisSchemesInput struct {
	// The name of the domain you want to describe.
	DomainName *string
	// The analysis schemes you want to describe.
	AnalysisSchemeNames []*string
	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool
}

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.

type DescribeAnalysisSchemesOutput 

type DescribeAnalysisSchemesOutput struct {
	// The analysis scheme descriptions.
	AnalysisSchemes []*types.AnalysisSchemeStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeAvailabilityOptionsInput 

type DescribeAvailabilityOptionsInput struct {
	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool
	// The name of the domain you want to describe.
	DomainName *string
}

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.

type DescribeAvailabilityOptionsOutput 

type DescribeAvailabilityOptionsOutput struct {
	// The availability options configured for the domain. Indicates whether Multi-AZ
	// is enabled for the domain.
	AvailabilityOptions *types.AvailabilityOptionsStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeDomainEndpointOptionsInput 

type DescribeDomainEndpointOptionsInput struct {
	// A string that represents the name of a domain.
	DomainName *string
	// Whether to retrieve the latest configuration (which might be in a Processing
	// state) or the current, active configuration. Defaults to false.
	Deployed *bool
}

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.

type DescribeDomainEndpointOptionsOutput 

type DescribeDomainEndpointOptionsOutput struct {
	// The status and configuration of a search domain's endpoint options.
	DomainEndpointOptions *types.DomainEndpointOptionsStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeDomainsInput 

type DescribeDomainsInput struct {
	// The names of the domains you want to include in the response.
	DomainNames []*string
}

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.

type DescribeDomainsOutput 

type DescribeDomainsOutput struct {
	// A list that contains the status of each requested domain.
	DomainStatusList []*types.DomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeExpressionsInput 

type DescribeExpressionsInput struct {
	// Limits the DescribeExpressions () response to the specified expressions. If not
	// specified, all expressions are shown.
	ExpressionNames []*string
	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool
	// The name of the domain you want to describe.
	DomainName *string
}

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.

type DescribeExpressionsOutput 

type DescribeExpressionsOutput struct {
	// The expressions configured for the domain.
	Expressions []*types.ExpressionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeIndexFieldsInput 

type DescribeIndexFieldsInput struct {
	// A list of the index fields you want to describe. If not specified, information
	// is returned for all configured index fields.
	FieldNames []*string
	// The name of the domain you want to describe.
	DomainName *string
	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool
}

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.

type DescribeIndexFieldsOutput 

type DescribeIndexFieldsOutput struct {
	// The index fields configured for the domain.
	IndexFields []*types.IndexFieldStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeScalingParametersInput 

type DescribeScalingParametersInput struct {
	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start with a
	// letter or number and can contain the following characters: a-z (lowercase), 0-9,
	// and - (hyphen).
	DomainName *string
}

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

type DescribeScalingParametersOutput 

type DescribeScalingParametersOutput struct {
	// The status and configuration of a search domain's scaling parameters.
	ScalingParameters *types.ScalingParametersStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeServiceAccessPoliciesInput 

type DescribeServiceAccessPoliciesInput struct {
	// The name of the domain you want to describe.
	DomainName *string
	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool
}

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.

type DescribeServiceAccessPoliciesOutput 

type DescribeServiceAccessPoliciesOutput struct {
	// The access rules configured for the domain specified in the request.
	AccessPolicies *types.AccessPoliciesStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeServiceAccessPolicies request.

type DescribeSuggestersInput 

type DescribeSuggestersInput struct {
	// The name of the domain you want to describe.
	DomainName *string
	// Whether to display the deployed configuration (true) or include any pending
	// changes (false). Defaults to false.
	Deployed *bool
	// The suggesters you want to describe.
	SuggesterNames []*string
}

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.

type DescribeSuggestersOutput 

type DescribeSuggestersOutput struct {
	// The suggesters configured for the domain specified in the request.
	Suggesters []*types.SuggesterStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeSuggesters request.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver 

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

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 *string
}

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

type IndexDocumentsOutput 

type IndexDocumentsOutput struct {
	// The names of the fields that are currently being indexed.
	FieldNames []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type ListDomainNamesInput 

type ListDomainNamesInput struct {
}

type ListDomainNamesOutput 

type ListDomainNamesOutput struct {
	// The names of the search domains owned by an account.
	DomainNames map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials 

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions 

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver 

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4 

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion 

func (o Options) GetRegion() string

func (Options) GetRetryer 

func (o Options) GetRetryer() retry.Retryer

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions 

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions 

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type UpdateAvailabilityOptionsInput 

type UpdateAvailabilityOptionsInput struct {
	// 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 *bool
	// 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 *string
}

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

type UpdateAvailabilityOptionsOutput 

type UpdateAvailabilityOptionsOutput struct {
	// The newly-configured availability options. Indicates whether Multi-AZ is enabled
	// for the domain.
	AvailabilityOptions *types.AvailabilityOptionsStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type UpdateDomainEndpointOptionsInput 

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 *types.DomainEndpointOptions
	// A string that represents the name of a domain.
	DomainName *string
}

Container for the parameters to the UpdateDomainEndpointOptions () operation. Specifies the name of the domain you want to update and the domain endpoint options.

type UpdateDomainEndpointOptionsOutput 

type UpdateDomainEndpointOptionsOutput struct {
	// The newly-configured domain endpoint options.
	DomainEndpointOptions *types.DomainEndpointOptionsStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type UpdateScalingParametersInput 

type UpdateScalingParametersInput struct {
	// The desired instance type and desired number of replicas of each index
	// partition.
	ScalingParameters *types.ScalingParameters
	// 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 *string
}

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.

type UpdateScalingParametersOutput 

type UpdateScalingParametersOutput struct {
	// The status and configuration of a search domain's scaling parameters.
	ScalingParameters *types.ScalingParametersStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type UpdateServiceAccessPoliciesInput 

type UpdateServiceAccessPoliciesInput 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 *string
	// The access rules you want to configure. These rules replace any existing rules.
	AccessPolicies *string
}

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.

type UpdateServiceAccessPoliciesOutput 

type UpdateServiceAccessPoliciesOutput struct {
	// The access rules configured for the domain.
	AccessPolicies *types.AccessPoliciesStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

Source Files

api_client.go api_op_BuildSuggesters.go api_op_CreateDomain.go api_op_DefineAnalysisScheme.go api_op_DefineExpression.go api_op_DefineIndexField.go api_op_DefineSuggester.go api_op_DeleteAnalysisScheme.go api_op_DeleteDomain.go api_op_DeleteExpression.go api_op_DeleteIndexField.go api_op_DeleteSuggester.go api_op_DescribeAnalysisSchemes.go api_op_DescribeAvailabilityOptions.go api_op_DescribeDomainEndpointOptions.go api_op_DescribeDomains.go api_op_DescribeExpressions.go api_op_DescribeIndexFields.go api_op_DescribeScalingParameters.go api_op_DescribeServiceAccessPolicies.go api_op_DescribeSuggesters.go api_op_IndexDocuments.go api_op_ListDomainNames.go api_op_UpdateAvailabilityOptions.go api_op_UpdateDomainEndpointOptions.go api_op_UpdateScalingParameters.go api_op_UpdateServiceAccessPolicies.go deserializers.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.1.0
Published
Sep 29, 2020
Platform
js/wasm
Imports
28 packages
Last checked
now –

Tools for package owners.