opensearch

package module
v1.45.1 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 46 Imported by: 19

Documentation

Overview

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

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. 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 Amazon Web Services service endpoints.

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.25.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.25.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 AcceptInboundConnectionInput 

type AcceptInboundConnectionInput struct {

	// The ID of the inbound connection 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 {

	// Information about the accepted inbound connection.
	Connection *types.InboundConnection

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

Contains details about the accepted inbound connection.

type AddDataSourceInput added in v1.26.0 

type AddDataSourceInput struct {

	// The type of data source.
	//
	// This member is required.
	DataSourceType types.DataSourceType

	// The name of the domain to add the data source to.
	//
	// This member is required.
	DomainName *string

	// A name for the data source.
	//
	// This member is required.
	Name *string

	// A description of the data source.
	Description *string
	// contains filtered or unexported fields
}

Container for the parameters to the AddDataSource operation.

type AddDataSourceOutput added in v1.26.0 

type AddDataSourceOutput struct {

	// A message associated with creation of the data source.
	Message *string

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

The result of an AddDataSource operation.

type AddDirectQueryDataSourceInput added in v1.45.0 

type AddDirectQueryDataSourceInput struct {

	//  A unique, user-defined label to identify the data source within your
	// OpenSearch Service environment.
	//
	// This member is required.
	DataSourceName *string

	//  The supported Amazon Web Services service that you want to use as the source
	// for direct queries in OpenSearch Service.
	//
	// This member is required.
	DataSourceType types.DirectQueryDataSourceType

	//  A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
	// associated with the direct query data source.
	//
	// This member is required.
	OpenSearchArns []string

	//  An optional text field for providing additional context and details about the
	// data source.
	Description *string

	// A list of tags attached to a domain.
	TagList []types.Tag
	// contains filtered or unexported fields
}

type AddDirectQueryDataSourceOutput added in v1.45.0 

type AddDirectQueryDataSourceOutput struct {

	//  The unique, system-generated identifier that represents the data source.
	DataSourceArn *string

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

type AddTagsInput 

type AddTagsInput struct {

	// Amazon Resource Name (ARN) for the OpenSearch Service domain, data source, or
	// application to which you want to attach resource tags.
	//
	// This member is required.
	ARN *string

	// List of resource tags.
	//
	// 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, data source, or application.

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

	// The configuration for associating a package with an Amazon OpenSearch Service
	// domain.
	AssociationConfiguration *types.PackageAssociationConfiguration

	// A list of package IDs that must be associated with the domain before the
	// package specified in the request can be associated.
	PrerequisitePackageIDList []string
	// contains filtered or unexported fields
}

Container for the request parameters to the AssociatePackage operation.

type AssociatePackageOutput 

type AssociatePackageOutput struct {

	// Information about a package that is associated with a domain.
	DomainPackageDetails *types.DomainPackageDetails

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

Container for the response returned by the AssociatePackage operation.

type AssociatePackagesInput added in v1.44.0 

type AssociatePackagesInput struct {

	// The name of an OpenSearch Service domain. Domain names are unique across the
	// domains owned by an account within an Amazon Web Services Region.
	//
	// This member is required.
	DomainName *string

	// A list of packages and their prerequisites to be associated with a domain.
	//
	// This member is required.
	PackageList []types.PackageDetailsForAssociation
	// contains filtered or unexported fields
}

type AssociatePackagesOutput added in v1.44.0 

type AssociatePackagesOutput struct {

	// List of information about packages that are associated with a domain.
	DomainPackageDetailsList []types.DomainPackageDetails

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

type AuthResolverParameters added in v1.25.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.25.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.11.0 

type AuthorizeVpcEndpointAccessInput struct {

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

	// The Amazon Web Services account ID to grant access to.
	Account *string

	// The Amazon Web Services service SP to grant access to.
	Service types.AWSServicePrincipal
	// contains filtered or unexported fields
}

type AuthorizeVpcEndpointAccessOutput added in v1.11.0 

type AuthorizeVpcEndpointAccessOutput struct {

	// Information about the Amazon Web Services 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
}

type CancelDomainConfigChangeInput added in v1.29.0 

type CancelDomainConfigChangeInput struct {

	// The name of an OpenSearch Service domain. Domain names are unique across the
	// domains owned by an account within an Amazon Web Services Region.
	//
	// 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
}

type CancelDomainConfigChangeOutput added in v1.29.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
}

type CancelServiceSoftwareUpdateInput 

type CancelServiceSoftwareUpdateInput struct {

	// Name of the OpenSearch Service domain that you want to cancel the service
	// software update on.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the request parameters to cancel a service software update.

type CancelServiceSoftwareUpdateOutput 

type CancelServiceSoftwareUpdateOutput struct {

	// Container for the state of your domain relative to the latest service software.
	ServiceSoftwareOptions *types.ServiceSoftwareOptions

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

Container for the response to 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 destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

func (*Client) AddDataSource added in v1.26.0 

func (c *Client) AddDataSource(ctx context.Context, params *AddDataSourceInput, optFns ...func(*Options)) (*AddDataSourceOutput, error)

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

func (*Client) AddDirectQueryDataSource added in v1.45.0 

func (c *Client) AddDirectQueryDataSource(ctx context.Context, params *AddDirectQueryDataSourceInput, optFns ...func(*Options)) (*AddDirectQueryDataSourceOutput, error)
Adds a new data source in Amazon OpenSearch Service so that you can perform

direct queries on external data.

func (*Client) AddTags 

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

Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application.

Tags are a set of case-sensitive key-value pairs. A domain, data source, or application can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service resources.

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. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) AssociatePackages added in v1.44.0 

func (c *Client) AssociatePackages(ctx context.Context, params *AssociatePackagesInput, optFns ...func(*Options)) (*AssociatePackagesOutput, error)

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

func (*Client) AuthorizeVpcEndpointAccess added in v1.11.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.29.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) 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 domain's UpdateStatus is PENDING_UPDATE . For more information, see Service software updates in Amazon OpenSearch Service.

func (*Client) CreateApplication added in v1.43.0 

func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)

Creates an OpenSearch Application.

func (*Client) CreateDomain 

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

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

func (*Client) CreateOutboundConnection 

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

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

func (*Client) CreatePackage 

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

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) CreateVpcEndpoint added in v1.11.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) DeleteApplication added in v1.43.0 

func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)

Deletes an existing OpenSearch Application.

func (*Client) DeleteDataSource added in v1.26.0 

func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

func (*Client) DeleteDirectQueryDataSource added in v1.45.0 

func (c *Client) DeleteDirectQueryDataSource(ctx context.Context, params *DeleteDirectQueryDataSourceInput, optFns ...func(*Options)) (*DeleteDirectQueryDataSourceOutput, error)
Deletes a previously configured direct query data source from Amazon

OpenSearch Service.

func (*Client) DeleteDomain 

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

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

func (*Client) DeleteInboundConnection 

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

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

func (*Client) DeleteOutboundConnection 

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

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

func (*Client) DeletePackage 

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

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) DeleteVpcEndpoint added in v1.11.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) DescribeDomain 

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

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

func (*Client) DescribeDomainAutoTunes 

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

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

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 an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

func (*Client) DescribeDomainConfig 

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

Returns the configuration of an Amazon OpenSearch Service domain.

func (*Client) DescribeDomainHealth added in v1.16.0 

func (c *Client) DescribeDomainHealth(ctx context.Context, params *DescribeDomainHealthInput, optFns ...func(*Options)) (*DescribeDomainHealthOutput, error)

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

func (*Client) DescribeDomainNodes added in v1.17.0 

func (c *Client) DescribeDomainNodes(ctx context.Context, params *DescribeDomainNodesInput, optFns ...func(*Options)) (*DescribeDomainNodesOutput, error)

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

func (*Client) DescribeDomains 

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

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

func (*Client) DescribeDryRunProgress added in v1.13.0 

func (c *Client) DescribeDryRunProgress(ctx context.Context, params *DescribeDryRunProgressInput, optFns ...func(*Options)) (*DescribeDryRunProgressOutput, error)

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

func (*Client) DescribeInboundConnections 

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

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

func (*Client) DescribeInstanceTypeLimits 

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

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

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 (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

func (*Client) DescribePackages 

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

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) DescribeReservedInstanceOfferings 

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

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

func (*Client) DescribeReservedInstances 

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

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

func (*Client) DescribeVpcEndpoints added in v1.11.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)

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) DissociatePackages added in v1.44.0 

func (c *Client) DissociatePackages(ctx context.Context, params *DissociatePackagesInput, optFns ...func(*Options)) (*DissociatePackagesOutput, error)

Dissociates multiple packages from a domain simulatneously.

func (*Client) GetApplication added in v1.43.0 

func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)

Check the configuration and status of an existing OpenSearch Application.

func (*Client) GetCompatibleVersions 

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

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

func (*Client) GetDataSource added in v1.26.0 

func (c *Client) GetDataSource(ctx context.Context, params *GetDataSourceInput, optFns ...func(*Options)) (*GetDataSourceOutput, error)

Retrieves information about a direct query data source.

func (*Client) GetDirectQueryDataSource added in v1.45.0 

func (c *Client) GetDirectQueryDataSource(ctx context.Context, params *GetDirectQueryDataSourceInput, optFns ...func(*Options)) (*GetDirectQueryDataSourceOutput, error)
Returns detailed configuration information for a specific direct query data

source in Amazon OpenSearch Service.

func (*Client) GetDomainMaintenanceStatus added in v1.21.0 

func (c *Client) GetDomainMaintenanceStatus(ctx context.Context, params *GetDomainMaintenanceStatusInput, optFns ...func(*Options)) (*GetDomainMaintenanceStatusOutput, error)

The status of the maintenance action.

func (*Client) GetPackageVersionHistory 

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

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

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 an Amazon OpenSearch Service domain.

func (*Client) GetUpgradeStatus 

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

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

func (*Client) ListApplications added in v1.43.0 

func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)

List all OpenSearch Applications under your account.

func (*Client) ListDataSources added in v1.26.0 

func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

func (*Client) ListDirectQueryDataSources added in v1.45.0 

func (c *Client) ListDirectQueryDataSources(ctx context.Context, params *ListDirectQueryDataSourcesInput, optFns ...func(*Options)) (*ListDirectQueryDataSourcesOutput, error)
Lists an inventory of all the direct query data sources that you have

configured within Amazon OpenSearch Service.

func (*Client) ListDomainMaintenances added in v1.21.0 

func (c *Client) ListDomainMaintenances(ctx context.Context, params *ListDomainMaintenancesInput, optFns ...func(*Options)) (*ListDomainMaintenancesOutput, error)

A list of maintenance actions for the domain.

func (*Client) ListDomainNames 

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

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

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 a given package. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) ListInstanceTypeDetails 

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

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

func (*Client) ListPackagesForDomain 

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

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) ListScheduledActions added in v1.15.0 

func (c *Client) ListScheduledActions(ctx context.Context, params *ListScheduledActionsInput, optFns ...func(*Options)) (*ListScheduledActionsOutput, error)

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updatesor blue/green Auto-Tune enhancements.

func (*Client) ListTags 

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

Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources.

func (*Client) ListVersions 

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

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

func (*Client) ListVpcEndpointAccess added in v1.11.0 

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

Retrieves information about each Amazon Web Services 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.11.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 Amazon Web Services account and Region.

func (*Client) ListVpcEndpointsForDomain added in v1.11.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.26.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) PurchaseReservedInstanceOffering 

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

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

func (*Client) RejectInboundConnection 

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

Allows the remote Amazon OpenSearch Service 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 an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources.

func (*Client) RevokeVpcEndpointAccess added in v1.11.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) StartDomainMaintenance added in v1.21.0 

func (c *Client) StartDomainMaintenance(ctx context.Context, params *StartDomainMaintenanceInput, optFns ...func(*Options)) (*StartDomainMaintenanceOutput, error)

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

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. For more information, see Service software updates in Amazon OpenSearch Service.

func (*Client) UpdateApplication added in v1.43.0 

func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)

Update the OpenSearch Application.

func (*Client) UpdateDataSource added in v1.26.0 

func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

func (*Client) UpdateDirectQueryDataSource added in v1.45.0 

func (c *Client) UpdateDirectQueryDataSource(ctx context.Context, params *UpdateDirectQueryDataSourceInput, optFns ...func(*Options)) (*UpdateDirectQueryDataSourceOutput, error)
Updates the configuration or properties of an existing direct query data

source in Amazon OpenSearch Service.

func (*Client) UpdateDomainConfig 

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

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

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. For more information, see Custom packages for Amazon OpenSearch Service.

func (*Client) UpdatePackageScope added in v1.44.0 

func (c *Client) UpdatePackageScope(ctx context.Context, params *UpdatePackageScopeInput, optFns ...func(*Options)) (*UpdatePackageScopeOutput, error)

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

func (*Client) UpdateScheduledAction added in v1.15.0 

func (c *Client) UpdateScheduledAction(ctx context.Context, params *UpdateScheduledActionInput, optFns ...func(*Options)) (*UpdateScheduledActionOutput, error)

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software updateor a blue/green Auto-Tune enhancement.

func (*Client) UpdateVpcEndpoint added in v1.11.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) UpgradeDomain 

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

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

type CreateApplicationInput added in v1.43.0 

type CreateApplicationInput struct {

	// Name of the OpenSearch Appication to create. Application names are unique
	// across the applications owned by an account within an Amazon Web Services
	// Region.
	//
	// This member is required.
	Name *string

	// Configurations of the OpenSearch Application, inlcuding admin configuration.
	AppConfigs []types.AppConfig

	// A unique client idempotency token. It will be auto generated if not provided.
	ClientToken *string

	// Data sources to be associated with the OpenSearch Application.
	DataSources []types.DataSource

	// Settings of IAM Identity Center for the OpenSearch Application.
	IamIdentityCenterOptions *types.IamIdentityCenterOptionsInput

	// A list of tags attached to a domain.
	TagList []types.Tag
	// contains filtered or unexported fields
}

type CreateApplicationOutput added in v1.43.0 

type CreateApplicationOutput struct {

	// Configurations of the OpenSearch Application, inlcuding admin configuration.
	AppConfigs []types.AppConfig

	// The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities] in Using Amazon Web Services
	// Identity and Access Management for more information.
	//
	// [Identifiers for IAM Entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
	Arn *string

	// Timestamp when the OpenSearch Application was created.
	CreatedAt *time.Time

	// Data sources associated with the created OpenSearch Application.
	DataSources []types.DataSource

	// Settings of IAM Identity Center for the created OpenSearch Application.
	IamIdentityCenterOptions *types.IamIdentityCenterOptions

	// Unique identifier for the created OpenSearch Application.
	Id *string

	// Name of the created OpenSearch Application.
	Name *string

	// A list of tags attached to a domain.
	TagList []types.Tag

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

type CreateDomainInput 

type CreateDomainInput struct {

	// Name of the OpenSearch Service domain to create. Domain names are unique across
	// the domains owned by an account within an Amazon Web Services Region.
	//
	// This member is required.
	DomainName *string

	// Options for all machine learning features for the specified domain.
	AIMLOptions *types.AIMLOptionsInput

	// Identity and Access Management (IAM) policy document specifying the access
	// policies for the new domain.
	AccessPolicies *string

	// Key-value pairs to specify advanced configuration options. The following
	// key-value pairs are supported:
	//
	//   - "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of
	//   a string rather than a boolean. Specifies whether explicit references to indexes
	//   are allowed inside the body of HTTP requests. If you want to configure access
	//   policies for domain sub-resources, such as specific indexes and domain APIs, you
	//   must disable this property. Default is true.
	//
	//   - "indices.fielddata.cache.size": "80" - Note the use of a string rather than
	//   a boolean. Specifies the percentage of heap space allocated to field data.
	//   Default is unbounded.
	//
	//   - "indices.query.bool.max_clause_count": "1024" - Note the use of a string
	//   rather than a boolean. Specifies the maximum number of clauses allowed in a
	//   Lucene boolean query. Default is 1,024. Queries with more than the permitted
	//   number of clauses result in a TooManyClauses error.
	//
	//   - "override_main_response_version": "true" | "false" - Note the use of a
	//   string rather than a boolean. Specifies whether the domain reports its version
	//   as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with
	//   it. Default is false when creating a domain and true when upgrading a domain.
	//
	// For more information, see [Advanced cluster parameters].
	//
	// [Advanced cluster parameters]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
	AdvancedOptions map[string]string

	// Options for fine-grained access control.
	AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput

	// Options for Auto-Tune.
	AutoTuneOptions *types.AutoTuneOptionsInput

	// Container for the cluster configuration of a domain.
	ClusterConfig *types.ClusterConfig

	// Key-value pairs to configure Amazon Cognito authentication. For more
	// information, see [Configuring Amazon Cognito authentication for OpenSearch Dashboards].
	//
	// [Configuring Amazon Cognito authentication for OpenSearch Dashboards]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
	CognitoOptions *types.CognitoOptions

	// Additional options for the domain endpoint, such as whether to require HTTPS
	// for all traffic.
	DomainEndpointOptions *types.DomainEndpointOptions

	// Container for the parameters required to enable EBS-based storage for an
	// OpenSearch Service domain.
	EBSOptions *types.EBSOptions

	// Key-value pairs to enable encryption at rest.
	EncryptionAtRestOptions *types.EncryptionAtRestOptions

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

	// Specify either dual stack or IPv4 as your IP address type. Dual stack allows
	// you to share domain resources across IPv4 and IPv6 address types, and is the
	// recommended option. If you set your IP address type to dual stack, you can't
	// change your address type later.
	IPAddressType types.IPAddressType

	// Options for IAM Identity Center Option control for the domain.
	IdentityCenterOptions *types.IdentityCenterOptionsInput

	// Key-value pairs to configure log publishing.
	LogPublishingOptions map[string]types.LogPublishingOption

	// Enables node-to-node encryption.
	NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions

	// Specifies a daily 10-hour time block during which OpenSearch Service can
	// perform configuration changes on the domain, including service software updates
	// and Auto-Tune enhancements that require a blue/green deployment. If no options
	// are specified, the default start time of 10:00 P.M. local time (for the Region
	// that the domain is created in) is used.
	OffPeakWindowOptions *types.OffPeakWindowOptions

	// DEPRECATED. Container for the parameters required to configure automated
	// snapshots of domain indexes.
	SnapshotOptions *types.SnapshotOptions

	// Software update options for the domain.
	SoftwareUpdateOptions *types.SoftwareUpdateOptions

	// List of tags to add to the domain upon creation.
	TagList []types.Tag

	// Container for the values required to configure VPC access domains. If you don't
	// specify these values, OpenSearch Service creates the domain with a public
	// endpoint. For more information, see [Launching your Amazon OpenSearch Service domains using a VPC].
	//
	// [Launching your Amazon OpenSearch Service domains using a VPC]: https://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 domain.

type CreateOutboundConnectionInput 

type CreateOutboundConnectionInput struct {

	// Name of the connection.
	//
	// This member is required.
	ConnectionAlias *string

	// Name and Region of the source (local) domain.
	//
	// This member is required.
	LocalDomainInfo *types.DomainInformationContainer

	// Name and Region of the destination (remote) domain.
	//
	// This member is required.
	RemoteDomainInfo *types.DomainInformationContainer

	// The connection mode.
	ConnectionMode types.ConnectionMode

	// The ConnectionProperties for the outbound connection.
	ConnectionProperties *types.ConnectionProperties
	// contains filtered or unexported fields
}

Container for the parameters to the CreateOutboundConnection operation.

type CreateOutboundConnectionOutput 

type CreateOutboundConnectionOutput struct {

	// Name of the connection.
	ConnectionAlias *string

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

	// The connection mode.
	ConnectionMode types.ConnectionMode

	// The ConnectionProperties for the newly created connection.
	ConnectionProperties *types.ConnectionProperties

	// The status of the connection.
	ConnectionStatus *types.OutboundConnectionStatus

	// Information about the source (local) domain.
	LocalDomainInfo *types.DomainInformationContainer

	// Information about the destination (remote) 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 details about the newly created cross-cluster connection.

type CreatePackageInput 

type CreatePackageInput struct {

	// Unique name 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

	// The type of package.
	//
	// This member is required.
	PackageType types.PackageType

	// The version of the Amazon OpenSearch Service engine for which is compatible
	// with the package. This can only be specified for package type ZIP-PLUGIN
	EngineVersion *string

	//  The configuration parameters for the package being created.
	PackageConfiguration *types.PackageConfiguration

	// Description of the package.
	PackageDescription *string

	// The encryption parameters for the package being created.
	PackageEncryptionOptions *types.PackageEncryptionOptions

	//  The vending options for the package being created. They determine if the
	// package can be vended to other users.
	PackageVendingOptions *types.PackageVendingOptions
	// contains filtered or unexported fields
}

Container for request parameters to the CreatePackage operation.

type CreatePackageOutput 

type CreatePackageOutput struct {

	// Basic information about an OpenSearch Service 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 CreateVpcEndpointInput added in v1.11.0 

type CreateVpcEndpointInput struct {

	// The Amazon Resource Name (ARN) of the domain to create the endpoint for.
	//
	// 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
}

type CreateVpcEndpointOutput added in v1.11.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
}

type DeleteApplicationInput added in v1.43.0 

type DeleteApplicationInput struct {

	// Unique identifier for the OpenSearch Application that you want to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteApplicationOutput added in v1.43.0 

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

type DeleteDataSourceInput added in v1.26.0 

type DeleteDataSourceInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The name of the data source to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteDataSource operation.

type DeleteDataSourceOutput added in v1.26.0 

type DeleteDataSourceOutput struct {

	// A message associated with deletion of the data source.
	Message *string

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

The result of a GetDataSource operation.

type DeleteDirectQueryDataSourceInput added in v1.45.0 

type DeleteDirectQueryDataSourceInput struct {

	//  A unique, user-defined label to identify the data source within your
	// OpenSearch Service environment.
	//
	// This member is required.
	DataSourceName *string
	// contains filtered or unexported fields
}

type DeleteDirectQueryDataSourceOutput added in v1.45.0 

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

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.

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 results 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 deleted inbound connection.
	Connection *types.InboundConnection

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

The results 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 deleted inbound connection.
	Connection *types.OutboundConnection

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

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
}

Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.

type DeletePackageOutput 

type DeletePackageOutput struct {

	//  Information about the deleted package.
	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 DeleteVpcEndpointInput added in v1.11.0 

type DeleteVpcEndpointInput struct {

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

type DeleteVpcEndpointOutput added in v1.11.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
}

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 {

	// Name of the domain that you want Auto-Tune details about.
	//
	// This member is required.
	DomainName *string

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial DescribeDomainAutoTunes operation returns a nextToken , you can
	// include the returned nextToken in subsequent DescribeDomainAutoTunes
	// operations, which returns results in the next page.
	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.
	AutoTunes []types.AutoTune

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

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

The result of a DescribeDomainAutoTunes request.

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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 name of the domain to get progress information for.
	//
	// This member is required.
	DomainName *string

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

Container for the parameters to the DescribeDomainChangeProgress operation.

type DescribeDomainChangeProgressOutput added in v1.8.0 

type DescribeDomainChangeProgressOutput struct {

	// Container for information about the stages of a configuration change happening
	// on a domain.
	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 progress information for the requested domain change.

type DescribeDomainConfigInput 

type DescribeDomainConfigInput struct {

	// Name of the OpenSearch Service domain configuration that you want to describe.
	//
	// This member is required.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainConfig operation.

type DescribeDomainConfigOutput 

type DescribeDomainConfigOutput struct {

	// Container for the configuration of the OpenSearch Service domain.
	//
	// This member is required.
	DomainConfig *types.DomainConfig

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

Contains the configuration information of the requested domain.

type DescribeDomainHealthInput added in v1.16.0 

type DescribeDomainHealthInput struct {

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

Container for the parameters to the DescribeDomainHealth operation.

type DescribeDomainHealthOutput added in v1.16.0 

type DescribeDomainHealthOutput struct {

	// The number of active Availability Zones configured for the domain. If the
	// service is unable to fetch this information, it will return NotAvailable .
	ActiveAvailabilityZoneCount *string

	// The number of Availability Zones configured for the domain. If the service is
	// unable to fetch this information, it will return NotAvailable .
	AvailabilityZoneCount *string

	// The current health status of your cluster.
	//
	//   - Red - At least one primary shard is not allocated to any node.
	//
	//   - Yellow - All primary shards are allocated to nodes, but some replicas aren’t.
	//
	//   - Green - All primary shards and their replicas are allocated to nodes.
	//
	//   - NotAvailable - Unable to retrieve cluster health.
	ClusterHealth types.DomainHealth

	// The number of data nodes configured for the domain. If the service is unable to
	// fetch this information, it will return NotAvailable .
	DataNodeCount *string

	// A boolean that indicates if dedicated master nodes are activated for the domain.
	DedicatedMaster *bool

	// The current state of the domain.
	//
	//   - Processing - The domain has updates in progress.
	//
	//   - Active - Requested changes have been processed and deployed to the domain.
	DomainState types.DomainState

	// A list of EnvironmentInfo for the domain.
	EnvironmentInformation []types.EnvironmentInfo

	// The number of nodes that can be elected as a master node. If dedicated master
	// nodes is turned on, this value is the number of dedicated master nodes
	// configured for the domain. If the service is unable to fetch this information,
	// it will return NotAvailable .
	MasterEligibleNodeCount *string

	// Indicates whether the domain has an elected master node.
	//
	//   - Available - The domain has an elected master node.
	//
	//   - UnAvailable - The master node hasn't yet been elected, and a quorum to
	//   elect a new master node hasn't been reached.
	MasterNode types.MasterNodeStatus

	// The number of standby Availability Zones configured for the domain. If the
	// service is unable to fetch this information, it will return NotAvailable .
	StandByAvailabilityZoneCount *string

	// The total number of primary and replica shards for the domain.
	TotalShards *string

	// The total number of primary and replica shards not allocated to any of the
	// nodes for the cluster.
	TotalUnAssignedShards *string

	// The number of warm nodes configured for the domain.
	WarmNodeCount *string

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

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

type DescribeDomainInput 

type DescribeDomainInput struct {

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

Container for the parameters to the DescribeDomain operation.

type DescribeDomainNodesInput added in v1.17.0 

type DescribeDomainNodesInput struct {

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

Container for the parameters to the DescribeDomainNodes operation.

type DescribeDomainNodesOutput added in v1.17.0 

type DescribeDomainNodesOutput struct {

	// Contains nodes information list DomainNodesStatusList with details about the
	// all nodes on the requested domain.
	DomainNodesStatusList []types.DomainNodesStatus

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

The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

type DescribeDomainOutput 

type DescribeDomainOutput struct {

	// List that contains the status of each specified OpenSearch Service domain.
	//
	// This member is required.
	DomainStatus *types.DomainStatus

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

Contains the status of the domain specified in the request.

type DescribeDomainsInput 

type DescribeDomainsInput struct {

	// Array of OpenSearch Service domain names that you want information about. You
	// must specify at least one domain name.
	//
	// This member is required.
	DomainNames []string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeDomains operation.

type DescribeDomainsOutput 

type DescribeDomainsOutput struct {

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

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

Contains the status of the specified domains or all domains owned by the account.

type DescribeDryRunProgressInput added in v1.13.0 

type DescribeDryRunProgressInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The unique identifier of the dry run.
	DryRunId *string

	// Whether to include the configuration of the dry run in the response. The
	// configuration specifies the updates that you're planning to make on the domain.
	LoadDryRunConfig *bool
	// contains filtered or unexported fields
}

type DescribeDryRunProgressOutput added in v1.13.0 

type DescribeDryRunProgressOutput struct {

	// Details about the changes you're planning to make on the domain.
	DryRunConfig *types.DomainStatus

	// The current status of the dry run, including any validation errors.
	DryRunProgressStatus *types.DryRunProgressStatus

	// The results of the dry run.
	DryRunResults *types.DryRunResults

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

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.
	Filters []types.Filter

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial DescribeInboundConnections operation returns a nextToken , you
	// can include the returned nextToken in subsequent DescribeInboundConnections
	// operations, which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeInboundConnections operation.

type DescribeInboundConnectionsOutput 

type DescribeInboundConnectionsOutput struct {

	// List of inbound connections.
	Connections []types.InboundConnection

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

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

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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 or Elasticsearch, in the format Elasticsearch_X.Y or
	// OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
	//
	// This member is required.
	EngineVersion *string

	// The OpenSearch Service instance type for which you need limit information.
	//
	// This member is required.
	InstanceType types.OpenSearchPartitionInstanceType

	// The name of the domain. Only specify if you need the 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 {

	// Map that contains all applicable instance type limits. data refers to data
	// nodes. master refers to dedicated master nodes.
	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 {

	// List of filter names and values that you can use for requests.
	Filters []types.Filter

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial DescribeOutboundConnections operation returns a nextToken , you
	// can include the returned nextToken in subsequent DescribeOutboundConnections
	// operations, which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeOutboundConnections operation.

type DescribeOutboundConnectionsOutput 

type DescribeOutboundConnectionsOutput struct {

	// List of outbound connections that match the filter criteria.
	Connections []types.OutboundConnection

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

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

Contains a 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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial DescribePackageFilters operation returns a nextToken , you can
	// include the returned nextToken in subsequent DescribePackageFilters operations,
	// which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the request parameters to the DescribePackage operation.

type DescribePackagesOutput 

type DescribePackagesOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// Basic information about a package.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial DescribeReservedInstanceOfferings operation returns a nextToken
	// , you can include the returned nextToken in subsequent
	// DescribeReservedInstanceOfferings operations, which returns results in the next
	// page.
	NextToken *string

	// The Reserved Instance identifier filter value. Use this parameter to show only
	// the available instance types that match the specified reservation identifier.
	ReservedInstanceOfferingId *string
	// contains filtered or unexported fields
}

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

type DescribeReservedInstanceOfferingsOutput 

type DescribeReservedInstanceOfferingsOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// List of Reserved Instance offerings.
	ReservedInstanceOfferings []types.ReservedInstanceOffering

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

Container for results of a DescribeReservedInstanceOfferings request.

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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial DescribeReservedInstances operation returns a nextToken , you
	// can include the returned nextToken in subsequent DescribeReservedInstances
	// operations, which returns results in the next page.
	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 the request parameters to the DescribeReservedInstances operation.

type DescribeReservedInstancesOutput 

type DescribeReservedInstancesOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// List of Reserved Instances in the current Region.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 DescribeVpcEndpointsInput added in v1.11.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
}

type DescribeVpcEndpointsOutput added in v1.11.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
}

type DissociatePackageInput 

type DissociatePackageInput struct {

	// Name of the domain to dissociate the package from.
	//
	// This member is required.
	DomainName *string

	// Internal ID of the package to dissociate from the domain. Use
	// ListPackagesForDomain 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 {

	//  Information about a package that has been dissociated from the domain.
	DomainPackageDetails *types.DomainPackageDetails

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

Container for the response returned by an DissociatePackage operation.

type DissociatePackagesInput added in v1.44.0 

type DissociatePackagesInput struct {

	// The name of an OpenSearch Service domain. Domain names are unique across the
	// domains owned by an account within an Amazon Web Services Region.
	//
	// This member is required.
	DomainName *string

	// A list of package IDs to be dissociated from a domain.
	//
	// This member is required.
	PackageList []string
	// contains filtered or unexported fields
}

type DissociatePackagesOutput added in v1.44.0 

type DissociatePackagesOutput struct {

	// A list of package details for the packages that were dissociated from the
	// domain.
	DomainPackageDetailsList []types.DomainPackageDetails

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

type EndpointParameters added in v1.19.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.19.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.19.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 

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 EndpointResolverV2 added in v1.19.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.19.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetApplicationInput added in v1.43.0 

type GetApplicationInput struct {

	// Unique identifier of the checked OpenSearch Application.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetApplicationOutput added in v1.43.0 

type GetApplicationOutput struct {

	// App configurations of the checked OpenSearch Application.
	AppConfigs []types.AppConfig

	// The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities] in Using Amazon Web Services
	// Identity and Access Management for more information.
	//
	// [Identifiers for IAM Entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
	Arn *string

	// Timestamp at which the checked OpenSearch Application was created.
	CreatedAt *time.Time

	// Associated data sources to the checked OpenSearch Application.
	DataSources []types.DataSource

	// Endpoint URL of the checked OpenSearch Application.
	Endpoint *string

	// IAM Identity Center settings for the checked OpenSearch Application.
	IamIdentityCenterOptions *types.IamIdentityCenterOptions

	// Unique identifier of the checked OpenSearch Application.
	Id *string

	// Timestamp at which the checked OpenSearch Application was last updated.
	LastUpdatedAt *time.Time

	// Name of the checked OpenSearch Application.
	Name *string

	// Current status of the checked OpenSearch Application. Possible values are
	// CREATING , UPDATING , DELETING , FAILED , ACTIVE , and DELETED .
	Status types.ApplicationStatus

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

type GetCompatibleVersionsInput 

type GetCompatibleVersionsInput struct {

	// The name of an existing domain. Provide this parameter to limit the results to
	// a single domain.
	DomainName *string
	// contains filtered or unexported fields
}

Container for the request parameters to GetCompatibleVersions operation.

type GetCompatibleVersionsOutput 

type GetCompatibleVersionsOutput struct {

	// A map of OpenSearch or Elasticsearch versions and the versions you can upgrade
	// them to.
	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 GetDataSourceInput added in v1.26.0 

type GetDataSourceInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The name of the data source to get information about.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Container for the parameters to the GetDataSource operation.

type GetDataSourceOutput added in v1.26.0 

type GetDataSourceOutput struct {

	// The type of data source.
	DataSourceType types.DataSourceType

	// A description of the data source.
	Description *string

	// The name of the data source.
	Name *string

	// The status of the data source.
	Status types.DataSourceStatus

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

The result of a GetDataSource operation.

type GetDirectQueryDataSourceInput added in v1.45.0 

type GetDirectQueryDataSourceInput struct {

	//  A unique, user-defined label that identifies the data source within your
	// OpenSearch Service environment.
	//
	// This member is required.
	DataSourceName *string
	// contains filtered or unexported fields
}

type GetDirectQueryDataSourceOutput added in v1.45.0 

type GetDirectQueryDataSourceOutput struct {

	//  The unique, system-generated identifier that represents the data source.
	DataSourceArn *string

	//  A unique, user-defined label to identify the data source within your
	// OpenSearch Service environment.
	DataSourceName *string

	//  The supported Amazon Web Services service that is used as the source for
	// direct queries in OpenSearch Service.
	DataSourceType types.DirectQueryDataSourceType

	//  A description that provides additional context and details about the data
	// source.
	Description *string

	//  A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
	// associated with the direct query data source.
	OpenSearchArns []string

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

type GetDomainMaintenanceStatusInput added in v1.21.0 

type GetDomainMaintenanceStatusInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The request ID of the maintenance action.
	//
	// This member is required.
	MaintenanceId *string
	// contains filtered or unexported fields
}

Container for the parameters to the GetDomainMaintenanceStatus operation.

type GetDomainMaintenanceStatusOutput added in v1.21.0 

type GetDomainMaintenanceStatusOutput struct {

	// The action name.
	Action types.MaintenanceType

	// The time at which the action was created.
	CreatedAt *time.Time

	// The node ID of the maintenance action.
	NodeId *string

	// The status of the maintenance action.
	Status types.MaintenanceStatus

	// The status message of the maintenance action.
	StatusMessage *string

	// The time at which the action was updated.
	UpdatedAt *time.Time

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

The result of a GetDomainMaintenanceStatus request that information about the requested action.

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 {

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

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial GetPackageVersionHistory operation returns a nextToken , you can
	// include the returned nextToken in subsequent GetPackageVersionHistory
	// operations, which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the request parameters to the GetPackageVersionHistory operation.

type GetPackageVersionHistoryOutput 

type GetPackageVersionHistoryOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// The unique identifier of the package.
	PackageID *string

	// A list of package versions, along with their creation time and commit message.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 existing domain.
	//
	// This member is required.
	DomainName *string

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial GetUpgradeHistory operation returns a nextToken , you can
	// include the returned nextToken in subsequent GetUpgradeHistory operations,
	// which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the request parameters to the GetUpgradeHistory operation.

type GetUpgradeHistoryOutput 

type GetUpgradeHistoryOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// A list of objects corresponding to each upgrade or upgrade eligibility check
	// performed on a domain.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 domain of the domain to get upgrade status information for.
	//
	// 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 {

	// The status of the current step that an upgrade is on.
	StepStatus types.UpgradeStatus

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

	// One of three steps that an upgrade or upgrade eligibility check goes through.
	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 IdempotencyTokenProvider added in v1.43.0 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListApplicationsAPIClient added in v1.43.0 

type ListApplicationsAPIClient interface {
	ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
}

ListApplicationsAPIClient is a client that implements the ListApplications operation.

type ListApplicationsInput added in v1.43.0 

type ListApplicationsInput struct {

	// An optional parameter that specifies the maximum number of results to return
	// for a given request.
	MaxResults int32

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// OpenSearch Application Status can be used as filters for the listing request.
	// Possible values are CREATING , UPDATING , DELETING , FAILED , ACTIVE , and
	// DELETED .
	Statuses []types.ApplicationStatus
	// contains filtered or unexported fields
}

type ListApplicationsOutput added in v1.43.0 

type ListApplicationsOutput struct {

	// Summary of the OpenSearch Applications, including ID, ARN, name, endpoint,
	// status, create time and last update time.
	ApplicationSummaries []types.ApplicationSummary

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

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

type ListApplicationsPaginator added in v1.43.0 

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

ListApplicationsPaginator is a paginator for ListApplications

func NewListApplicationsPaginator added in v1.43.0 

func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator

NewListApplicationsPaginator returns a new ListApplicationsPaginator

func (*ListApplicationsPaginator) HasMorePages added in v1.43.0 

func (p *ListApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationsPaginator) NextPage added in v1.43.0 

func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)

NextPage retrieves the next ListApplications page.

type ListApplicationsPaginatorOptions added in v1.43.0 

type ListApplicationsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return
	// for a given request.
	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
}

ListApplicationsPaginatorOptions is the paginator options for ListApplications

type ListDataSourcesInput added in v1.26.0 

type ListDataSourcesInput struct {

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

Container for the parameters to the ListDataSources operation.

type ListDataSourcesOutput added in v1.26.0 

type ListDataSourcesOutput struct {

	// A list of data sources associated with specified domain.
	DataSources []types.DataSourceDetails

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

The result of a ListDataSources operation.

type ListDirectQueryDataSourcesInput added in v1.45.0 

type ListDirectQueryDataSourcesInput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDirectQueryDataSourcesOutput added in v1.45.0 

type ListDirectQueryDataSourcesOutput struct {

	//  A list of the direct query data sources that are returned by the
	// ListDirectQueryDataSources API operation.
	DirectQueryDataSources []types.DirectQueryDataSource

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

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

type ListDomainMaintenancesAPIClient added in v1.21.0 

type ListDomainMaintenancesAPIClient interface {
	ListDomainMaintenances(context.Context, *ListDomainMaintenancesInput, ...func(*Options)) (*ListDomainMaintenancesOutput, error)
}

ListDomainMaintenancesAPIClient is a client that implements the ListDomainMaintenances operation.

type ListDomainMaintenancesInput added in v1.21.0 

type ListDomainMaintenancesInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The name of the action.
	Action types.MaintenanceType

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial ListDomainMaintenances operation returns a nextToken , include
	// the returned nextToken in subsequent ListDomainMaintenances operations, which
	// returns results in the next page.
	NextToken *string

	// The status of the action.
	Status types.MaintenanceStatus
	// contains filtered or unexported fields
}

Container for the parameters to the ListDomainMaintenances operation.

type ListDomainMaintenancesOutput added in v1.21.0 

type ListDomainMaintenancesOutput struct {

	// A list of the submitted maintenance actions.
	DomainMaintenances []types.DomainMaintenanceDetails

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

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

The result of a ListDomainMaintenances request that contains information about the requested actions.

type ListDomainMaintenancesPaginator added in v1.21.0 

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

ListDomainMaintenancesPaginator is a paginator for ListDomainMaintenances

func NewListDomainMaintenancesPaginator added in v1.21.0 

func NewListDomainMaintenancesPaginator(client ListDomainMaintenancesAPIClient, params *ListDomainMaintenancesInput, optFns ...func(*ListDomainMaintenancesPaginatorOptions)) *ListDomainMaintenancesPaginator

NewListDomainMaintenancesPaginator returns a new ListDomainMaintenancesPaginator

func (*ListDomainMaintenancesPaginator) HasMorePages added in v1.21.0 

func (p *ListDomainMaintenancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainMaintenancesPaginator) NextPage added in v1.21.0 

func (p *ListDomainMaintenancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainMaintenancesOutput, error)

NextPage retrieves the next ListDomainMaintenances page.

type ListDomainMaintenancesPaginatorOptions added in v1.21.0 

type ListDomainMaintenancesPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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
}

ListDomainMaintenancesPaginatorOptions is the paginator options for ListDomainMaintenances

type ListDomainNamesInput 

type ListDomainNamesInput struct {

	// Filters the output by domain engine type.
	EngineType types.EngineType
	// contains filtered or unexported fields
}

Container for the parameters to the ListDomainNames operation.

type ListDomainNamesOutput 

type ListDomainNamesOutput struct {

	// The names of all OpenSearch Service domains owned by the current user and their
	// respective engine types.
	DomainNames []types.DomainInfo

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

The results 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 unique identifier of the package for which to list associated domains.
	//
	// This member is required.
	PackageID *string

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial ListDomainsForPackage operation returns a nextToken , you can
	// include the returned nextToken in subsequent ListDomainsForPackage operations,
	// which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the request parameters to the ListDomainsForPackage operation.

type ListDomainsForPackageOutput 

type ListDomainsForPackageOutput struct {

	// Information about all domains associated with a package.
	DomainPackageDetailsList []types.DomainPackageDetails

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 {

	// The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
	// OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
	//
	// This member is required.
	EngineVersion *string

	// The name of the domain.
	DomainName *string

	// An optional parameter that lists information for a given instance type.
	InstanceType *string

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial ListInstanceTypeDetails operation returns a nextToken , you can
	// include the returned nextToken in subsequent ListInstanceTypeDetails
	// operations, which returns results in the next page.
	NextToken *string

	// An optional parameter that specifies the Availability Zones for the domain.
	RetrieveAZs *bool
	// contains filtered or unexported fields
}

type ListInstanceTypeDetailsOutput 

type ListInstanceTypeDetailsOutput struct {

	// Lists all supported instance types and features for the given OpenSearch or
	// Elasticsearch version.
	InstanceTypeDetails []types.InstanceTypeDetails

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial ListPackagesForDomain operation returns a nextToken , you can
	// include the returned nextToken in subsequent ListPackagesForDomain operations,
	// which returns results in 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 all packages associated with a domain.
	DomainPackageDetailsList []types.DomainPackageDetails

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 ListScheduledActionsAPIClient added in v1.15.0 

type ListScheduledActionsAPIClient interface {
	ListScheduledActions(context.Context, *ListScheduledActionsInput, ...func(*Options)) (*ListScheduledActionsOutput, error)
}

ListScheduledActionsAPIClient is a client that implements the ListScheduledActions operation.

type ListScheduledActionsInput added in v1.15.0 

type ListScheduledActionsInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial ListScheduledActions operation returns a nextToken , you can
	// include the returned nextToken in subsequent ListScheduledActions operations,
	// which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListScheduledActionsOutput added in v1.15.0 

type ListScheduledActionsOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// A list of actions that are scheduled for the domain.
	ScheduledActions []types.ScheduledAction

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

type ListScheduledActionsPaginator added in v1.15.0 

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

ListScheduledActionsPaginator is a paginator for ListScheduledActions

func NewListScheduledActionsPaginator added in v1.15.0 

func NewListScheduledActionsPaginator(client ListScheduledActionsAPIClient, params *ListScheduledActionsInput, optFns ...func(*ListScheduledActionsPaginatorOptions)) *ListScheduledActionsPaginator

NewListScheduledActionsPaginator returns a new ListScheduledActionsPaginator

func (*ListScheduledActionsPaginator) HasMorePages added in v1.15.0 

func (p *ListScheduledActionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListScheduledActionsPaginator) NextPage added in v1.15.0 

func (p *ListScheduledActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListScheduledActionsOutput, error)

NextPage retrieves the next ListScheduledActions page.

type ListScheduledActionsPaginatorOptions added in v1.15.0 

type ListScheduledActionsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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
}

ListScheduledActionsPaginatorOptions is the paginator options for ListScheduledActions

type ListTagsInput 

type ListTagsInput struct {

	// Amazon Resource Name (ARN) for the domain, data source, or application to view
	// tags for.
	//
	// This member is required.
	ARN *string
	// contains filtered or unexported fields
}

Container for the parameters to the ListTags operation.

type ListTagsOutput 

type ListTagsOutput struct {

	// List of resource tags associated with the specified domain, data source, or
	// application.
	TagList []types.Tag

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

The results of a ListTags operation.

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 {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	MaxResults int32

	// If your initial ListVersions operation returns a nextToken , you can include the
	// returned nextToken in subsequent ListVersions operations, which returns results
	// in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

Container for the request parameters to the ListVersions operation.

type ListVersionsOutput 

type ListVersionsOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	NextToken *string

	// A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch
	// Service supports.
	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 {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results.
	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 ListVpcEndpointAccessInput added in v1.11.0 

type ListVpcEndpointAccessInput struct {

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

	// If your initial ListVpcEndpointAccess operation returns a nextToken , you can
	// include the returned nextToken in subsequent ListVpcEndpointAccess operations,
	// which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVpcEndpointAccessOutput added in v1.11.0 

type ListVpcEndpointAccessOutput struct {

	// A list of [IAM principals] that can currently access the domain.
	//
	// [IAM principals]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html
	//
	// This member is required.
	AuthorizedPrincipalList []types.AuthorizedPrincipal

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	//
	// This member is required.
	NextToken *string

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

type ListVpcEndpointsForDomainInput added in v1.11.0 

type ListVpcEndpointsForDomainInput struct {

	// The name of the domain to list associated VPC endpoints for.
	//
	// This member is required.
	DomainName *string

	// If your initial ListEndpointsForDomain operation returns a nextToken , you can
	// include the returned nextToken in subsequent ListEndpointsForDomain operations,
	// which returns results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVpcEndpointsForDomainOutput added in v1.11.0 

type ListVpcEndpointsForDomainOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	//
	// This member is required.
	NextToken *string

	// Information about each endpoint associated with the domain.
	//
	// This member is required.
	VpcEndpointSummaryList []types.VpcEndpointSummary

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

type ListVpcEndpointsInput added in v1.11.0 

type ListVpcEndpointsInput struct {

	// If your initial ListVpcEndpoints operation returns a nextToken , you can include
	// the returned nextToken in subsequent ListVpcEndpoints operations, which returns
	// results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVpcEndpointsOutput added in v1.11.0 

type ListVpcEndpointsOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Send the request again
	// using the returned token to retrieve the next page.
	//
	// 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
}

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

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

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

type PurchaseReservedInstanceOfferingInput 

type PurchaseReservedInstanceOfferingInput struct {

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

	// The ID of the Reserved 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 request parameters to the PurchaseReservedInstanceOffering operation.

type PurchaseReservedInstanceOfferingOutput 

type PurchaseReservedInstanceOfferingOutput struct {

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

	// The ID of the Reserved Instance offering that 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 unique identifier of the inbound connection to reject.
	//
	// This member is required.
	ConnectionId *string
	// contains filtered or unexported fields
}

Container for the request parameters to the RejectInboundConnection operation.

type RejectInboundConnectionOutput 

type RejectInboundConnectionOutput struct {

	// Contains details about the rejected inbound connection.
	Connection *types.InboundConnection

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

Represents the output of a RejectInboundConnection operation.

type RemoveTagsInput 

type RemoveTagsInput struct {

	// The Amazon Resource Name (ARN) of the domain, data source, or application from
	// which you want to delete the specified tags.
	//
	// This member is required.
	ARN *string

	// The list of tag keys to remove from the domain, data source, or application.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

Container for the request parameters to the RemoveTags operation.

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

type RevokeVpcEndpointAccessInput struct {

	// The name of the OpenSearch Service domain.
	//
	// This member is required.
	DomainName *string

	// The account ID to revoke access from.
	Account *string

	// The service SP to revoke access from.
	Service types.AWSServicePrincipal
	// contains filtered or unexported fields
}

type RevokeVpcEndpointAccessOutput added in v1.11.0 

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

type StartDomainMaintenanceInput added in v1.21.0 

type StartDomainMaintenanceInput struct {

	// The name of the action.
	//
	// This member is required.
	Action types.MaintenanceType

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The ID of the data node.
	NodeId *string
	// contains filtered or unexported fields
}

Container for the parameters to the StartDomainMaintenance operation.

type StartDomainMaintenanceOutput added in v1.21.0 

type StartDomainMaintenanceOutput struct {

	// The request ID of requested action.
	MaintenanceId *string

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

The result of a StartDomainMaintenance request that information about the requested action.

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

	// The Epoch timestamp when you want the service software update to start. You
	// only need to specify this parameter if you set ScheduleAt to TIMESTAMP .
	DesiredStartTime *int64

	// When to start the service software update.
	//
	//   - NOW - Immediately schedules the update to happen in the current hour if
	//   there's capacity available.
	//
	//   - TIMESTAMP - Lets you specify a custom date and time to apply the update. If
	//   you specify this value, you must also provide a value for DesiredStartTime .
	//
	//   - OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming
	//   off-peak window. There's no guarantee that the update will happen during the
	//   next immediate window. Depending on capacity, it might happen in subsequent
	//   days.
	//
	// Default: NOW if you don't specify a value for DesiredStartTime , and TIMESTAMP
	// if you do.
	ScheduleAt types.ScheduleAt
	// contains filtered or unexported fields
}

Container for the request parameters to the StartServiceSoftwareUpdate operation.

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
}

Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

type UpdateApplicationInput added in v1.43.0 

type UpdateApplicationInput struct {

	// Unique identifier of the OpenSearch Application to be updated.
	//
	// This member is required.
	Id *string

	// Configurations to be changed for the OpenSearch Application.
	AppConfigs []types.AppConfig

	// Data sources to be associated with the OpenSearch Application.
	DataSources []types.DataSource
	// contains filtered or unexported fields
}

type UpdateApplicationOutput added in v1.43.0 

type UpdateApplicationOutput struct {

	// Configurations for the updated OpenSearch Application.
	AppConfigs []types.AppConfig

	// The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities] in Using Amazon Web Services
	// Identity and Access Management for more information.
	//
	// [Identifiers for IAM Entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
	Arn *string

	// Timestamp at which the OpenSearch Application was created.
	CreatedAt *time.Time

	// Data sources associated with the updated OpenSearch Application.
	DataSources []types.DataSource

	// IAM Identity Center settings for the updated OpenSearch Application.
	IamIdentityCenterOptions *types.IamIdentityCenterOptions

	// Unique identifier of the updated OpenSearch Application.
	Id *string

	// Timestamp at which the OpenSearch Application was last updated.
	LastUpdatedAt *time.Time

	// Name of the updated OpenSearch Application.
	Name *string

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

type UpdateDataSourceInput added in v1.26.0 

type UpdateDataSourceInput struct {

	// The type of data source.
	//
	// This member is required.
	DataSourceType types.DataSourceType

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The name of the data source to modify.
	//
	// This member is required.
	Name *string

	// A new description of the data source.
	Description *string

	// The status of the data source update.
	Status types.DataSourceStatus
	// contains filtered or unexported fields
}

Container for the parameters to the UpdateDataSource operation.

type UpdateDataSourceOutput added in v1.26.0 

type UpdateDataSourceOutput struct {

	// A message associated with the updated data source.
	Message *string

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

The result of an UpdateDataSource operation.

type UpdateDirectQueryDataSourceInput added in v1.45.0 

type UpdateDirectQueryDataSourceInput struct {

	//  A unique, user-defined label to identify the data source within your
	// OpenSearch Service environment.
	//
	// This member is required.
	DataSourceName *string

	//  The supported Amazon Web Services service that you want to use as the source
	// for direct queries in OpenSearch Service.
	//
	// This member is required.
	DataSourceType types.DirectQueryDataSourceType

	//  A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
	// associated with the direct query data source.
	//
	// This member is required.
	OpenSearchArns []string

	//  An optional text field for providing additional context and details about the
	// data source.
	Description *string
	// contains filtered or unexported fields
}

type UpdateDirectQueryDataSourceOutput added in v1.45.0 

type UpdateDirectQueryDataSourceOutput struct {

	//  The unique, system-generated identifier that represents the data source.
	DataSourceArn *string

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

type UpdateDomainConfigInput 

type UpdateDomainConfigInput struct {

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

	// Options for all machine learning features for the specified domain.
	AIMLOptions *types.AIMLOptionsInput

	// Identity and Access Management (IAM) access policy as a JSON-formatted string.
	AccessPolicies *string

	// Key-value pairs to specify advanced configuration options. The following
	// key-value pairs are supported:
	//
	//   - "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of
	//   a string rather than a boolean. Specifies whether explicit references to indexes
	//   are allowed inside the body of HTTP requests. If you want to configure access
	//   policies for domain sub-resources, such as specific indexes and domain APIs, you
	//   must disable this property. Default is true.
	//
	//   - "indices.fielddata.cache.size": "80" - Note the use of a string rather than
	//   a boolean. Specifies the percentage of heap space allocated to field data.
	//   Default is unbounded.
	//
	//   - "indices.query.bool.max_clause_count": "1024" - Note the use of a string
	//   rather than a boolean. Specifies the maximum number of clauses allowed in a
	//   Lucene boolean query. Default is 1,024. Queries with more than the permitted
	//   number of clauses result in a TooManyClauses error.
	//
	// For more information, see [Advanced cluster parameters].
	//
	// [Advanced cluster parameters]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
	AdvancedOptions map[string]string

	// Options for fine-grained access control.
	AdvancedSecurityOptions *types.AdvancedSecurityOptionsInput

	// Options for Auto-Tune.
	AutoTuneOptions *types.AutoTuneOptions

	// Changes that you want to make to the cluster configuration, such as the
	// instance type and number of EC2 instances.
	ClusterConfig *types.ClusterConfig

	// Key-value pairs to configure Amazon Cognito authentication for OpenSearch
	// Dashboards.
	CognitoOptions *types.CognitoOptions

	// Additional options for the domain endpoint, such as whether to require HTTPS
	// for all traffic.
	DomainEndpointOptions *types.DomainEndpointOptions

	// This flag, when set to True, specifies whether the UpdateDomain request should
	// return the results of a dry run analysis without actually applying the change. A
	// dry run determines what type of deployment the update will cause.
	DryRun *bool

	// The type of dry run to perform.
	//
	//   - Basic only returns the type of deployment (blue/green or dynamic) that the
	//   update will cause.
	//
	//   - Verbose runs an additional check to validate the changes you're making. For
	//   more information, see [Validating a domain update].
	//
	// [Validating a domain update]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check
	DryRunMode types.DryRunMode

	// The type and size of the EBS volume to attach to instances in the domain.
	EBSOptions *types.EBSOptions

	// Encryption at rest options for the domain.
	EncryptionAtRestOptions *types.EncryptionAtRestOptions

	// Specify either dual stack or IPv4 as your IP address type. Dual stack allows
	// you to share domain resources across IPv4 and IPv6 address types, and is the
	// recommended option. If your IP address type is currently set to dual stack, you
	// can't change it.
	IPAddressType types.IPAddressType

	// Container for IAM Identity Center Options settings.
	IdentityCenterOptions *types.IdentityCenterOptionsInput

	// Options to publish OpenSearch logs to Amazon CloudWatch Logs.
	LogPublishingOptions map[string]types.LogPublishingOption

	// Node-to-node encryption options for the domain.
	NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions

	// Off-peak window options for the domain.
	OffPeakWindowOptions *types.OffPeakWindowOptions

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

	// Service software update options for the domain.
	SoftwareUpdateOptions *types.SoftwareUpdateOptions

	// 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].
	//
	// [Launching your Amazon OpenSearch Service domains using a VPC]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
	VPCOptions *types.VPCOptions
	// contains filtered or unexported fields
}

Container for the request parameters to the UpdateDomain operation.

type UpdateDomainConfigOutput 

type UpdateDomainConfigOutput struct {

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

	// The status of the dry run being performed on the domain, if any.
	DryRunProgressStatus *types.DryRunProgressStatus

	// Results of the dry run performed in the update domain request.
	DryRunResults *types.DryRunResults

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

The results 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

	// Amazon S3 bucket and key for the package.
	//
	// This member is required.
	PackageSource *types.PackageSource

	// Commit message for the updated file, which is shown as part of
	// GetPackageVersionHistoryResponse .
	CommitMessage *string

	// The updated configuration details for a package.
	PackageConfiguration *types.PackageConfiguration

	// A new description of the package.
	PackageDescription *string

	// Encryption options for a package.
	PackageEncryptionOptions *types.PackageEncryptionOptions
	// contains filtered or unexported fields
}

Container for request parameters to the UpdatePackage operation.

type UpdatePackageOutput 

type UpdatePackageOutput struct {

	// Information about a 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 UpdatePackageScopeInput added in v1.44.0 

type UpdatePackageScopeInput struct {

	//  The operation to perform on the package scope (e.g., add/remove/override
	// users).
	//
	// This member is required.
	Operation types.PackageScopeOperationEnum

	// ID of the package whose scope is being updated.
	//
	// This member is required.
	PackageID *string

	//  List of users to be added or removed from the package scope.
	//
	// This member is required.
	PackageUserList []string
	// contains filtered or unexported fields
}

type UpdatePackageScopeOutput added in v1.44.0 

type UpdatePackageScopeOutput struct {

	// The operation that was performed on the package scope.
	Operation types.PackageScopeOperationEnum

	//  ID of the package whose scope was updated.
	PackageID *string

	//  List of users who have access to the package after the scope update.
	PackageUserList []string

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

type UpdateScheduledActionInput added in v1.15.0 

type UpdateScheduledActionInput struct {

	// The unique identifier of the action to reschedule. To retrieve this ID, send a [ListScheduledActions]
	// request.
	//
	// [ListScheduledActions]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
	//
	// This member is required.
	ActionID *string

	// The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE ,
	// JVM_HEAP_SIZE_TUNING , or JVM_YOUNG_GEN_TUNING . To retrieve this value, send a [ListScheduledActions]
	// request.
	//
	// [ListScheduledActions]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
	//
	// This member is required.
	ActionType types.ActionType

	// The name of the domain to reschedule an action for.
	//
	// This member is required.
	DomainName *string

	// When to schedule the action.
	//
	//   - NOW - Immediately schedules the update to happen in the current hour if
	//   there's capacity available.
	//
	//   - TIMESTAMP - Lets you specify a custom date and time to apply the update. If
	//   you specify this value, you must also provide a value for DesiredStartTime .
	//
	//   - OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming
	//   off-peak window. There's no guarantee that the change will be implemented during
	//   the next immediate window. Depending on capacity, it might happen in subsequent
	//   days.
	//
	// This member is required.
	ScheduleAt types.ScheduleAt

	// The time to implement the change, in Coordinated Universal Time (UTC). Only
	// specify this parameter if you set ScheduleAt to TIMESTAMP .
	DesiredStartTime *int64
	// contains filtered or unexported fields
}

type UpdateScheduledActionOutput added in v1.15.0 

type UpdateScheduledActionOutput struct {

	// Information about the rescheduled action.
	ScheduledAction *types.ScheduledAction

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

type UpdateVpcEndpointInput added in v1.11.0 

type UpdateVpcEndpointInput struct {

	// The unique identifier of the endpoint.
	//
	// 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
}

type UpdateVpcEndpointOutput added in v1.11.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
}

type UpgradeDomainInput 

type UpgradeDomainInput struct {

	// Name of the OpenSearch Service domain that you want to upgrade.
	//
	// This member is required.
	DomainName *string

	// OpenSearch or Elasticsearch version to which you want to upgrade, in the format
	// Opensearch_X.Y or Elasticsearch_X.Y.
	//
	// This member is required.
	TargetVersion *string

	// Only supports the override_main_response_version parameter and not other
	// advanced options. You can only include this option when upgrading to an
	// OpenSearch version. Specifies whether the domain reports its version as 7.10 so
	// that it continues to work with Elasticsearch OSS clients and plugins.
	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 the UpgradeDomain operation.

type UpgradeDomainOutput 

type UpgradeDomainOutput struct {

	// The advanced options configuration for the domain.
	AdvancedOptions map[string]string

	// Container for information about a configuration change happening on a domain.
	ChangeProgressDetails *types.ChangeProgressDetails

	// The name of the domain that was upgraded.
	DomainName *string

	// When true, indicates that an upgrade eligibility check was performed.
	PerformCheckOnly *bool

	// OpenSearch or Elasticsearch version that the domain was upgraded to.
	TargetVersion *string

	// The unique identifier of the domain upgrade.
	UpgradeId *string

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

Container for the 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.