elasticsearchservice

package module
v1.32.18 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2025 License: Apache-2.0 Imports: 44 Imported by: 54

Documentation

Overview

Package elasticsearchservice provides the API client, operations, and parameter types for Amazon Elasticsearch Service.

Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Index

Constants

View Source 
const ServiceAPIVersion = "2015-01-01"
View Source 
const ServiceID = "Elasticsearch Service"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.20.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.23.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.23.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AcceptInboundCrossClusterSearchConnectionInput 

type AcceptInboundCrossClusterSearchConnectionInput struct {

	// The id of the inbound connection that you want to accept.
	//
	// This member is required.
	CrossClusterSearchConnectionId *string
	// contains filtered or unexported fields
}

Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

type AcceptInboundCrossClusterSearchConnectionOutput 

type AcceptInboundCrossClusterSearchConnectionOutput struct {

	// Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.
	CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection.

type AddTagsInput 

type AddTagsInput struct {

	//  Specify the ARN for which you want to add the tags.
	//
	// This member is required.
	ARN *string

	//  List of Tag that need to be added for the Elasticsearch domain.
	//
	// This member is required.
	TagList []types.Tag
	// contains filtered or unexported fields
}

Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

type AddTagsOutput 

type AddTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociatePackageInput 

type AssociatePackageInput struct {

	// Name of the domain that you want to associate the package with.
	//
	// This member is required.
	DomainName *string

	// Internal ID of the package that you want to associate with a domain. Use
	// DescribePackages to find this value.
	//
	// This member is required.
	PackageID *string
	// contains filtered or unexported fields
}

Container for request parameters to AssociatePackage operation.

type AssociatePackageOutput 

type AssociatePackageOutput struct {

	//     DomainPackageDetails
	DomainPackageDetails *types.DomainPackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by AssociatePackage operation.

type AuthResolverParameters added in v1.23.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.23.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type AuthorizeVpcEndpointAccessInput added in v1.17.0 

type AuthorizeVpcEndpointAccessInput struct {

	// The account ID to grant access to.
	//
	// This member is required.
	Account *string

	// The name of the OpenSearch Service domain to provide access to.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for request parameters to the AuthorizeVpcEndpointAccess operation. Specifies the account to be permitted to manage VPC endpoints against the domain.

type AuthorizeVpcEndpointAccessOutput added in v1.17.0 

type AuthorizeVpcEndpointAccessOutput struct {

	// Information about the account or service that was provided access to the domain.
	//
	// This member is required.
	AuthorizedPrincipal *types.AuthorizedPrincipal

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the AuthorizeVpcEndpointAccess operation. Contains the account ID and the type of the account being authorized to access the VPC endpoint.

type CancelDomainConfigChangeInput added in v1.26.0 

type CancelDomainConfigChangeInput struct {

	// Name of the OpenSearch Service domain configuration request to cancel.
	//
	// This member is required.
	DomainName *string

	// When set to True, returns the list of change IDs and properties that will be
	// cancelled without actually cancelling the change.
	DryRun *bool
	// contains filtered or unexported fields
}

Container for parameters of the CancelDomainConfigChange operation.

type CancelDomainConfigChangeOutput added in v1.26.0 

type CancelDomainConfigChangeOutput struct {

	// The unique identifiers of the changes that were cancelled.
	CancelledChangeIds []string

	// The domain change properties that were cancelled.
	CancelledChangeProperties []types.CancelledChangeProperty

	// Whether or not the request was a dry run. If True, the changes were not
	// actually cancelled.
	DryRun *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the details of the cancelled domain config change.

type CancelElasticsearchServiceSoftwareUpdateInput 

type CancelElasticsearchServiceSoftwareUpdateInput struct {

	// The name of the domain that you want to stop the latest service software update
	// on.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.

type CancelElasticsearchServiceSoftwareUpdateOutput 

type CancelElasticsearchServiceSoftwareUpdateOutput struct {

	// The current status of the Elasticsearch service software update.
	ServiceSoftwareOptions *types.ServiceSoftwareOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

type Client 

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

Client provides the API client to make operations call for Amazon Elasticsearch Service.

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

func (c *Client) AcceptInboundCrossClusterSearchConnection(ctx context.Context, params *AcceptInboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*AcceptInboundCrossClusterSearchConnectionOutput, error)

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

func (*Client) AddTags 

func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error)

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

func (*Client) AssociatePackage 

func (c *Client) AssociatePackage(ctx context.Context, params *AssociatePackageInput, optFns ...func(*Options)) (*AssociatePackageOutput, error)

Associates a package with an Amazon ES domain.

func (*Client) AuthorizeVpcEndpointAccess added in v1.17.0 

func (c *Client) AuthorizeVpcEndpointAccess(ctx context.Context, params *AuthorizeVpcEndpointAccessInput, optFns ...func(*Options)) (*AuthorizeVpcEndpointAccessOutput, error)

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

func (*Client) CancelDomainConfigChange added in v1.26.0 

func (c *Client) CancelDomainConfigChange(ctx context.Context, params *CancelDomainConfigChangeInput, optFns ...func(*Options)) (*CancelDomainConfigChangeOutput, error)

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

func (*Client) CancelElasticsearchServiceSoftwareUpdate 

func (c *Client) CancelElasticsearchServiceSoftwareUpdate(ctx context.Context, params *CancelElasticsearchServiceSoftwareUpdateInput, optFns ...func(*Options)) (*CancelElasticsearchServiceSoftwareUpdateOutput, error)

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

func (*Client) CreateElasticsearchDomain 

func (c *Client) CreateElasticsearchDomain(ctx context.Context, params *CreateElasticsearchDomainInput, optFns ...func(*Options)) (*CreateElasticsearchDomainOutput, error)

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

func (*Client) CreateOutboundCrossClusterSearchConnection 

func (c *Client) CreateOutboundCrossClusterSearchConnection(ctx context.Context, params *CreateOutboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*CreateOutboundCrossClusterSearchConnectionOutput, error)

Creates a new cross-cluster search connection from a source domain to a destination domain.

func (*Client) CreatePackage 

func (c *Client) CreatePackage(ctx context.Context, params *CreatePackageInput, optFns ...func(*Options)) (*CreatePackageOutput, error)

Create a package for use with Amazon ES domains.

func (*Client) CreateVpcEndpoint added in v1.17.0 

func (c *Client) CreateVpcEndpoint(ctx context.Context, params *CreateVpcEndpointInput, optFns ...func(*Options)) (*CreateVpcEndpointOutput, error)

Creates an Amazon OpenSearch Service-managed VPC endpoint.

func (*Client) DeleteElasticsearchDomain 

func (c *Client) DeleteElasticsearchDomain(ctx context.Context, params *DeleteElasticsearchDomainInput, optFns ...func(*Options)) (*DeleteElasticsearchDomainOutput, error)

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

func (*Client) DeleteElasticsearchServiceRole 

func (c *Client) DeleteElasticsearchServiceRole(ctx context.Context, params *DeleteElasticsearchServiceRoleInput, optFns ...func(*Options)) (*DeleteElasticsearchServiceRoleOutput, error)

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Rolein VPC Endpoints for Amazon Elasticsearch Service Domains.

func (*Client) DeleteInboundCrossClusterSearchConnection 

func (c *Client) DeleteInboundCrossClusterSearchConnection(ctx context.Context, params *DeleteInboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*DeleteInboundCrossClusterSearchConnectionOutput, error)

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

func (*Client) DeleteOutboundCrossClusterSearchConnection 

func (c *Client) DeleteOutboundCrossClusterSearchConnection(ctx context.Context, params *DeleteOutboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*DeleteOutboundCrossClusterSearchConnectionOutput, error)

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

func (*Client) DeletePackage 

func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error)

Delete the package.

func (*Client) DeleteVpcEndpoint added in v1.17.0 

func (c *Client) DeleteVpcEndpoint(ctx context.Context, params *DeleteVpcEndpointInput, optFns ...func(*Options)) (*DeleteVpcEndpointOutput, error)

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

func (*Client) DescribeDomainAutoTunes added in v1.2.0 

func (c *Client) DescribeDomainAutoTunes(ctx context.Context, params *DescribeDomainAutoTunesInput, optFns ...func(*Options)) (*DescribeDomainAutoTunesOutput, error)

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

func (*Client) DescribeDomainChangeProgress added in v1.14.0 

func (c *Client) DescribeDomainChangeProgress(ctx context.Context, params *DescribeDomainChangeProgressInput, optFns ...func(*Options)) (*DescribeDomainChangeProgressOutput, error)

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

func (*Client) DescribeElasticsearchDomain 

func (c *Client) DescribeElasticsearchDomain(ctx context.Context, params *DescribeElasticsearchDomainInput, optFns ...func(*Options)) (*DescribeElasticsearchDomainOutput, error)

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

func (*Client) DescribeElasticsearchDomainConfig 

func (c *Client) DescribeElasticsearchDomainConfig(ctx context.Context, params *DescribeElasticsearchDomainConfigInput, optFns ...func(*Options)) (*DescribeElasticsearchDomainConfigOutput, error)

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

func (*Client) DescribeElasticsearchDomains 

func (c *Client) DescribeElasticsearchDomains(ctx context.Context, params *DescribeElasticsearchDomainsInput, optFns ...func(*Options)) (*DescribeElasticsearchDomainsOutput, error)

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

func (*Client) DescribeElasticsearchInstanceTypeLimits 

func (c *Client) DescribeElasticsearchInstanceTypeLimits(ctx context.Context, params *DescribeElasticsearchInstanceTypeLimitsInput, optFns ...func(*Options)) (*DescribeElasticsearchInstanceTypeLimitsOutput, error)
Describe Elasticsearch Limits for a given InstanceType and

ElasticsearchVersion. When modifying existing Domain, specify the DomainNameto know what Limits are supported for modifying.

func (*Client) DescribeInboundCrossClusterSearchConnections 

func (c *Client) DescribeInboundCrossClusterSearchConnections(ctx context.Context, params *DescribeInboundCrossClusterSearchConnectionsInput, optFns ...func(*Options)) (*DescribeInboundCrossClusterSearchConnectionsOutput, error)

Lists all the inbound cross-cluster search connections for a destination domain.

func (*Client) DescribeOutboundCrossClusterSearchConnections 

func (c *Client) DescribeOutboundCrossClusterSearchConnections(ctx context.Context, params *DescribeOutboundCrossClusterSearchConnectionsInput, optFns ...func(*Options)) (*DescribeOutboundCrossClusterSearchConnectionsOutput, error)

Lists all the outbound cross-cluster search connections for a source domain.

func (*Client) DescribePackages 

func (c *Client) DescribePackages(ctx context.Context, params *DescribePackagesInput, optFns ...func(*Options)) (*DescribePackagesOutput, error)

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

func (*Client) DescribeReservedElasticsearchInstanceOfferings 

func (c *Client) DescribeReservedElasticsearchInstanceOfferings(ctx context.Context, params *DescribeReservedElasticsearchInstanceOfferingsInput, optFns ...func(*Options)) (*DescribeReservedElasticsearchInstanceOfferingsOutput, error)

Lists available reserved Elasticsearch instance offerings.

func (*Client) DescribeReservedElasticsearchInstances 

func (c *Client) DescribeReservedElasticsearchInstances(ctx context.Context, params *DescribeReservedElasticsearchInstancesInput, optFns ...func(*Options)) (*DescribeReservedElasticsearchInstancesOutput, error)

Returns information about reserved Elasticsearch instances for this account.

func (*Client) DescribeVpcEndpoints added in v1.17.0 

func (c *Client) DescribeVpcEndpoints(ctx context.Context, params *DescribeVpcEndpointsInput, optFns ...func(*Options)) (*DescribeVpcEndpointsOutput, error)

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

func (*Client) DissociatePackage 

func (c *Client) DissociatePackage(ctx context.Context, params *DissociatePackageInput, optFns ...func(*Options)) (*DissociatePackageOutput, error)

Dissociates a package from the Amazon ES domain.

func (*Client) GetCompatibleElasticsearchVersions 

func (c *Client) GetCompatibleElasticsearchVersions(ctx context.Context, params *GetCompatibleElasticsearchVersionsInput, optFns ...func(*Options)) (*GetCompatibleElasticsearchVersionsOutput, error)
Returns a list of upgrade compatible Elastisearch versions. You can optionally

pass a DomainNameto get all upgrade compatible Elasticsearch versions for that specific domain.

func (*Client) GetPackageVersionHistory added in v0.30.0 

func (c *Client) GetPackageVersionHistory(ctx context.Context, params *GetPackageVersionHistoryInput, optFns ...func(*Options)) (*GetPackageVersionHistoryOutput, error)

Returns a list of versions of the package, along with their creation time and commit message.

func (*Client) GetUpgradeHistory 

func (c *Client) GetUpgradeHistory(ctx context.Context, params *GetUpgradeHistoryInput, optFns ...func(*Options)) (*GetUpgradeHistoryOutput, error)

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

func (*Client) GetUpgradeStatus 

func (c *Client) GetUpgradeStatus(ctx context.Context, params *GetUpgradeStatusInput, optFns ...func(*Options)) (*GetUpgradeStatusOutput, error)

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

func (*Client) ListDomainNames 

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

Returns the name of all Elasticsearch domains owned by the current user's account.

func (*Client) ListDomainsForPackage 

func (c *Client) ListDomainsForPackage(ctx context.Context, params *ListDomainsForPackageInput, optFns ...func(*Options)) (*ListDomainsForPackageOutput, error)

Lists all Amazon ES domains associated with the package.

func (*Client) ListElasticsearchInstanceTypes 

func (c *Client) ListElasticsearchInstanceTypes(ctx context.Context, params *ListElasticsearchInstanceTypesInput, optFns ...func(*Options)) (*ListElasticsearchInstanceTypesOutput, error)

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

func (*Client) ListElasticsearchVersions 

func (c *Client) ListElasticsearchVersions(ctx context.Context, params *ListElasticsearchVersionsInput, optFns ...func(*Options)) (*ListElasticsearchVersionsOutput, error)

List all supported Elasticsearch versions

func (*Client) ListPackagesForDomain 

func (c *Client) ListPackagesForDomain(ctx context.Context, params *ListPackagesForDomainInput, optFns ...func(*Options)) (*ListPackagesForDomainOutput, error)

Lists all packages associated with the Amazon ES domain.

func (*Client) ListTags 

func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)

Returns all tags for the given Elasticsearch domain.

func (*Client) ListVpcEndpointAccess added in v1.17.0 

func (c *Client) ListVpcEndpointAccess(ctx context.Context, params *ListVpcEndpointAccessInput, optFns ...func(*Options)) (*ListVpcEndpointAccessOutput, error)

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

func (*Client) ListVpcEndpoints added in v1.17.0 

func (c *Client) ListVpcEndpoints(ctx context.Context, params *ListVpcEndpointsInput, optFns ...func(*Options)) (*ListVpcEndpointsOutput, error)

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

func (*Client) ListVpcEndpointsForDomain added in v1.17.0 

func (c *Client) ListVpcEndpointsForDomain(ctx context.Context, params *ListVpcEndpointsForDomainInput, optFns ...func(*Options)) (*ListVpcEndpointsForDomainOutput, error)

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

func (*Client) Options added in v1.24.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PurchaseReservedElasticsearchInstanceOffering 

func (c *Client) PurchaseReservedElasticsearchInstanceOffering(ctx context.Context, params *PurchaseReservedElasticsearchInstanceOfferingInput, optFns ...func(*Options)) (*PurchaseReservedElasticsearchInstanceOfferingOutput, error)

Allows you to purchase reserved Elasticsearch instances.

func (*Client) RejectInboundCrossClusterSearchConnection 

func (c *Client) RejectInboundCrossClusterSearchConnection(ctx context.Context, params *RejectInboundCrossClusterSearchConnectionInput, optFns ...func(*Options)) (*RejectInboundCrossClusterSearchConnectionOutput, error)

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

func (*Client) RemoveTags 

func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error)

Removes the specified set of tags from the specified Elasticsearch domain.

func (*Client) RevokeVpcEndpointAccess added in v1.17.0 

func (c *Client) RevokeVpcEndpointAccess(ctx context.Context, params *RevokeVpcEndpointAccessInput, optFns ...func(*Options)) (*RevokeVpcEndpointAccessOutput, error)

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

func (*Client) StartElasticsearchServiceSoftwareUpdate 

func (c *Client) StartElasticsearchServiceSoftwareUpdate(ctx context.Context, params *StartElasticsearchServiceSoftwareUpdateInput, optFns ...func(*Options)) (*StartElasticsearchServiceSoftwareUpdateOutput, error)

Schedules a service software update for an Amazon ES domain.

func (*Client) UpdateElasticsearchDomainConfig 

func (c *Client) UpdateElasticsearchDomainConfig(ctx context.Context, params *UpdateElasticsearchDomainConfigInput, optFns ...func(*Options)) (*UpdateElasticsearchDomainConfigOutput, error)

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

func (*Client) UpdatePackage added in v0.30.0 

func (c *Client) UpdatePackage(ctx context.Context, params *UpdatePackageInput, optFns ...func(*Options)) (*UpdatePackageOutput, error)

Updates a package for use with Amazon ES domains.

func (*Client) UpdateVpcEndpoint added in v1.17.0 

func (c *Client) UpdateVpcEndpoint(ctx context.Context, params *UpdateVpcEndpointInput, optFns ...func(*Options)) (*UpdateVpcEndpointOutput, error)

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

func (*Client) UpgradeElasticsearchDomain 

func (c *Client) UpgradeElasticsearchDomain(ctx context.Context, params *UpgradeElasticsearchDomainInput, optFns ...func(*Options)) (*UpgradeElasticsearchDomainOutput, error)

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

type CreateElasticsearchDomainInput 

type CreateElasticsearchDomainInput struct {

	// The name of the Elasticsearch domain that you are creating. Domain names are
	// unique across the domains owned by an account within an AWS region. Domain names
	// must start with a lowercase letter and can contain the following characters: a-z
	// (lowercase), 0-9, and - (hyphen).
	//
	// This member is required.
	DomainName *string

	//  IAM access policy as a JSON-formatted string.
	AccessPolicies *string

	//  Option to allow references to indices in an HTTP request body. Must be false
	// when configuring access to individual sub-resources. By default, the value is
	// true . See [Configuration Advanced Options] for more information.
	//
	// [Configuration Advanced Options]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
	AdvancedOptions map[string]string

	// Specifies advanced security options.
	AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput

	// Specifies Auto-Tune options.
	AutoTuneOptions *types.AutoTuneOptionsInput

	// Options to specify the Cognito user and identity pools for Kibana
	// authentication. For more information, see [Amazon Cognito Authentication for Kibana].
	//
	// [Amazon Cognito Authentication for Kibana]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html
	CognitoOptions *types.CognitoOptions

	// Options to specify configuration that will be applied to the domain endpoint.
	DomainEndpointOptions *types.DomainEndpointOptions

	// Options to enable, disable and specify the type and size of EBS storage
	// volumes.
	EBSOptions *types.EBSOptions

	// Configuration options for an Elasticsearch domain. Specifies the instance type
	// and number of instances in the domain cluster.
	ElasticsearchClusterConfig *types.ElasticsearchClusterConfig

	// String of format X.Y to specify version for the Elasticsearch domain eg. "1.5"
	// or "2.3". For more information, see [Creating Elasticsearch Domains]in the Amazon Elasticsearch Service
	// Developer Guide.
	//
	// [Creating Elasticsearch Domains]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains
	ElasticsearchVersion *string

	// Specifies the Encryption At Rest Options.
	EncryptionAtRestOptions *types.EncryptionAtRestOptions

	// Map of LogType and LogPublishingOption , each containing options to publish a
	// given type of Elasticsearch log.
	LogPublishingOptions map[string]types.LogPublishingOption

	// Specifies the NodeToNodeEncryptionOptions.
	NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions

	// Option to set time, in UTC format, of the daily automated snapshot. Default
	// value is 0 hours.
	SnapshotOptions *types.SnapshotOptions

	// A list of Tag added during domain creation.
	TagList []types.Tag

	// Options to specify the subnets and security groups for VPC endpoint. For more
	// information, see [Creating a VPC]in VPC Endpoints for Amazon Elasticsearch Service Domains
	//
	// [Creating a VPC]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc
	VPCOptions *types.VPCOptions
	// contains filtered or unexported fields
}

type CreateElasticsearchDomainOutput 

type CreateElasticsearchDomainOutput struct {

	// The status of the newly created Elasticsearch domain.
	DomainStatus *types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

type CreateOutboundCrossClusterSearchConnectionInput 

type CreateOutboundCrossClusterSearchConnectionInput struct {

	// Specifies the connection alias that will be used by the customer for this
	// connection.
	//
	// This member is required.
	ConnectionAlias *string

	// Specifies the DomainInformation for the destination Elasticsearch domain.
	//
	// This member is required.
	DestinationDomainInfo *types.DomainInformation

	// Specifies the DomainInformation for the source Elasticsearch domain.
	//
	// This member is required.
	SourceDomainInfo *types.DomainInformation
	// contains filtered or unexported fields
}

Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.

type CreateOutboundCrossClusterSearchConnectionOutput 

type CreateOutboundCrossClusterSearchConnectionOutput struct {

	// Specifies the connection alias provided during the create connection request.
	ConnectionAlias *string

	// Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.
	ConnectionStatus *types.OutboundCrossClusterSearchConnectionStatus

	// Unique id for the created outbound connection, which is used for subsequent
	// operations on connection.
	CrossClusterSearchConnectionId *string

	// Specifies the DomainInformation for the destination Elasticsearch domain.
	DestinationDomainInfo *types.DomainInformation

	// Specifies the DomainInformation for the source Elasticsearch domain.
	SourceDomainInfo *types.DomainInformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a CreateOutboundCrossClusterSearchConnection request. Contains the details of the newly created cross-cluster search connection.

type CreatePackageInput 

type CreatePackageInput struct {

	// Unique identifier for the package.
	//
	// This member is required.
	PackageName *string

	// The customer S3 location PackageSource for importing the package.
	//
	// This member is required.
	PackageSource *types.PackageSource

	// Type of package. Currently supports only TXT-DICTIONARY.
	//
	// This member is required.
	PackageType types.PackageType

	// Description of the package.
	PackageDescription *string
	// contains filtered or unexported fields
}

Container for request parameters to CreatePackage operation.

type CreatePackageOutput 

type CreatePackageOutput struct {

	// Information about the package PackageDetails .
	PackageDetails *types.PackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by CreatePackage operation.

type CreateVpcEndpointInput added in v1.17.0 

type CreateVpcEndpointInput struct {

	// The Amazon Resource Name (ARN) of the domain to grant access to.
	//
	// This member is required.
	DomainArn *string

	// Options to specify the subnets and security groups for the endpoint.
	//
	// This member is required.
	VpcOptions *types.VPCOptions

	// Unique, case-sensitive identifier to ensure idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the CreateVpcEndpointRequest operation.

type CreateVpcEndpointOutput added in v1.17.0 

type CreateVpcEndpointOutput struct {

	// Information about the newly created VPC endpoint.
	//
	// This member is required.
	VpcEndpoint *types.VpcEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the CreateVpcEndpoint operation. Contains the configuration and status of the VPC Endpoint being created.

type DeleteElasticsearchDomainInput 

type DeleteElasticsearchDomainInput struct {

	// The name of the Elasticsearch domain that you want to permanently delete.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

type DeleteElasticsearchDomainOutput 

type DeleteElasticsearchDomainOutput struct {

	// The status of the Elasticsearch domain being deleted.
	DomainStatus *types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

type DeleteElasticsearchServiceRoleInput 

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

type DeleteElasticsearchServiceRoleOutput 

type DeleteElasticsearchServiceRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteInboundCrossClusterSearchConnectionInput 

type DeleteInboundCrossClusterSearchConnectionInput struct {

	// The id of the inbound connection that you want to permanently delete.
	//
	// This member is required.
	CrossClusterSearchConnectionId *string
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

type DeleteInboundCrossClusterSearchConnectionOutput 

type DeleteInboundCrossClusterSearchConnectionOutput struct {

	// Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.
	CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection.

type DeleteOutboundCrossClusterSearchConnectionInput 

type DeleteOutboundCrossClusterSearchConnectionInput struct {

	// The id of the outbound connection that you want to permanently delete.
	//
	// This member is required.
	CrossClusterSearchConnectionId *string
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

type DeleteOutboundCrossClusterSearchConnectionOutput 

type DeleteOutboundCrossClusterSearchConnectionOutput struct {

	// Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.
	CrossClusterSearchConnection *types.OutboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection.

type DeletePackageInput 

type DeletePackageInput struct {

	// Internal ID of the package that you want to delete. Use DescribePackages to
	// find this value.
	//
	// This member is required.
	PackageID *string
	// contains filtered or unexported fields
}

Container for request parameters to DeletePackage operation.

type DeletePackageOutput 

type DeletePackageOutput struct {

	//     PackageDetails
	PackageDetails *types.PackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to DeletePackage operation.

type DeleteVpcEndpointInput added in v1.17.0 

type DeleteVpcEndpointInput struct {

	// The unique identifier of the endpoint to be deleted.
	//
	// This member is required.
	VpcEndpointId *string
	// contains filtered or unexported fields
}

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

type DeleteVpcEndpointOutput added in v1.17.0 

type DeleteVpcEndpointOutput struct {

	// Information about the deleted endpoint, including its current status ( DELETING
	// or DELETE_FAILED ).
	//
	// This member is required.
	VpcEndpointSummary *types.VpcEndpointSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the DeleteVpcEndpoint operation. Contains the summarized detail of the VPC Endpoint being deleted.

type DescribeDomainAutoTunesAPIClient added in v1.2.0 

type DescribeDomainAutoTunesAPIClient interface {
	DescribeDomainAutoTunes(context.Context, *DescribeDomainAutoTunesInput, ...func(*Options)) (*DescribeDomainAutoTunesOutput, error)
}

DescribeDomainAutoTunesAPIClient is a client that implements the DescribeDomainAutoTunes operation.

type DescribeDomainAutoTunesInput added in v1.2.0 

type DescribeDomainAutoTunesInput struct {

	// Specifies the domain name for which you want Auto-Tune action details.
	//
	// This member is required.
	DomainName *string

	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults int32

	// NextToken is sent in case the earlier API call results contain the NextToken.
	// It is used for pagination.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainAutoTunes operation.

type DescribeDomainAutoTunesOutput added in v1.2.0 

type DescribeDomainAutoTunesOutput struct {

	// Specifies the list of setting adjustments that Auto-Tune has made to the
	// domain. See the [Developer Guide]for more information.
	//
	// [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html
	AutoTunes []types.AutoTune

	// Specifies an identifier to allow retrieval of paginated results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.

type DescribeDomainAutoTunesPaginator added in v1.2.0 

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

DescribeDomainAutoTunesPaginator is a paginator for DescribeDomainAutoTunes

func NewDescribeDomainAutoTunesPaginator added in v1.2.0 

func NewDescribeDomainAutoTunesPaginator(client DescribeDomainAutoTunesAPIClient, params *DescribeDomainAutoTunesInput, optFns ...func(*DescribeDomainAutoTunesPaginatorOptions)) *DescribeDomainAutoTunesPaginator

NewDescribeDomainAutoTunesPaginator returns a new DescribeDomainAutoTunesPaginator

func (*DescribeDomainAutoTunesPaginator) HasMorePages added in v1.2.0 

func (p *DescribeDomainAutoTunesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeDomainAutoTunesPaginator) NextPage added in v1.2.0 

func (p *DescribeDomainAutoTunesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDomainAutoTunesOutput, error)

NextPage retrieves the next DescribeDomainAutoTunes page.

type DescribeDomainAutoTunesPaginatorOptions added in v1.2.0 

type DescribeDomainAutoTunesPaginatorOptions struct {
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeDomainAutoTunesPaginatorOptions is the paginator options for DescribeDomainAutoTunes

type DescribeDomainChangeProgressInput added in v1.14.0 

type DescribeDomainChangeProgressInput struct {

	// The domain you want to get the progress information about.
	//
	// This member is required.
	DomainName *string

	// The specific change ID for which you want to get progress information. This is
	// an optional parameter. If omitted, the service returns information about the
	// most recent configuration change.
	ChangeId *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information.

type DescribeDomainChangeProgressOutput added in v1.14.0 

type DescribeDomainChangeProgressOutput struct {

	// Progress information for the configuration change that is requested in the
	// DescribeDomainChangeProgress request.
	ChangeProgressStatus *types.ChangeProgressStatusDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change.

type DescribeElasticsearchDomainConfigInput 

type DescribeElasticsearchDomainConfigInput struct {

	// The Elasticsearch domain that you want to get information about.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}
Container for the parameters to the DescribeElasticsearchDomainConfig

operation. Specifies the domain name for which you want configuration information.

type DescribeElasticsearchDomainConfigOutput 

type DescribeElasticsearchDomainConfigOutput struct {

	// The configuration information of the domain requested in the
	// DescribeElasticsearchDomainConfig request.
	//
	// This member is required.
	DomainConfig *types.ElasticsearchDomainConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

type DescribeElasticsearchDomainInput 

type DescribeElasticsearchDomainInput struct {

	// The name of the Elasticsearch domain for which you want information.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeElasticsearchDomain operation.

type DescribeElasticsearchDomainOutput 

type DescribeElasticsearchDomainOutput struct {

	// The current status of the Elasticsearch domain.
	//
	// This member is required.
	DomainStatus *types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

type DescribeElasticsearchDomainsInput 

type DescribeElasticsearchDomainsInput struct {

	// The Elasticsearch domains for which you want information.
	//
	// This member is required.
	DomainNames []string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

type DescribeElasticsearchDomainsOutput 

type DescribeElasticsearchDomainsOutput struct {

	// The status of the domains requested in the DescribeElasticsearchDomains request.
	//
	// This member is required.
	DomainStatusList []types.ElasticsearchDomainStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DescribeElasticsearchInstanceTypeLimitsInput 

type DescribeElasticsearchInstanceTypeLimitsInput struct {

	//  Version of Elasticsearch for which Limits are needed.
	//
	// This member is required.
	ElasticsearchVersion *string

	//  The instance type for an Elasticsearch cluster for which Elasticsearch Limits are
	// needed.
	//
	// This member is required.
	InstanceType types.ESPartitionInstanceType

	//  DomainName represents the name of the Domain that we are trying to modify.
	// This should be present only if we are querying for Elasticsearch Limitsfor existing
	// domain.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

type DescribeElasticsearchInstanceTypeLimitsOutput 

type DescribeElasticsearchInstanceTypeLimitsOutput struct {

	//  Map of Role of the Instance and Limits that are applicable. Role performed by
	// given Instance in Elasticsearch can be one of the following:
	//
	//   - data: If the given InstanceType is used as data node
	//   - master: If the given InstanceType is used as master node
	//   - ultra_warm: If the given InstanceType is used as warm node
	LimitsByRole map[string]types.Limits

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.

type DescribeInboundCrossClusterSearchConnectionsAPIClient added in v0.30.0 

type DescribeInboundCrossClusterSearchConnectionsAPIClient interface {
	DescribeInboundCrossClusterSearchConnections(context.Context, *DescribeInboundCrossClusterSearchConnectionsInput, ...func(*Options)) (*DescribeInboundCrossClusterSearchConnectionsOutput, error)
}

DescribeInboundCrossClusterSearchConnectionsAPIClient is a client that implements the DescribeInboundCrossClusterSearchConnections operation.

type DescribeInboundCrossClusterSearchConnectionsInput 

type DescribeInboundCrossClusterSearchConnectionsInput struct {

	//  A list of filters used to match properties for inbound cross-cluster search
	// connection. Available Filternames for this operation are:
	//
	//   - cross-cluster-search-connection-id
	//   - source-domain-info.domain-name
	//   - source-domain-info.owner-id
	//   - source-domain-info.region
	//   - destination-domain-info.domain-name
	Filters []types.Filter

	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults int32

	//  NextToken is sent in case the earlier API call results contain the NextToken.
	// It is used for pagination.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

type DescribeInboundCrossClusterSearchConnectionsOutput 

type DescribeInboundCrossClusterSearchConnectionsOutput struct {

	// Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.
	CrossClusterSearchConnections []types.InboundCrossClusterSearchConnection

	// If more results are available and NextToken is present, make the next request
	// to the same API with the received NextToken to paginate the remaining results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.

type DescribeInboundCrossClusterSearchConnectionsPaginator added in v0.30.0 

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

DescribeInboundCrossClusterSearchConnectionsPaginator is a paginator for DescribeInboundCrossClusterSearchConnections

func NewDescribeInboundCrossClusterSearchConnectionsPaginator added in v0.30.0 

func NewDescribeInboundCrossClusterSearchConnectionsPaginator(client DescribeInboundCrossClusterSearchConnectionsAPIClient, params *DescribeInboundCrossClusterSearchConnectionsInput, optFns ...func(*DescribeInboundCrossClusterSearchConnectionsPaginatorOptions)) *DescribeInboundCrossClusterSearchConnectionsPaginator

NewDescribeInboundCrossClusterSearchConnectionsPaginator returns a new DescribeInboundCrossClusterSearchConnectionsPaginator

func (*DescribeInboundCrossClusterSearchConnectionsPaginator) HasMorePages added in v0.30.0 

func (p *DescribeInboundCrossClusterSearchConnectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeInboundCrossClusterSearchConnectionsPaginator) NextPage added in v0.30.0 

func (p *DescribeInboundCrossClusterSearchConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInboundCrossClusterSearchConnectionsOutput, error)

NextPage retrieves the next DescribeInboundCrossClusterSearchConnections page.

type DescribeInboundCrossClusterSearchConnectionsPaginatorOptions added in v0.30.0 

type DescribeInboundCrossClusterSearchConnectionsPaginatorOptions struct {
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeInboundCrossClusterSearchConnectionsPaginatorOptions is the paginator options for DescribeInboundCrossClusterSearchConnections

type DescribeOutboundCrossClusterSearchConnectionsAPIClient added in v0.30.0 

type DescribeOutboundCrossClusterSearchConnectionsAPIClient interface {
	DescribeOutboundCrossClusterSearchConnections(context.Context, *DescribeOutboundCrossClusterSearchConnectionsInput, ...func(*Options)) (*DescribeOutboundCrossClusterSearchConnectionsOutput, error)
}

DescribeOutboundCrossClusterSearchConnectionsAPIClient is a client that implements the DescribeOutboundCrossClusterSearchConnections operation.

type DescribeOutboundCrossClusterSearchConnectionsInput 

type DescribeOutboundCrossClusterSearchConnectionsInput struct {

	//  A list of filters used to match properties for outbound cross-cluster search
	// connection. Available Filternames for this operation are:
	//
	//   - cross-cluster-search-connection-id
	//   - destination-domain-info.domain-name
	//   - destination-domain-info.owner-id
	//   - destination-domain-info.region
	//   - source-domain-info.domain-name
	Filters []types.Filter

	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults int32

	//  NextToken is sent in case the earlier API call results contain the NextToken.
	// It is used for pagination.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

type DescribeOutboundCrossClusterSearchConnectionsOutput 

type DescribeOutboundCrossClusterSearchConnectionsOutput struct {

	// Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.
	CrossClusterSearchConnections []types.OutboundCrossClusterSearchConnection

	// If more results are available and NextToken is present, make the next request
	// to the same API with the received NextToken to paginate the remaining results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.

type DescribeOutboundCrossClusterSearchConnectionsPaginator added in v0.30.0 

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

DescribeOutboundCrossClusterSearchConnectionsPaginator is a paginator for DescribeOutboundCrossClusterSearchConnections

func NewDescribeOutboundCrossClusterSearchConnectionsPaginator added in v0.30.0 

func NewDescribeOutboundCrossClusterSearchConnectionsPaginator(client DescribeOutboundCrossClusterSearchConnectionsAPIClient, params *DescribeOutboundCrossClusterSearchConnectionsInput, optFns ...func(*DescribeOutboundCrossClusterSearchConnectionsPaginatorOptions)) *DescribeOutboundCrossClusterSearchConnectionsPaginator

NewDescribeOutboundCrossClusterSearchConnectionsPaginator returns a new DescribeOutboundCrossClusterSearchConnectionsPaginator

func (*DescribeOutboundCrossClusterSearchConnectionsPaginator) HasMorePages added in v0.30.0 

func (p *DescribeOutboundCrossClusterSearchConnectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeOutboundCrossClusterSearchConnectionsPaginator) NextPage added in v0.30.0 

func (p *DescribeOutboundCrossClusterSearchConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOutboundCrossClusterSearchConnectionsOutput, error)

NextPage retrieves the next DescribeOutboundCrossClusterSearchConnections page.

type DescribeOutboundCrossClusterSearchConnectionsPaginatorOptions added in v0.30.0 

type DescribeOutboundCrossClusterSearchConnectionsPaginatorOptions struct {
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeOutboundCrossClusterSearchConnectionsPaginatorOptions is the paginator options for DescribeOutboundCrossClusterSearchConnections

type DescribePackagesAPIClient added in v0.30.0 

type DescribePackagesAPIClient interface {
	DescribePackages(context.Context, *DescribePackagesInput, ...func(*Options)) (*DescribePackagesOutput, error)
}

DescribePackagesAPIClient is a client that implements the DescribePackages operation.

type DescribePackagesInput 

type DescribePackagesInput struct {

	// Only returns packages that match the DescribePackagesFilterList values.
	Filters []types.DescribePackagesFilter

	// Limits results to a maximum number of packages.
	MaxResults int32

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for request parameters to DescribePackage operation.

type DescribePackagesOutput 

type DescribePackagesOutput struct {
	NextToken *string

	// List of PackageDetails objects.
	PackageDetailsList []types.PackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by DescribePackages operation.

type DescribePackagesPaginator added in v0.30.0 

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

DescribePackagesPaginator is a paginator for DescribePackages

func NewDescribePackagesPaginator added in v0.30.0 

func NewDescribePackagesPaginator(client DescribePackagesAPIClient, params *DescribePackagesInput, optFns ...func(*DescribePackagesPaginatorOptions)) *DescribePackagesPaginator

NewDescribePackagesPaginator returns a new DescribePackagesPaginator

func (*DescribePackagesPaginator) HasMorePages added in v0.30.0 

func (p *DescribePackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribePackagesPaginator) NextPage added in v0.30.0 

func (p *DescribePackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePackagesOutput, error)

NextPage retrieves the next DescribePackages page.

type DescribePackagesPaginatorOptions added in v0.30.0 

type DescribePackagesPaginatorOptions struct {
	// Limits results to a maximum number of packages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribePackagesPaginatorOptions is the paginator options for DescribePackages

type DescribeReservedElasticsearchInstanceOfferingsAPIClient added in v0.30.0 

type DescribeReservedElasticsearchInstanceOfferingsAPIClient interface {
	DescribeReservedElasticsearchInstanceOfferings(context.Context, *DescribeReservedElasticsearchInstanceOfferingsInput, ...func(*Options)) (*DescribeReservedElasticsearchInstanceOfferingsOutput, error)
}

DescribeReservedElasticsearchInstanceOfferingsAPIClient is a client that implements the DescribeReservedElasticsearchInstanceOfferings operation.

type DescribeReservedElasticsearchInstanceOfferingsInput 

type DescribeReservedElasticsearchInstanceOfferingsInput struct {

	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults int32

	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string

	// The offering identifier filter value. Use this parameter to show only the
	// available offering that matches the specified reservation identifier.
	ReservedElasticsearchInstanceOfferingId *string
	// contains filtered or unexported fields
}

Container for parameters to DescribeReservedElasticsearchInstanceOfferings

type DescribeReservedElasticsearchInstanceOfferingsOutput 

type DescribeReservedElasticsearchInstanceOfferingsOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string

	// List of reserved Elasticsearch instance offerings
	ReservedElasticsearchInstanceOfferings []types.ReservedElasticsearchInstanceOffering

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for results from DescribeReservedElasticsearchInstanceOfferings

type DescribeReservedElasticsearchInstanceOfferingsPaginator added in v0.30.0 

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

DescribeReservedElasticsearchInstanceOfferingsPaginator is a paginator for DescribeReservedElasticsearchInstanceOfferings

func NewDescribeReservedElasticsearchInstanceOfferingsPaginator added in v0.30.0 

func NewDescribeReservedElasticsearchInstanceOfferingsPaginator(client DescribeReservedElasticsearchInstanceOfferingsAPIClient, params *DescribeReservedElasticsearchInstanceOfferingsInput, optFns ...func(*DescribeReservedElasticsearchInstanceOfferingsPaginatorOptions)) *DescribeReservedElasticsearchInstanceOfferingsPaginator

NewDescribeReservedElasticsearchInstanceOfferingsPaginator returns a new DescribeReservedElasticsearchInstanceOfferingsPaginator

func (*DescribeReservedElasticsearchInstanceOfferingsPaginator) HasMorePages added in v0.30.0 

func (p *DescribeReservedElasticsearchInstanceOfferingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeReservedElasticsearchInstanceOfferingsPaginator) NextPage added in v0.30.0 

func (p *DescribeReservedElasticsearchInstanceOfferingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeReservedElasticsearchInstanceOfferingsOutput, error)

NextPage retrieves the next DescribeReservedElasticsearchInstanceOfferings page.

type DescribeReservedElasticsearchInstanceOfferingsPaginatorOptions added in v0.30.0 

type DescribeReservedElasticsearchInstanceOfferingsPaginatorOptions struct {
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeReservedElasticsearchInstanceOfferingsPaginatorOptions is the paginator options for DescribeReservedElasticsearchInstanceOfferings

type DescribeReservedElasticsearchInstancesAPIClient added in v0.30.0 

type DescribeReservedElasticsearchInstancesAPIClient interface {
	DescribeReservedElasticsearchInstances(context.Context, *DescribeReservedElasticsearchInstancesInput, ...func(*Options)) (*DescribeReservedElasticsearchInstancesOutput, error)
}

DescribeReservedElasticsearchInstancesAPIClient is a client that implements the DescribeReservedElasticsearchInstances operation.

type DescribeReservedElasticsearchInstancesInput 

type DescribeReservedElasticsearchInstancesInput struct {

	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	MaxResults int32

	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string

	// The reserved instance identifier filter value. Use this parameter to show only
	// the reservation that matches the specified reserved Elasticsearch instance ID.
	ReservedElasticsearchInstanceId *string
	// contains filtered or unexported fields
}

Container for parameters to DescribeReservedElasticsearchInstances

type DescribeReservedElasticsearchInstancesOutput 

type DescribeReservedElasticsearchInstancesOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string

	// List of reserved Elasticsearch instances.
	ReservedElasticsearchInstances []types.ReservedElasticsearchInstance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for results from DescribeReservedElasticsearchInstances

type DescribeReservedElasticsearchInstancesPaginator added in v0.30.0 

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

DescribeReservedElasticsearchInstancesPaginator is a paginator for DescribeReservedElasticsearchInstances

func NewDescribeReservedElasticsearchInstancesPaginator added in v0.30.0 

func NewDescribeReservedElasticsearchInstancesPaginator(client DescribeReservedElasticsearchInstancesAPIClient, params *DescribeReservedElasticsearchInstancesInput, optFns ...func(*DescribeReservedElasticsearchInstancesPaginatorOptions)) *DescribeReservedElasticsearchInstancesPaginator

NewDescribeReservedElasticsearchInstancesPaginator returns a new DescribeReservedElasticsearchInstancesPaginator

func (*DescribeReservedElasticsearchInstancesPaginator) HasMorePages added in v0.30.0 

func (p *DescribeReservedElasticsearchInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeReservedElasticsearchInstancesPaginator) NextPage added in v0.30.0 

func (p *DescribeReservedElasticsearchInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeReservedElasticsearchInstancesOutput, error)

NextPage retrieves the next DescribeReservedElasticsearchInstances page.

type DescribeReservedElasticsearchInstancesPaginatorOptions added in v0.30.0 

type DescribeReservedElasticsearchInstancesPaginatorOptions struct {
	// Set this value to limit the number of results returned. If not specified,
	// defaults to 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeReservedElasticsearchInstancesPaginatorOptions is the paginator options for DescribeReservedElasticsearchInstances

type DescribeVpcEndpointsInput added in v1.17.0 

type DescribeVpcEndpointsInput struct {

	// The unique identifiers of the endpoints to get information about.
	//
	// This member is required.
	VpcEndpointIds []string
	// contains filtered or unexported fields
}

Container for request parameters to the DescribeVpcEndpoints operation. Specifies the list of VPC endpoints to be described.

type DescribeVpcEndpointsOutput added in v1.17.0 

type DescribeVpcEndpointsOutput struct {

	// Any errors associated with the request.
	//
	// This member is required.
	VpcEndpointErrors []types.VpcEndpointError

	// Information about each requested VPC endpoint.
	//
	// This member is required.
	VpcEndpoints []types.VpcEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the DescribeVpcEndpoints operation. Returns a list containing configuration details and status of the VPC Endpoints as well as a list containing error responses of the endpoints that could not be described

type DissociatePackageInput 

type DissociatePackageInput struct {

	// Name of the domain that you want to associate the package with.
	//
	// This member is required.
	DomainName *string

	// Internal ID of the package that you want to associate with a domain. Use
	// DescribePackages to find this value.
	//
	// This member is required.
	PackageID *string
	// contains filtered or unexported fields
}

Container for request parameters to DissociatePackage operation.

type DissociatePackageOutput 

type DissociatePackageOutput struct {

	//     DomainPackageDetails
	DomainPackageDetails *types.DomainPackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by DissociatePackage operation.

type EndpointParameters added in v1.20.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.20.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.20.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.20.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.20.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCompatibleElasticsearchVersionsInput 

type GetCompatibleElasticsearchVersionsInput struct {

	// The name of an Elasticsearch 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
	// contains filtered or unexported fields
}

Container for request parameters to GetCompatibleElasticsearchVersions operation.

type GetCompatibleElasticsearchVersionsOutput 

type GetCompatibleElasticsearchVersionsOutput struct {

	//  A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.
	CompatibleElasticsearchVersions []types.CompatibleVersionsMap

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by GetCompatibleElasticsearchVersions operation.

type GetPackageVersionHistoryAPIClient added in v0.30.0 

type GetPackageVersionHistoryAPIClient interface {
	GetPackageVersionHistory(context.Context, *GetPackageVersionHistoryInput, ...func(*Options)) (*GetPackageVersionHistoryOutput, error)
}

GetPackageVersionHistoryAPIClient is a client that implements the GetPackageVersionHistory operation.

type GetPackageVersionHistoryInput added in v0.30.0 

type GetPackageVersionHistoryInput struct {

	// Returns an audit history of versions of the package.
	//
	// This member is required.
	PackageID *string

	// Limits results to a maximum number of versions.
	MaxResults int32

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for request parameters to GetPackageVersionHistory operation.

type GetPackageVersionHistoryOutput added in v0.30.0 

type GetPackageVersionHistoryOutput struct {
	NextToken *string

	PackageID *string

	// List of PackageVersionHistory objects.
	PackageVersionHistoryList []types.PackageVersionHistory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by GetPackageVersionHistory operation.

type GetPackageVersionHistoryPaginator added in v0.30.0 

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

GetPackageVersionHistoryPaginator is a paginator for GetPackageVersionHistory

func NewGetPackageVersionHistoryPaginator added in v0.30.0 

func NewGetPackageVersionHistoryPaginator(client GetPackageVersionHistoryAPIClient, params *GetPackageVersionHistoryInput, optFns ...func(*GetPackageVersionHistoryPaginatorOptions)) *GetPackageVersionHistoryPaginator

NewGetPackageVersionHistoryPaginator returns a new GetPackageVersionHistoryPaginator

func (*GetPackageVersionHistoryPaginator) HasMorePages added in v0.30.0 

func (p *GetPackageVersionHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetPackageVersionHistoryPaginator) NextPage added in v0.30.0 

func (p *GetPackageVersionHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetPackageVersionHistoryOutput, error)

NextPage retrieves the next GetPackageVersionHistory page.

type GetPackageVersionHistoryPaginatorOptions added in v0.30.0 

type GetPackageVersionHistoryPaginatorOptions struct {
	// Limits results to a maximum number of versions.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetPackageVersionHistoryPaginatorOptions is the paginator options for GetPackageVersionHistory

type GetUpgradeHistoryAPIClient added in v0.30.0 

type GetUpgradeHistoryAPIClient interface {
	GetUpgradeHistory(context.Context, *GetUpgradeHistoryInput, ...func(*Options)) (*GetUpgradeHistoryOutput, error)
}

GetUpgradeHistoryAPIClient is a client that implements the GetUpgradeHistory operation.

type GetUpgradeHistoryInput 

type GetUpgradeHistoryInput struct {

	// The name of an Elasticsearch 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).
	//
	// This member is required.
	DomainName *string

	//  Set this value to limit the number of results returned.
	MaxResults int32

	//  Paginated APIs accepts NextToken input to returns next page results and
	// provides a NextToken output in the response which can be used by the client to
	// retrieve more results.
	NextToken *string
	// contains filtered or unexported fields
}

Container for request parameters to GetUpgradeHistory operation.

type GetUpgradeHistoryOutput 

type GetUpgradeHistoryOutput struct {

	// Pagination token that needs to be supplied to the next call to get the next
	// page of results
	NextToken *string

	//  A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check
	// performed on a domain returned as part of GetUpgradeHistoryResponseobject.
	UpgradeHistories []types.UpgradeHistory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by GetUpgradeHistory operation.

type GetUpgradeHistoryPaginator added in v0.30.0 

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

GetUpgradeHistoryPaginator is a paginator for GetUpgradeHistory

func NewGetUpgradeHistoryPaginator added in v0.30.0 

func NewGetUpgradeHistoryPaginator(client GetUpgradeHistoryAPIClient, params *GetUpgradeHistoryInput, optFns ...func(*GetUpgradeHistoryPaginatorOptions)) *GetUpgradeHistoryPaginator

NewGetUpgradeHistoryPaginator returns a new GetUpgradeHistoryPaginator

func (*GetUpgradeHistoryPaginator) HasMorePages added in v0.30.0 

func (p *GetUpgradeHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetUpgradeHistoryPaginator) NextPage added in v0.30.0 

func (p *GetUpgradeHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetUpgradeHistoryOutput, error)

NextPage retrieves the next GetUpgradeHistory page.

type GetUpgradeHistoryPaginatorOptions added in v0.30.0 

type GetUpgradeHistoryPaginatorOptions struct {
	//  Set this value to limit the number of results returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetUpgradeHistoryPaginatorOptions is the paginator options for GetUpgradeHistory

type GetUpgradeStatusInput 

type GetUpgradeStatusInput struct {

	// The name of an Elasticsearch 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).
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for request parameters to GetUpgradeStatus operation.

type GetUpgradeStatusOutput 

type GetUpgradeStatusOutput struct {

	//  One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object.
	// The status can take one of the following values:
	//
	//   - In Progress
	//   - Succeeded
	//   - Succeeded with Issues
	//   - Failed
	StepStatus types.UpgradeStatus

	// A string that describes the update briefly
	UpgradeName *string

	//  Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does
	// through:
	//
	//   - PreUpgradeCheck
	//   - Snapshot
	//   - Upgrade
	UpgradeStep types.UpgradeStep

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by GetUpgradeStatus operation.

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, optFns ...func(*v4.SignerOptions)) error
}

type ListDomainNamesInput 

type ListDomainNamesInput struct {

	//  Optional parameter to filter the output by domain engine type. Acceptable
	// values are 'Elasticsearch' and 'OpenSearch'.
	EngineType types.EngineType
	// contains filtered or unexported fields
}

Container for the parameters to the ListDomainNames operation.

type ListDomainNamesOutput 

type ListDomainNamesOutput struct {

	// List of domain names and respective engine types.
	DomainNames []types.DomainInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

type ListDomainsForPackageAPIClient added in v0.30.0 

type ListDomainsForPackageAPIClient interface {
	ListDomainsForPackage(context.Context, *ListDomainsForPackageInput, ...func(*Options)) (*ListDomainsForPackageOutput, error)
}

ListDomainsForPackageAPIClient is a client that implements the ListDomainsForPackage operation.

type ListDomainsForPackageInput 

type ListDomainsForPackageInput struct {

	// The package for which to list domains.
	//
	// This member is required.
	PackageID *string

	// Limits results to a maximum number of domains.
	MaxResults int32

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for request parameters to ListDomainsForPackage operation.

type ListDomainsForPackageOutput 

type ListDomainsForPackageOutput struct {

	// List of DomainPackageDetails objects.
	DomainPackageDetailsList []types.DomainPackageDetails

	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to ListDomainsForPackage operation.

type ListDomainsForPackagePaginator added in v0.30.0 

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

ListDomainsForPackagePaginator is a paginator for ListDomainsForPackage

func NewListDomainsForPackagePaginator added in v0.30.0 

func NewListDomainsForPackagePaginator(client ListDomainsForPackageAPIClient, params *ListDomainsForPackageInput, optFns ...func(*ListDomainsForPackagePaginatorOptions)) *ListDomainsForPackagePaginator

NewListDomainsForPackagePaginator returns a new ListDomainsForPackagePaginator

func (*ListDomainsForPackagePaginator) HasMorePages added in v0.30.0 

func (p *ListDomainsForPackagePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainsForPackagePaginator) NextPage added in v0.30.0 

func (p *ListDomainsForPackagePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainsForPackageOutput, error)

NextPage retrieves the next ListDomainsForPackage page.

type ListDomainsForPackagePaginatorOptions added in v0.30.0 

type ListDomainsForPackagePaginatorOptions struct {
	// Limits results to a maximum number of domains.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDomainsForPackagePaginatorOptions is the paginator options for ListDomainsForPackage

type ListElasticsearchInstanceTypesAPIClient added in v0.30.0 

type ListElasticsearchInstanceTypesAPIClient interface {
	ListElasticsearchInstanceTypes(context.Context, *ListElasticsearchInstanceTypesInput, ...func(*Options)) (*ListElasticsearchInstanceTypesOutput, error)
}

ListElasticsearchInstanceTypesAPIClient is a client that implements the ListElasticsearchInstanceTypes operation.

type ListElasticsearchInstanceTypesInput 

type ListElasticsearchInstanceTypesInput struct {

	// Version of Elasticsearch for which list of supported elasticsearch instance
	// types are needed.
	//
	// This member is required.
	ElasticsearchVersion *string

	// DomainName represents the name of the Domain that we are trying to modify. This
	// should be present only if we are querying for list of available Elasticsearch
	// instance types when modifying existing domain.
	DomainName *string

	//  Set this value to limit the number of results returned. Value provided must be
	// greater than 30 else it wont be honored.
	MaxResults int32

	// NextToken should be sent in case if earlier API call produced result containing
	// NextToken. It is used for pagination.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the ListElasticsearchInstanceTypes operation.

type ListElasticsearchInstanceTypesOutput 

type ListElasticsearchInstanceTypesOutput struct {

	//  List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion
	ElasticsearchInstanceTypes []types.ESPartitionInstanceType

	// In case if there are more results available NextToken would be present, make
	// further request to the same API with received NextToken to paginate remaining
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for the parameters returned by ListElasticsearchInstanceTypes operation.

type ListElasticsearchInstanceTypesPaginator added in v0.30.0 

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

ListElasticsearchInstanceTypesPaginator is a paginator for ListElasticsearchInstanceTypes

func NewListElasticsearchInstanceTypesPaginator added in v0.30.0 

func NewListElasticsearchInstanceTypesPaginator(client ListElasticsearchInstanceTypesAPIClient, params *ListElasticsearchInstanceTypesInput, optFns ...func(*ListElasticsearchInstanceTypesPaginatorOptions)) *ListElasticsearchInstanceTypesPaginator

NewListElasticsearchInstanceTypesPaginator returns a new ListElasticsearchInstanceTypesPaginator

func (*ListElasticsearchInstanceTypesPaginator) HasMorePages added in v0.30.0 

func (p *ListElasticsearchInstanceTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListElasticsearchInstanceTypesPaginator) NextPage added in v0.30.0 

func (p *ListElasticsearchInstanceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListElasticsearchInstanceTypesOutput, error)

NextPage retrieves the next ListElasticsearchInstanceTypes page.

type ListElasticsearchInstanceTypesPaginatorOptions added in v0.30.0 

type ListElasticsearchInstanceTypesPaginatorOptions struct {
	//  Set this value to limit the number of results returned. Value provided must be
	// greater than 30 else it wont be honored.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListElasticsearchInstanceTypesPaginatorOptions is the paginator options for ListElasticsearchInstanceTypes

type ListElasticsearchVersionsAPIClient added in v0.30.0 

type ListElasticsearchVersionsAPIClient interface {
	ListElasticsearchVersions(context.Context, *ListElasticsearchVersionsInput, ...func(*Options)) (*ListElasticsearchVersionsOutput, error)
}

ListElasticsearchVersionsAPIClient is a client that implements the ListElasticsearchVersions operation.

type ListElasticsearchVersionsInput 

type ListElasticsearchVersionsInput struct {

	//  Set this value to limit the number of results returned. Value provided must be
	// greater than 10 else it wont be honored.
	MaxResults int32

	//  Paginated APIs accepts NextToken input to returns next page results and
	// provides a NextToken output in the response which can be used by the client to
	// retrieve more results.
	NextToken *string
	// contains filtered or unexported fields
}
Container for the parameters to the ListElasticsearchVersions operation.

Use MaxResults to control the maximum number of results to retrieve in a single call.

Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

type ListElasticsearchVersionsOutput 

type ListElasticsearchVersionsOutput struct {

	// List of supported elastic search versions.
	ElasticsearchVersions []string

	//  Paginated APIs accepts NextToken input to returns next page results and
	// provides a NextToken output in the response which can be used by the client to
	// retrieve more results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for the parameters for response received from ListElasticsearchVersions operation.

type ListElasticsearchVersionsPaginator added in v0.30.0 

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

ListElasticsearchVersionsPaginator is a paginator for ListElasticsearchVersions

func NewListElasticsearchVersionsPaginator added in v0.30.0 

func NewListElasticsearchVersionsPaginator(client ListElasticsearchVersionsAPIClient, params *ListElasticsearchVersionsInput, optFns ...func(*ListElasticsearchVersionsPaginatorOptions)) *ListElasticsearchVersionsPaginator

NewListElasticsearchVersionsPaginator returns a new ListElasticsearchVersionsPaginator

func (*ListElasticsearchVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListElasticsearchVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListElasticsearchVersionsPaginator) NextPage added in v0.30.0 

func (p *ListElasticsearchVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListElasticsearchVersionsOutput, error)

NextPage retrieves the next ListElasticsearchVersions page.

type ListElasticsearchVersionsPaginatorOptions added in v0.30.0 

type ListElasticsearchVersionsPaginatorOptions struct {
	//  Set this value to limit the number of results returned. Value provided must be
	// greater than 10 else it wont be honored.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListElasticsearchVersionsPaginatorOptions is the paginator options for ListElasticsearchVersions

type ListPackagesForDomainAPIClient added in v0.30.0 

type ListPackagesForDomainAPIClient interface {
	ListPackagesForDomain(context.Context, *ListPackagesForDomainInput, ...func(*Options)) (*ListPackagesForDomainOutput, error)
}

ListPackagesForDomainAPIClient is a client that implements the ListPackagesForDomain operation.

type ListPackagesForDomainInput 

type ListPackagesForDomainInput struct {

	// The name of the domain for which you want to list associated packages.
	//
	// This member is required.
	DomainName *string

	// Limits results to a maximum number of packages.
	MaxResults int32

	// Used for pagination. Only necessary if a previous API call includes a non-null
	// NextToken value. If provided, returns results for the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for request parameters to ListPackagesForDomain operation.

type ListPackagesForDomainOutput 

type ListPackagesForDomainOutput struct {

	// List of DomainPackageDetails objects.
	DomainPackageDetailsList []types.DomainPackageDetails

	// Pagination token that needs to be supplied to the next call to get the next
	// page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to ListPackagesForDomain operation.

type ListPackagesForDomainPaginator added in v0.30.0 

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

ListPackagesForDomainPaginator is a paginator for ListPackagesForDomain

func NewListPackagesForDomainPaginator added in v0.30.0 

func NewListPackagesForDomainPaginator(client ListPackagesForDomainAPIClient, params *ListPackagesForDomainInput, optFns ...func(*ListPackagesForDomainPaginatorOptions)) *ListPackagesForDomainPaginator

NewListPackagesForDomainPaginator returns a new ListPackagesForDomainPaginator

func (*ListPackagesForDomainPaginator) HasMorePages added in v0.30.0 

func (p *ListPackagesForDomainPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackagesForDomainPaginator) NextPage added in v0.30.0 

func (p *ListPackagesForDomainPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPackagesForDomainOutput, error)

NextPage retrieves the next ListPackagesForDomain page.

type ListPackagesForDomainPaginatorOptions added in v0.30.0 

type ListPackagesForDomainPaginatorOptions struct {
	// Limits results to a maximum number of packages.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackagesForDomainPaginatorOptions is the paginator options for ListPackagesForDomain

type ListTagsInput 

type ListTagsInput struct {

	//  Specify the ARN for the Elasticsearch domain to which the tags are attached
	// that you want to view.
	//
	// This member is required.
	ARN *string
	// contains filtered or unexported fields
}

Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

type ListTagsOutput 

type ListTagsOutput struct {

	//  List of Tag for the requested Elasticsearch domain.
	TagList []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

type ListVpcEndpointAccessInput added in v1.17.0 

type ListVpcEndpointAccessInput struct {

	// The name of the OpenSearch Service domain to retrieve access information for.
	//
	// This member is required.
	DomainName *string

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint

type ListVpcEndpointAccessOutput added in v1.17.0 

type ListVpcEndpointAccessOutput struct {

	// List of AuthorizedPrincipal describing the details of the permissions to manage
	// VPC endpoints against the specified domain.
	//
	// This member is required.
	AuthorizedPrincipalList []types.AuthorizedPrincipal

	// Provides an identifier to allow retrieval of paginated results.
	//
	// This member is required.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the ListVpcEndpointAccess operation. Returns a list of accounts id and account type authorized to manage VPC endpoints.

type ListVpcEndpointsForDomainInput added in v1.17.0 

type ListVpcEndpointsForDomainInput struct {

	// Name of the ElasticSearch domain whose VPC endpoints are to be listed.
	//
	// This member is required.
	DomainName *string

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies the domain whose VPC endpoints will be listed.

type ListVpcEndpointsForDomainOutput added in v1.17.0 

type ListVpcEndpointsForDomainOutput struct {

	// Information about each endpoint associated with the domain.
	//
	// This member is required.
	NextToken *string

	// Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.
	//
	// This member is required.
	VpcEndpointSummaryList []types.VpcEndpointSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the ListVpcEndpointsForDomain operation. Returns a list containing summarized details of the VPC endpoints.

type ListVpcEndpointsInput added in v1.17.0 

type ListVpcEndpointsInput struct {

	// Identifier to allow retrieval of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

Container for request parameters to the ListVpcEndpoints operation.

type ListVpcEndpointsOutput added in v1.17.0 

type ListVpcEndpointsOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	//
	// This member is required.
	NextToken *string

	// Information about each endpoint.
	//
	// This member is required.
	VpcEndpointSummaryList []types.VpcEndpointSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the ListVpcEndpoints operation. Returns a list containing summarized details of the VPC endpoints.

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

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

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.23.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PurchaseReservedElasticsearchInstanceOfferingInput 

type PurchaseReservedElasticsearchInstanceOfferingInput struct {

	// A customer-specified identifier to track this reservation.
	//
	// This member is required.
	ReservationName *string

	// The ID of the reserved Elasticsearch instance offering to purchase.
	//
	// This member is required.
	ReservedElasticsearchInstanceOfferingId *string

	// The number of Elasticsearch instances to reserve.
	InstanceCount *int32
	// contains filtered or unexported fields
}

Container for parameters to PurchaseReservedElasticsearchInstanceOffering

type PurchaseReservedElasticsearchInstanceOfferingOutput 

type PurchaseReservedElasticsearchInstanceOfferingOutput struct {

	// The customer-specified identifier used to track this reservation.
	ReservationName *string

	// Details of the reserved Elasticsearch instance which was purchased.
	ReservedElasticsearchInstanceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

type RejectInboundCrossClusterSearchConnectionInput 

type RejectInboundCrossClusterSearchConnectionInput struct {

	// The id of the inbound connection that you want to reject.
	//
	// This member is required.
	CrossClusterSearchConnectionId *string
	// contains filtered or unexported fields
}

Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

type RejectInboundCrossClusterSearchConnectionOutput 

type RejectInboundCrossClusterSearchConnectionOutput struct {

	// Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.
	CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection.

type RemoveTagsInput 

type RemoveTagsInput struct {

	// Specifies the ARN for the Elasticsearch domain from which you want to delete
	// the specified tags.
	//
	// This member is required.
	ARN *string

	// Specifies the TagKey list which you want to remove from the Elasticsearch
	// domain.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey .

type RemoveTagsOutput 

type RemoveTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

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 RevokeVpcEndpointAccessInput added in v1.17.0 

type RevokeVpcEndpointAccessInput struct {

	// The account ID to revoke access from.
	//
	// This member is required.
	Account *string

	// The name of the OpenSearch Service domain.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

type RevokeVpcEndpointAccessOutput added in v1.17.0 

type RevokeVpcEndpointAccessOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response parameters to the RevokeVpcEndpointAccess operation. The response body for this operation is empty.

type StartElasticsearchServiceSoftwareUpdateInput 

type StartElasticsearchServiceSoftwareUpdateInput struct {

	// The name of the domain that you want to update to the latest service software.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.

type StartElasticsearchServiceSoftwareUpdateOutput 

type StartElasticsearchServiceSoftwareUpdateOutput struct {

	// The current status of the Elasticsearch service software update.
	ServiceSoftwareOptions *types.ServiceSoftwareOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

type UpdateElasticsearchDomainConfigInput 

type UpdateElasticsearchDomainConfigInput struct {

	// The name of the Elasticsearch domain that you are updating.
	//
	// This member is required.
	DomainName *string

	// IAM access policy as a JSON-formatted string.
	AccessPolicies *string

	// Modifies the advanced option to allow references to indices in an HTTP request
	// body. Must be false when configuring access to individual sub-resources. By
	// default, the value is true . See [Configuration Advanced Options] for more information.
	//
	// [Configuration Advanced Options]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
	AdvancedOptions map[string]string

	// Specifies advanced security options.
	AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput

	// Specifies Auto-Tune options.
	AutoTuneOptions *types.AutoTuneOptions

	// Options to specify the Cognito user and identity pools for Kibana
	// authentication. For more information, see [Amazon Cognito Authentication for Kibana].
	//
	// [Amazon Cognito Authentication for Kibana]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html
	CognitoOptions *types.CognitoOptions

	// Options to specify configuration that will be applied to the domain endpoint.
	DomainEndpointOptions *types.DomainEndpointOptions

	//  This flag, when set to True, specifies whether the UpdateElasticsearchDomain
	// request should return the results of validation checks without actually applying
	// the change. This flag, when set to True, specifies the deployment mechanism
	// through which the update shall be applied on the domain. This will not actually
	// perform the Update.
	DryRun *bool

	// Specify the type and size of the EBS volume that you want to use.
	EBSOptions *types.EBSOptions

	// The type and number of instances to instantiate for the domain cluster.
	ElasticsearchClusterConfig *types.ElasticsearchClusterConfig

	// Specifies the Encryption At Rest Options.
	EncryptionAtRestOptions *types.EncryptionAtRestOptions

	// Map of LogType and LogPublishingOption , each containing options to publish a
	// given type of Elasticsearch log.
	LogPublishingOptions map[string]types.LogPublishingOption

	// Specifies the NodeToNodeEncryptionOptions.
	NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions

	// Option to set the time, in UTC format, for the daily automated snapshot.
	// Default value is 0 hours.
	SnapshotOptions *types.SnapshotOptions

	// Options to specify the subnets and security groups for VPC endpoint. For more
	// information, see [Creating a VPC]in VPC Endpoints for Amazon Elasticsearch Service Domains
	//
	// [Creating a VPC]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc
	VPCOptions *types.VPCOptions
	// contains filtered or unexported fields
}

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

type UpdateElasticsearchDomainConfigOutput 

type UpdateElasticsearchDomainConfigOutput struct {

	// The status of the updated Elasticsearch domain.
	//
	// This member is required.
	DomainConfig *types.ElasticsearchDomainConfig

	// Contains result of DryRun.
	DryRunResults *types.DryRunResults

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

type UpdatePackageInput added in v0.30.0 

type UpdatePackageInput struct {

	// Unique identifier for the package.
	//
	// This member is required.
	PackageID *string

	// The S3 location for importing the package specified as S3BucketName and S3Key
	//
	// This member is required.
	PackageSource *types.PackageSource

	// An info message for the new version which will be shown as part of
	// GetPackageVersionHistoryResponse .
	CommitMessage *string

	// New description of the package.
	PackageDescription *string
	// contains filtered or unexported fields
}

Container for request parameters to UpdatePackage operation.

type UpdatePackageOutput added in v0.30.0 

type UpdatePackageOutput struct {

	// Information about the package PackageDetails .
	PackageDetails *types.PackageDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by UpdatePackage operation.

type UpdateVpcEndpointInput added in v1.17.0 

type UpdateVpcEndpointInput struct {

	// Unique identifier of the VPC endpoint to be updated.
	//
	// This member is required.
	VpcEndpointId *string

	// The security groups and/or subnets to add, remove, or modify.
	//
	// This member is required.
	VpcOptions *types.VPCOptions
	// contains filtered or unexported fields
}

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

type UpdateVpcEndpointOutput added in v1.17.0 

type UpdateVpcEndpointOutput struct {

	// The endpoint to be updated.
	//
	// This member is required.
	VpcEndpoint *types.VpcEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the configuration and status of the VPC endpoint being updated.

type UpgradeElasticsearchDomainInput 

type UpgradeElasticsearchDomainInput struct {

	// The name of an Elasticsearch 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).
	//
	// This member is required.
	DomainName *string

	// The version of Elasticsearch that you intend to upgrade the domain to.
	//
	// This member is required.
	TargetVersion *string

	//  This flag, when set to True, indicates that an Upgrade Eligibility Check needs
	// to be performed. This will not actually perform the Upgrade.
	PerformCheckOnly *bool
	// contains filtered or unexported fields
}

Container for request parameters to UpgradeElasticsearchDomain operation.

type UpgradeElasticsearchDomainOutput 

type UpgradeElasticsearchDomainOutput struct {

	// Specifies change details of the domain configuration change.
	ChangeProgressDetails *types.ChangeProgressDetails

	// The name of an Elasticsearch 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

	//  This flag, when set to True, indicates that an Upgrade Eligibility Check needs
	// to be performed. This will not actually perform the Upgrade.
	PerformCheckOnly *bool

	// The version of Elasticsearch that you intend to upgrade the domain to.
	TargetVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Container for response returned by UpgradeElasticsearchDomain operation.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.