opensearch

package module
v1.9.7 Latest Latest
Warning

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

 Go to latest Published: Jun 29, 2022 License: Apache-2.0 Imports: 33 Imported by: 18

Documentation

Overview

Package opensearch provides the API client, operations, and parameter types for Amazon OpenSearch Service.

Amazon OpenSearch Configuration Service Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains. For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-configuration-samples.html). The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html). 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 (http://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions).

Index

Constants

View Source 
const ServiceAPIVersion = "2021-01-01"
View Source 
const ServiceID = "OpenSearch"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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

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

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AcceptInboundConnectionInput 

type AcceptInboundConnectionInput struct {

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

Container for the parameters to the AcceptInboundConnection operation.

type AcceptInboundConnectionOutput 

type AcceptInboundConnectionOutput struct {

	// The InboundConnection of the accepted inbound connection.
	Connection *types.InboundConnection

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

The result of an AcceptInboundConnection operation. Contains details about the accepted inbound connection.

type AddTagsInput 

type AddTagsInput struct {

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

	// List of Tag to add to the domain.
	//
	// This member is required.
	TagList []types.Tag
	// contains filtered or unexported fields
}

Container for the parameters to the AddTags operation. Specifies the tags to attach to the 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 {

	// The name of the domain to associate the package with.
	//
	// This member is required.
	DomainName *string

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

Container for the request parameters to the 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 the response returned by AssociatePackage operation.

type CancelServiceSoftwareUpdateInput 

type CancelServiceSoftwareUpdateInput 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 CancelServiceSoftwareUpdate operation. Specifies the name of the domain that you wish to cancel a service software update on.

type CancelServiceSoftwareUpdateOutput 

type CancelServiceSoftwareUpdateOutput struct {

	// The current status of the OpenSearch 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 CancelServiceSoftwareUpdate 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 OpenSearch 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) AcceptInboundConnection 

func (c *Client) AcceptInboundConnection(ctx context.Context, params *AcceptInboundConnectionInput, optFns ...func(*Options)) (*AcceptInboundConnectionOutput, error)

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

func (*Client) AddTags 

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

Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging) 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 OpenSearch Service domain.

func (*Client) CancelServiceSoftwareUpdate 

func (c *Client) CancelServiceSoftwareUpdate(ctx context.Context, params *CancelServiceSoftwareUpdateInput, optFns ...func(*Options)) (*CancelServiceSoftwareUpdateOutput, error)

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

func (*Client) CreateDomain 

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

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) in the Amazon OpenSearch Service Developer Guide.

func (*Client) CreateOutboundConnection 

func (c *Client) CreateOutboundConnection(ctx context.Context, params *CreateOutboundConnectionInput, optFns ...func(*Options)) (*CreateOutboundConnectionOutput, error)

Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch 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 OpenSearch Service domains.

func (*Client) DeleteDomain 

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

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

func (*Client) DeleteInboundConnection 

func (c *Client) DeleteInboundConnection(ctx context.Context, params *DeleteInboundConnectionInput, optFns ...func(*Options)) (*DeleteInboundConnectionOutput, error)

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

func (*Client) DeleteOutboundConnection 

func (c *Client) DeleteOutboundConnection(ctx context.Context, params *DeleteOutboundConnectionInput, optFns ...func(*Options)) (*DeleteOutboundConnectionOutput, error)

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

func (*Client) DeletePackage 

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

Deletes the package.

func (*Client) DescribeDomain 

func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error)

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

func (*Client) DescribeDomainAutoTunes 

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

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

func (*Client) DescribeDomainChangeProgress added in v1.8.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) DescribeDomainConfig 

func (c *Client) DescribeDomainConfig(ctx context.Context, params *DescribeDomainConfigInput, optFns ...func(*Options)) (*DescribeDomainConfigOutput, error)

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

func (*Client) DescribeDomains 

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

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

func (*Client) DescribeInboundConnections 

func (c *Client) DescribeInboundConnections(ctx context.Context, params *DescribeInboundConnectionsInput, optFns ...func(*Options)) (*DescribeInboundConnectionsOutput, error)

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

func (*Client) DescribeInstanceTypeLimits 

func (c *Client) DescribeInstanceTypeLimits(ctx context.Context, params *DescribeInstanceTypeLimitsInput, optFns ...func(*Options)) (*DescribeInstanceTypeLimitsOutput, error)

Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.

func (*Client) DescribeOutboundConnections 

func (c *Client) DescribeOutboundConnections(ctx context.Context, params *DescribeOutboundConnectionsInput, optFns ...func(*Options)) (*DescribeOutboundConnectionsOutput, error)

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

func (*Client) DescribePackages 

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

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

func (*Client) DescribeReservedInstanceOfferings 

func (c *Client) DescribeReservedInstanceOfferings(ctx context.Context, params *DescribeReservedInstanceOfferingsInput, optFns ...func(*Options)) (*DescribeReservedInstanceOfferingsOutput, error)

Lists available reserved OpenSearch instance offerings.

func (*Client) DescribeReservedInstances 

func (c *Client) DescribeReservedInstances(ctx context.Context, params *DescribeReservedInstancesInput, optFns ...func(*Options)) (*DescribeReservedInstancesOutput, error)

Returns information about reserved OpenSearch instances for this account.

func (*Client) DissociatePackage 

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

Dissociates a package from the Amazon OpenSearch Service domain.

func (*Client) GetCompatibleVersions 

func (c *Client) GetCompatibleVersions(ctx context.Context, params *GetCompatibleVersionsInput, optFns ...func(*Options)) (*GetCompatibleVersionsOutput, error)

Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.

func (*Client) GetPackageVersionHistory 

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

Returns a list of package versions, 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 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 performed on the domain.

func (*Client) ListDomainNames 

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

Returns the names of all 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 OpenSearch Service domains associated with the package.

func (*Client) ListInstanceTypeDetails 

func (c *Client) ListInstanceTypeDetails(ctx context.Context, params *ListInstanceTypeDetailsInput, optFns ...func(*Options)) (*ListInstanceTypeDetailsOutput, error)

func (*Client) ListPackagesForDomain 

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

Lists all packages associated with the Amazon OpenSearch Service domain.

func (*Client) ListTags 

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

Returns all tags for the given domain.

func (*Client) ListVersions 

func (c *Client) ListVersions(ctx context.Context, params *ListVersionsInput, optFns ...func(*Options)) (*ListVersionsOutput, error)

List all supported versions of OpenSearch and Elasticsearch.

func (*Client) PurchaseReservedInstanceOffering 

func (c *Client) PurchaseReservedInstanceOffering(ctx context.Context, params *PurchaseReservedInstanceOfferingInput, optFns ...func(*Options)) (*PurchaseReservedInstanceOfferingOutput, error)

Allows you to purchase reserved OpenSearch instances.

func (*Client) RejectInboundConnection 

func (c *Client) RejectInboundConnection(ctx context.Context, params *RejectInboundConnectionInput, optFns ...func(*Options)) (*RejectInboundConnectionOutput, error)

Allows the remote domain owner to reject an inbound cross-cluster 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 given domain.

func (*Client) StartServiceSoftwareUpdate 

func (c *Client) StartServiceSoftwareUpdate(ctx context.Context, params *StartServiceSoftwareUpdateInput, optFns ...func(*Options)) (*StartServiceSoftwareUpdateOutput, error)

Schedules a service software update for an Amazon OpenSearch Service domain.

func (*Client) UpdateDomainConfig 

func (c *Client) UpdateDomainConfig(ctx context.Context, params *UpdateDomainConfigInput, optFns ...func(*Options)) (*UpdateDomainConfigOutput, error)

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

func (*Client) UpdatePackage 

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

Updates a package for use with Amazon OpenSearch Service domains.

func (*Client) UpgradeDomain 

func (c *Client) UpgradeDomain(ctx context.Context, params *UpgradeDomainInput, optFns ...func(*Options)) (*UpgradeDomainOutput, error)

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

type CreateDomainInput 

type CreateDomainInput struct {

	// The name of the Amazon OpenSearch Service domain you're 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 Advanced cluster parameters
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options)
	// for more information.
	AdvancedOptions map[string]string

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

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

	// Configuration options for a domain. Specifies the instance type and number of
	// instances in the domain.
	ClusterConfig *types.ClusterConfig

	// Options to specify the Cognito user and identity pools for OpenSearch Dashboards
	// authentication. For more information, see Configuring Amazon Cognito
	// authentication for OpenSearch Dashboards
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).
	CognitoOptions *types.CognitoOptions

	// Options to specify configurations 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

	// Options for encryption of data at rest.
	EncryptionAtRestOptions *types.EncryptionAtRestOptions

	// String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine
	// version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0"
	// or "Elasticsearch_7.9". For more information, see Creating and managing Amazon
	// OpenSearch Service domains
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains).
	EngineVersion *string

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

	// Node-to-node encryption options.
	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 a VPC endpoint. For more
	// information, see Launching your Amazon OpenSearch Service domains using a VPC
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
	VPCOptions *types.VPCOptions
	// contains filtered or unexported fields
}

type CreateDomainOutput 

type CreateDomainOutput struct {

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

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

The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.

type CreateOutboundConnectionInput 

type CreateOutboundConnectionInput struct {

	// The connection alias used used by the customer for this cross-cluster
	// connection.
	//
	// This member is required.
	ConnectionAlias *string

	// The AWSDomainInformation for the local OpenSearch domain.
	//
	// This member is required.
	LocalDomainInfo *types.DomainInformationContainer

	// The AWSDomainInformation for the remote OpenSearch domain.
	//
	// This member is required.
	RemoteDomainInfo *types.DomainInformationContainer
	// contains filtered or unexported fields
}

Container for the parameters to the CreateOutboundConnection operation.

type CreateOutboundConnectionOutput 

type CreateOutboundConnectionOutput struct {

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

	// The unique ID for the created outbound connection, which is used for subsequent
	// operations on the connection.
	ConnectionId *string

	// The OutboundConnectionStatus for the newly created connection.
	ConnectionStatus *types.OutboundConnectionStatus

	// The AWSDomainInformation for the local OpenSearch domain.
	LocalDomainInfo *types.DomainInformationContainer

	// The AWSDomainInformation for the remote OpenSearch domain.
	RemoteDomainInfo *types.DomainInformationContainer

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

The result of a CreateOutboundConnection request. Contains the details about the newly created cross-cluster connection.

type CreatePackageInput 

type CreatePackageInput struct {

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

	// The Amazon S3 location from which to import 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 the CreatePackage operation.

type CreatePackageOutput 

type CreatePackageOutput struct {

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

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

Container for the response returned by the CreatePackage operation.

type DeleteDomainInput 

type DeleteDomainInput struct {

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

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

type DeleteDomainOutput 

type DeleteDomainOutput struct {

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

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

The result of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

type DeleteInboundConnectionInput 

type DeleteInboundConnectionInput struct {

	// The ID of the inbound connection to permanently delete.
	//
	// This member is required.
	ConnectionId *string
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteInboundConnection operation.

type DeleteInboundConnectionOutput 

type DeleteInboundConnectionOutput struct {

	// The InboundConnection of the deleted inbound connection.
	Connection *types.InboundConnection

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

The result of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.

type DeleteOutboundConnectionInput 

type DeleteOutboundConnectionInput struct {

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

Container for the parameters to the DeleteOutboundConnection operation.

type DeleteOutboundConnectionOutput 

type DeleteOutboundConnectionOutput struct {

	// The OutboundConnection of the deleted outbound connection.
	Connection *types.OutboundConnection

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

The result of a DeleteOutboundConnection operation. Contains details about the deleted outbound connection.

type DeletePackageInput 

type DeletePackageInput struct {

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

Container for the request parameters to the 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 the response parameters to the DeletePackage operation.

type DescribeDomainAutoTunesAPIClient 

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

DescribeDomainAutoTunesAPIClient is a client that implements the DescribeDomainAutoTunes operation.

type DescribeDomainAutoTunesInput 

type DescribeDomainAutoTunesInput struct {

	// 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.
	// Used for pagination.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainAutoTunes operation.

type DescribeDomainAutoTunesOutput 

type DescribeDomainAutoTunesOutput struct {

	// The list of setting adjustments that Auto-Tune has made to the domain. See
	// Auto-Tune for Amazon OpenSearch Service
	// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
	// for more information.
	AutoTunes []types.AutoTune

	// 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 a DescribeDomainAutoTunes request. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.

type DescribeDomainAutoTunesPaginator 

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

DescribeDomainAutoTunesPaginator is a paginator for DescribeDomainAutoTunes

func NewDescribeDomainAutoTunesPaginator 

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

NewDescribeDomainAutoTunesPaginator returns a new DescribeDomainAutoTunesPaginator

func (*DescribeDomainAutoTunesPaginator) HasMorePages 

func (p *DescribeDomainAutoTunesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeDomainAutoTunesPaginator) NextPage 

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

NextPage retrieves the next DescribeDomainAutoTunes page.

type DescribeDomainAutoTunesPaginatorOptions 

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.8.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.8.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 DescribeDomainConfigInput 

type DescribeDomainConfigInput struct {

	// The domain you want to get information about.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainConfig operation. Specifies the domain name for which you want configuration information.

type DescribeDomainConfigOutput 

type DescribeDomainConfigOutput struct {

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

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

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

type DescribeDomainInput 

type DescribeDomainInput struct {

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

Container for the parameters to the DescribeDomain operation.

type DescribeDomainOutput 

type DescribeDomainOutput struct {

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

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

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

type DescribeDomainsInput 

type DescribeDomainsInput struct {

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

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

type DescribeDomainsOutput 

type DescribeDomainsOutput struct {

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

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

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

type DescribeInboundConnectionsAPIClient 

type DescribeInboundConnectionsAPIClient interface {
	DescribeInboundConnections(context.Context, *DescribeInboundConnectionsInput, ...func(*Options)) (*DescribeInboundConnectionsOutput, error)
}

DescribeInboundConnectionsAPIClient is a client that implements the DescribeInboundConnections operation.

type DescribeInboundConnectionsInput 

type DescribeInboundConnectionsInput struct {

	// A list of filters used to match properties for inbound cross-cluster
	// connections. Available Filter values are:
	//
	// * connection-id
	//
	// *
	// local-domain-info.domain-name
	//
	// * local-domain-info.owner-id
	//
	// *
	// local-domain-info.region
	//
	// * remote-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

	// 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
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeInboundConnections operation.

type DescribeInboundConnectionsOutput 

type DescribeInboundConnectionsOutput struct {

	// A list of InboundConnection matching the specified filter criteria.
	Connections []types.InboundConnection

	// 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 DescribeInboundConnections request. Contains a list of connections matching the filter criteria.

type DescribeInboundConnectionsPaginator 

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

DescribeInboundConnectionsPaginator is a paginator for DescribeInboundConnections

func NewDescribeInboundConnectionsPaginator 

func NewDescribeInboundConnectionsPaginator(client DescribeInboundConnectionsAPIClient, params *DescribeInboundConnectionsInput, optFns ...func(*DescribeInboundConnectionsPaginatorOptions)) *DescribeInboundConnectionsPaginator

NewDescribeInboundConnectionsPaginator returns a new DescribeInboundConnectionsPaginator

func (*DescribeInboundConnectionsPaginator) HasMorePages 

func (p *DescribeInboundConnectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeInboundConnectionsPaginator) NextPage 

func (p *DescribeInboundConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInboundConnectionsOutput, error)

NextPage retrieves the next DescribeInboundConnections page.

type DescribeInboundConnectionsPaginatorOptions 

type DescribeInboundConnectionsPaginatorOptions 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
}

DescribeInboundConnectionsPaginatorOptions is the paginator options for DescribeInboundConnections

type DescribeInstanceTypeLimitsInput 

type DescribeInstanceTypeLimitsInput struct {

	// Version of OpenSearch for which Limits are needed.
	//
	// This member is required.
	EngineVersion *string

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

	// The name of the domain you want to modify. Only include this value if you're
	// querying OpenSearch Limits for an existing domain.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeInstanceTypeLimits operation.

type DescribeInstanceTypeLimitsOutput 

type DescribeInstanceTypeLimitsOutput struct {

	// The role of a given instance and all applicable limits. The role performed by a
	// given OpenSearch instance can be one of the following:
	//
	// * data: If the given
	// InstanceType is used as a data node
	//
	// * master: If the given InstanceType is used
	// as a master node
	//
	// * ultra_warm: If the given InstanceType is used as a 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 the DescribeInstanceTypeLimits operation.

type DescribeOutboundConnectionsAPIClient 

type DescribeOutboundConnectionsAPIClient interface {
	DescribeOutboundConnections(context.Context, *DescribeOutboundConnectionsInput, ...func(*Options)) (*DescribeOutboundConnectionsOutput, error)
}

DescribeOutboundConnectionsAPIClient is a client that implements the DescribeOutboundConnections operation.

type DescribeOutboundConnectionsInput 

type DescribeOutboundConnectionsInput struct {

	// A list of filters used to match properties for outbound cross-cluster
	// connections. Available Filter names for this operation are:
	//
	// * connection-id
	//
	// *
	// remote-domain-info.domain-name
	//
	// * remote-domain-info.owner-id
	//
	// *
	// remote-domain-info.region
	//
	// * local-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
	// parameter. Used for pagination.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeOutboundConnections operation.

type DescribeOutboundConnectionsOutput 

type DescribeOutboundConnectionsOutput struct {

	// A list of OutboundConnection matching the specified filter criteria.
	Connections []types.OutboundConnection

	// 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 DescribeOutboundConnections request. Contains the list of connections matching the filter criteria.

type DescribeOutboundConnectionsPaginator 

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

DescribeOutboundConnectionsPaginator is a paginator for DescribeOutboundConnections

func NewDescribeOutboundConnectionsPaginator 

func NewDescribeOutboundConnectionsPaginator(client DescribeOutboundConnectionsAPIClient, params *DescribeOutboundConnectionsInput, optFns ...func(*DescribeOutboundConnectionsPaginatorOptions)) *DescribeOutboundConnectionsPaginator

NewDescribeOutboundConnectionsPaginator returns a new DescribeOutboundConnectionsPaginator

func (*DescribeOutboundConnectionsPaginator) HasMorePages 

func (p *DescribeOutboundConnectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeOutboundConnectionsPaginator) NextPage 

func (p *DescribeOutboundConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOutboundConnectionsOutput, error)

NextPage retrieves the next DescribeOutboundConnections page.

type DescribeOutboundConnectionsPaginatorOptions 

type DescribeOutboundConnectionsPaginatorOptions 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
}

DescribeOutboundConnectionsPaginatorOptions is the paginator options for DescribeOutboundConnections

type DescribePackagesAPIClient 

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 the request parameters to the 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 the response returned by the DescribePackages operation.

type DescribePackagesPaginator 

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

DescribePackagesPaginator is a paginator for DescribePackages

func NewDescribePackagesPaginator 

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

NewDescribePackagesPaginator returns a new DescribePackagesPaginator

func (*DescribePackagesPaginator) HasMorePages 

func (p *DescribePackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribePackagesPaginator) NextPage 

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

NextPage retrieves the next DescribePackages page.

type DescribePackagesPaginatorOptions 

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 DescribeReservedInstanceOfferingsAPIClient 

type DescribeReservedInstanceOfferingsAPIClient interface {
	DescribeReservedInstanceOfferings(context.Context, *DescribeReservedInstanceOfferingsInput, ...func(*Options)) (*DescribeReservedInstanceOfferingsOutput, error)
}

DescribeReservedInstanceOfferingsAPIClient is a client that implements the DescribeReservedInstanceOfferings operation.

type DescribeReservedInstanceOfferingsInput 

type DescribeReservedInstanceOfferingsInput struct {

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

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

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

Container for parameters to DescribeReservedInstanceOfferings

type DescribeReservedInstanceOfferingsOutput 

type DescribeReservedInstanceOfferingsOutput struct {

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

	// List of reserved OpenSearch instance offerings
	ReservedInstanceOfferings []types.ReservedInstanceOffering

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

Container for results from DescribeReservedInstanceOfferings

type DescribeReservedInstanceOfferingsPaginator 

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

DescribeReservedInstanceOfferingsPaginator is a paginator for DescribeReservedInstanceOfferings

func NewDescribeReservedInstanceOfferingsPaginator 

func NewDescribeReservedInstanceOfferingsPaginator(client DescribeReservedInstanceOfferingsAPIClient, params *DescribeReservedInstanceOfferingsInput, optFns ...func(*DescribeReservedInstanceOfferingsPaginatorOptions)) *DescribeReservedInstanceOfferingsPaginator

NewDescribeReservedInstanceOfferingsPaginator returns a new DescribeReservedInstanceOfferingsPaginator

func (*DescribeReservedInstanceOfferingsPaginator) HasMorePages 

func (p *DescribeReservedInstanceOfferingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeReservedInstanceOfferingsPaginator) NextPage 

func (p *DescribeReservedInstanceOfferingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeReservedInstanceOfferingsOutput, error)

NextPage retrieves the next DescribeReservedInstanceOfferings page.

type DescribeReservedInstanceOfferingsPaginatorOptions 

type DescribeReservedInstanceOfferingsPaginatorOptions 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
}

DescribeReservedInstanceOfferingsPaginatorOptions is the paginator options for DescribeReservedInstanceOfferings

type DescribeReservedInstancesAPIClient 

type DescribeReservedInstancesAPIClient interface {
	DescribeReservedInstances(context.Context, *DescribeReservedInstancesInput, ...func(*Options)) (*DescribeReservedInstancesOutput, error)
}

DescribeReservedInstancesAPIClient is a client that implements the DescribeReservedInstances operation.

type DescribeReservedInstancesInput 

type DescribeReservedInstancesInput struct {

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

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

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

Container for parameters to DescribeReservedInstances

type DescribeReservedInstancesOutput 

type DescribeReservedInstancesOutput struct {

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

	// List of reserved OpenSearch instances.
	ReservedInstances []types.ReservedInstance

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

Container for results from DescribeReservedInstances

type DescribeReservedInstancesPaginator 

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

DescribeReservedInstancesPaginator is a paginator for DescribeReservedInstances

func NewDescribeReservedInstancesPaginator 

func NewDescribeReservedInstancesPaginator(client DescribeReservedInstancesAPIClient, params *DescribeReservedInstancesInput, optFns ...func(*DescribeReservedInstancesPaginatorOptions)) *DescribeReservedInstancesPaginator

NewDescribeReservedInstancesPaginator returns a new DescribeReservedInstancesPaginator

func (*DescribeReservedInstancesPaginator) HasMorePages 

func (p *DescribeReservedInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeReservedInstancesPaginator) NextPage 

func (p *DescribeReservedInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeReservedInstancesOutput, error)

NextPage retrieves the next DescribeReservedInstances page.

type DescribeReservedInstancesPaginatorOptions 

type DescribeReservedInstancesPaginatorOptions 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
}

DescribeReservedInstancesPaginatorOptions is the paginator options for DescribeReservedInstances

type DissociatePackageInput 

type DissociatePackageInput struct {

	// The name of the domain to associate the package with.
	//
	// This member is required.
	DomainName *string

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

Container for the request parameters to the 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 the response returned by DissociatePackage operation.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

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 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetCompatibleVersionsInput 

type GetCompatibleVersionsInput struct {

	// The name of an 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 the request parameters to GetCompatibleVersions operation.

type GetCompatibleVersionsOutput 

type GetCompatibleVersionsOutput struct {

	// A map of compatible OpenSearch versions returned as part of the
	// GetCompatibleVersions operation.
	CompatibleVersions []types.CompatibleVersionsMap

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

Container for the response returned by the GetCompatibleVersions operation.

type GetPackageVersionHistoryAPIClient 

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

GetPackageVersionHistoryAPIClient is a client that implements the GetPackageVersionHistory operation.

type GetPackageVersionHistoryInput 

type GetPackageVersionHistoryInput struct {

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

	// Limits results to a maximum number of package 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 the request parameters to the GetPackageVersionHistory operation.

type GetPackageVersionHistoryOutput 

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 

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

GetPackageVersionHistoryPaginator is a paginator for GetPackageVersionHistory

func NewGetPackageVersionHistoryPaginator 

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

NewGetPackageVersionHistoryPaginator returns a new GetPackageVersionHistoryPaginator

func (*GetPackageVersionHistoryPaginator) HasMorePages 

func (p *GetPackageVersionHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetPackageVersionHistoryPaginator) NextPage 

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

NextPage retrieves the next GetPackageVersionHistory page.

type GetPackageVersionHistoryPaginatorOptions 

type GetPackageVersionHistoryPaginatorOptions struct {
	// Limits results to a maximum number of package 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 

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 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 accept the NextToken input to return the next page of results and
	// provide a NextToken output in the response, which you can use to retrieve more
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the request parameters to the 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 the
	// GetUpgradeHistoryResponse object.
	UpgradeHistories []types.UpgradeHistory

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

Container for the response returned by the GetUpgradeHistory operation.

type GetUpgradeHistoryPaginator 

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

GetUpgradeHistoryPaginator is a paginator for GetUpgradeHistory

func NewGetUpgradeHistoryPaginator 

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

NewGetUpgradeHistoryPaginator returns a new GetUpgradeHistoryPaginator

func (*GetUpgradeHistoryPaginator) HasMorePages 

func (p *GetUpgradeHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetUpgradeHistoryPaginator) NextPage 

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

NextPage retrieves the next GetUpgradeHistory page.

type GetUpgradeHistoryPaginatorOptions 

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 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 the request parameters to the GetUpgradeStatus operation.

type GetUpgradeStatusOutput 

type GetUpgradeStatusOutput struct {

	// One of four statuses an upgrade have, 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 briefly describes the update.
	UpgradeName *string

	// One of three steps an upgrade or upgrade eligibility check goes through:
	//
	// *
	// PreUpgradeCheck
	//
	// * Snapshot
	//
	// * Upgrade
	UpgradeStep types.UpgradeStep

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

Container for the response returned by the 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 

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 associated domains.
	//
	// This member is required.
	PackageID *string

	// Limits the 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 the request parameters to the 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 the response parameters to the ListDomainsForPackage operation.

type ListDomainsForPackagePaginator 

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

ListDomainsForPackagePaginator is a paginator for ListDomainsForPackage

func NewListDomainsForPackagePaginator 

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

NewListDomainsForPackagePaginator returns a new ListDomainsForPackagePaginator

func (*ListDomainsForPackagePaginator) HasMorePages 

func (p *ListDomainsForPackagePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainsForPackagePaginator) NextPage 

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

NextPage retrieves the next ListDomainsForPackage page.

type ListDomainsForPackagePaginatorOptions 

type ListDomainsForPackagePaginatorOptions struct {
	// Limits the 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 ListInstanceTypeDetailsAPIClient 

type ListInstanceTypeDetailsAPIClient interface {
	ListInstanceTypeDetails(context.Context, *ListInstanceTypeDetailsInput, ...func(*Options)) (*ListInstanceTypeDetailsOutput, error)
}

ListInstanceTypeDetailsAPIClient is a client that implements the ListInstanceTypeDetails operation.

type ListInstanceTypeDetailsInput 

type ListInstanceTypeDetailsInput struct {

	// This member is required.
	EngineVersion *string

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

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

	// Paginated APIs accept the NextToken input to return the next page of results and
	// provide a NextToken output in the response, which you can use to retrieve more
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInstanceTypeDetailsOutput 

type ListInstanceTypeDetailsOutput struct {
	InstanceTypeDetails []types.InstanceTypeDetails

	// Paginated APIs accept the NextToken input to return the next page of results and
	// provide a NextToken output in the response, which you can use to retrieve more
	// results.
	NextToken *string

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

type ListInstanceTypeDetailsPaginator 

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

ListInstanceTypeDetailsPaginator is a paginator for ListInstanceTypeDetails

func NewListInstanceTypeDetailsPaginator 

func NewListInstanceTypeDetailsPaginator(client ListInstanceTypeDetailsAPIClient, params *ListInstanceTypeDetailsInput, optFns ...func(*ListInstanceTypeDetailsPaginatorOptions)) *ListInstanceTypeDetailsPaginator

NewListInstanceTypeDetailsPaginator returns a new ListInstanceTypeDetailsPaginator

func (*ListInstanceTypeDetailsPaginator) HasMorePages 

func (p *ListInstanceTypeDetailsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstanceTypeDetailsPaginator) NextPage 

func (p *ListInstanceTypeDetailsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstanceTypeDetailsOutput, error)

NextPage retrieves the next ListInstanceTypeDetails page.

type ListInstanceTypeDetailsPaginatorOptions 

type ListInstanceTypeDetailsPaginatorOptions 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
}

ListInstanceTypeDetailsPaginatorOptions is the paginator options for ListInstanceTypeDetails

type ListPackagesForDomainAPIClient 

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 the request parameters to the ListPackagesForDomain operation.

type ListPackagesForDomainOutput 

type ListPackagesForDomainOutput struct {

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

	// Pagination token to supply 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 the response parameters to the ListPackagesForDomain operation.

type ListPackagesForDomainPaginator 

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

ListPackagesForDomainPaginator is a paginator for ListPackagesForDomain

func NewListPackagesForDomainPaginator 

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

NewListPackagesForDomainPaginator returns a new ListPackagesForDomainPaginator

func (*ListPackagesForDomainPaginator) HasMorePages 

func (p *ListPackagesForDomainPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackagesForDomainPaginator) NextPage 

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

NextPage retrieves the next ListPackagesForDomain page.

type ListPackagesForDomainPaginatorOptions 

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 of the domain that the tags you want to view are attached to.
	//
	// This member is required.
	ARN *string
	// contains filtered or unexported fields
}

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

type ListTagsOutput 

type ListTagsOutput struct {

	// List of Tag for the requested 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 domains.

type ListVersionsAPIClient 

type ListVersionsAPIClient interface {
	ListVersions(context.Context, *ListVersionsInput, ...func(*Options)) (*ListVersionsOutput, error)
}

ListVersionsAPIClient is a client that implements the ListVersions operation.

type ListVersionsInput 

type ListVersionsInput struct {

	// Set this value to limit the number of results returned. Value must be greater
	// than 10 or it won't be honored.
	MaxResults int32

	// Paginated APIs accept the NextToken input to return the next page of results and
	// provide a NextToken output in the response, which you can use to retrieve more
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the ListVersions 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, there are no more results to retrieve.

type ListVersionsOutput 

type ListVersionsOutput struct {

	// Paginated APIs accept the NextToken input to return the next page of results and
	// provide a NextToken output in the response, which you can use to retrieve more
	// results.
	NextToken *string

	// List of supported OpenSearch versions.
	Versions []string

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

Container for the parameters for response received from the ListVersions operation.

type ListVersionsPaginator 

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

ListVersionsPaginator is a paginator for ListVersions

func NewListVersionsPaginator 

func NewListVersionsPaginator(client ListVersionsAPIClient, params *ListVersionsInput, optFns ...func(*ListVersionsPaginatorOptions)) *ListVersionsPaginator

NewListVersionsPaginator returns a new ListVersionsPaginator

func (*ListVersionsPaginator) HasMorePages 

func (p *ListVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVersionsPaginator) NextPage 

func (p *ListVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVersionsOutput, error)

NextPage retrieves the next ListVersions page.

type ListVersionsPaginatorOptions 

type ListVersionsPaginatorOptions struct {
	// Set this value to limit the number of results returned. Value must be greater
	// than 10 or it won't 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
}

ListVersionsPaginatorOptions is the paginator options for ListVersions

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

	// 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.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// 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. 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. 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 HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

type PurchaseReservedInstanceOfferingInput 

type PurchaseReservedInstanceOfferingInput struct {

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

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

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

Container for parameters to PurchaseReservedInstanceOffering

type PurchaseReservedInstanceOfferingOutput 

type PurchaseReservedInstanceOfferingOutput struct {

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

	// Details of the reserved OpenSearch instance which was purchased.
	ReservedInstanceId *string

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

Represents the output of a PurchaseReservedInstanceOffering operation.

type RejectInboundConnectionInput 

type RejectInboundConnectionInput struct {

	// The ID of the inbound connection to reject.
	//
	// This member is required.
	ConnectionId *string
	// contains filtered or unexported fields
}

Container for the parameters to the RejectInboundConnection operation.

type RejectInboundConnectionOutput 

type RejectInboundConnectionOutput struct {

	// The InboundConnection of the rejected inbound connection.
	Connection *types.InboundConnection

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

The result of a RejectInboundConnection operation. Contains details about the rejected inbound connection.

type RemoveTagsInput 

type RemoveTagsInput struct {

	// The ARN of the domain from which you want to delete the specified tags.
	//
	// This member is required.
	ARN *string

	// The TagKey list you want to remove from the 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 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 StartServiceSoftwareUpdateInput 

type StartServiceSoftwareUpdateInput 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 StartServiceSoftwareUpdate operation. Specifies the name of the domain to schedule a service software update for.

type StartServiceSoftwareUpdateOutput 

type StartServiceSoftwareUpdateOutput struct {

	// The current status of the OpenSearch 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 StartServiceSoftwareUpdate operation. Contains the status of the update.

type UpdateDomainConfigInput 

type UpdateDomainConfigInput struct {

	// The name of the domain you're 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 Advanced options
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options)
	// for more information.
	AdvancedOptions map[string]string

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

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

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

	// Options to specify the Cognito user and identity pools for OpenSearch Dashboards
	// authentication. For more information, see Configuring Amazon Cognito
	// authentication for OpenSearch Dashboards
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/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 UpdateDomain request should
	// return the results of validation checks (DryRunResults) without actually
	// applying the change.
	DryRun *bool

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

	// Specifies encryption of data at rest options.
	EncryptionAtRestOptions *types.EncryptionAtRestOptions

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

	// Specifies node-to-node encryption options.
	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 the VPC endpoint. For
	// more information, see Launching your Amazon OpenSearch Service domains using a
	// VPC
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
	VPCOptions *types.VPCOptions
	// contains filtered or unexported fields
}

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

type UpdateDomainConfigOutput 

type UpdateDomainConfigOutput struct {

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

	// 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 UpdateDomain request. Contains the status of the domain being updated.

type UpdatePackageInput 

type UpdatePackageInput struct {

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

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

	// A commit message for the new version which is shown as part of
	// GetPackageVersionHistoryResponse.
	CommitMessage *string

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

Container for request parameters to the UpdatePackage operation.

type UpdatePackageOutput 

type UpdatePackageOutput struct {

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

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

Container for the response returned by the UpdatePackage operation.

type UpgradeDomainInput 

type UpgradeDomainInput struct {

	// The name of an 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 OpenSearch you intend to upgrade the domain to.
	//
	// This member is required.
	TargetVersion *string

	// Exposes select native OpenSearch configuration values from opensearch.yml.
	// Currently, the following advanced options are available:
	//
	// * 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 Advanced
	// cluster parameters
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options)
	// for more information.
	//
	// * Option to specify the percentage of heap space
	// allocated to field data. By default, this setting is unbounded.
	//
	// For more
	// information, see  Advanced cluster parameters
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).
	AdvancedOptions map[string]string

	// When true, indicates that an upgrade eligibility check needs to be performed.
	// Does not actually perform the upgrade.
	PerformCheckOnly *bool
	// contains filtered or unexported fields
}

Container for the request parameters to UpgradeDomain operation.

type UpgradeDomainOutput 

type UpgradeDomainOutput struct {

	// Exposes select native OpenSearch configuration values from opensearch.yml.
	// Currently, the following advanced options are available:
	//
	// * 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 Advanced
	// cluster parameters
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options)
	// for more information.
	//
	// * Option to specify the percentage of heap space
	// allocated to field data. By default, this setting is unbounded.
	//
	// For more
	// information, see  Advanced cluster parameters
	// (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).
	AdvancedOptions map[string]string

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

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

	// When true, indicates that an upgrade eligibility check needs to be performed.
	// Does not actually perform the upgrade.
	PerformCheckOnly *bool

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

	UpgradeId *string

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

Container for response returned by UpgradeDomain 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.