...
AWS SDK for Go API Reference
We announced the upcoming end-of-support for AWS SDK for Go (v1). We recommend that you migrate to AWS SDK for Go v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
import "github.com/aws/aws-sdk-go/service/opensearchservice"
Overview
Constants

Overview ▾

Package opensearchservice provides the client and types for making API requests to 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 (https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions).

See https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01 for more information on this service.

See opensearchservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/opensearchservice/

Using the Client

To contact Amazon OpenSearch Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon OpenSearch Service client OpenSearchService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/opensearchservice/#New

The stub package, opensearchserviceiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Operations ▾

Types ▾

type OpenSearchService
func New(p client.ConfigProvider, cfgs ...*aws.Config) *OpenSearchService
func (c *OpenSearchService) AcceptInboundConnection(input *AcceptInboundConnectionInput) (*AcceptInboundConnectionOutput, error)
func (c *OpenSearchService) AcceptInboundConnectionRequest(input *AcceptInboundConnectionInput) (req *request.Request, output *AcceptInboundConnectionOutput)
func (c *OpenSearchService) AcceptInboundConnectionWithContext(ctx aws.Context, input *AcceptInboundConnectionInput, opts ...request.Option) (*AcceptInboundConnectionOutput, error)
func (c *OpenSearchService) AddDataSource(input *AddDataSourceInput) (*AddDataSourceOutput, error)
func (c *OpenSearchService) AddDataSourceRequest(input *AddDataSourceInput) (req *request.Request, output *AddDataSourceOutput)
func (c *OpenSearchService) AddDataSourceWithContext(ctx aws.Context, input *AddDataSourceInput, opts ...request.Option) (*AddDataSourceOutput, error)
func (c *OpenSearchService) AddTags(input *AddTagsInput) (*AddTagsOutput, error)
func (c *OpenSearchService) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput)
func (c *OpenSearchService) AddTagsWithContext(ctx aws.Context, input *AddTagsInput, opts ...request.Option) (*AddTagsOutput, error)
func (c *OpenSearchService) AssociatePackage(input *AssociatePackageInput) (*AssociatePackageOutput, error)
func (c *OpenSearchService) AssociatePackageRequest(input *AssociatePackageInput) (req *request.Request, output *AssociatePackageOutput)
func (c *OpenSearchService) AssociatePackageWithContext(ctx aws.Context, input *AssociatePackageInput, opts ...request.Option) (*AssociatePackageOutput, error)
func (c *OpenSearchService) AuthorizeVpcEndpointAccess(input *AuthorizeVpcEndpointAccessInput) (*AuthorizeVpcEndpointAccessOutput, error)
func (c *OpenSearchService) AuthorizeVpcEndpointAccessRequest(input *AuthorizeVpcEndpointAccessInput) (req *request.Request, output *AuthorizeVpcEndpointAccessOutput)
func (c *OpenSearchService) AuthorizeVpcEndpointAccessWithContext(ctx aws.Context, input *AuthorizeVpcEndpointAccessInput, opts ...request.Option) (*AuthorizeVpcEndpointAccessOutput, error)
func (c *OpenSearchService) CancelDomainConfigChange(input *CancelDomainConfigChangeInput) (*CancelDomainConfigChangeOutput, error)
func (c *OpenSearchService) CancelDomainConfigChangeRequest(input *CancelDomainConfigChangeInput) (req *request.Request, output *CancelDomainConfigChangeOutput)
func (c *OpenSearchService) CancelDomainConfigChangeWithContext(ctx aws.Context, input *CancelDomainConfigChangeInput, opts ...request.Option) (*CancelDomainConfigChangeOutput, error)
func (c *OpenSearchService) CancelServiceSoftwareUpdate(input *CancelServiceSoftwareUpdateInput) (*CancelServiceSoftwareUpdateOutput, error)
func (c *OpenSearchService) CancelServiceSoftwareUpdateRequest(input *CancelServiceSoftwareUpdateInput) (req *request.Request, output *CancelServiceSoftwareUpdateOutput)
func (c *OpenSearchService) CancelServiceSoftwareUpdateWithContext(ctx aws.Context, input *CancelServiceSoftwareUpdateInput, opts ...request.Option) (*CancelServiceSoftwareUpdateOutput, error)
func (c *OpenSearchService) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)
func (c *OpenSearchService) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)
func (c *OpenSearchService) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)
func (c *OpenSearchService) CreateOutboundConnection(input *CreateOutboundConnectionInput) (*CreateOutboundConnectionOutput, error)
func (c *OpenSearchService) CreateOutboundConnectionRequest(input *CreateOutboundConnectionInput) (req *request.Request, output *CreateOutboundConnectionOutput)
func (c *OpenSearchService) CreateOutboundConnectionWithContext(ctx aws.Context, input *CreateOutboundConnectionInput, opts ...request.Option) (*CreateOutboundConnectionOutput, error)
func (c *OpenSearchService) CreatePackage(input *CreatePackageInput) (*CreatePackageOutput, error)
func (c *OpenSearchService) CreatePackageRequest(input *CreatePackageInput) (req *request.Request, output *CreatePackageOutput)
func (c *OpenSearchService) CreatePackageWithContext(ctx aws.Context, input *CreatePackageInput, opts ...request.Option) (*CreatePackageOutput, error)
func (c *OpenSearchService) CreateVpcEndpoint(input *CreateVpcEndpointInput) (*CreateVpcEndpointOutput, error)
func (c *OpenSearchService) CreateVpcEndpointRequest(input *CreateVpcEndpointInput) (req *request.Request, output *CreateVpcEndpointOutput)
func (c *OpenSearchService) CreateVpcEndpointWithContext(ctx aws.Context, input *CreateVpcEndpointInput, opts ...request.Option) (*CreateVpcEndpointOutput, error)
func (c *OpenSearchService) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)
func (c *OpenSearchService) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)
func (c *OpenSearchService) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)
func (c *OpenSearchService) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)
func (c *OpenSearchService) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)
func (c *OpenSearchService) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)
func (c *OpenSearchService) DeleteInboundConnection(input *DeleteInboundConnectionInput) (*DeleteInboundConnectionOutput, error)
func (c *OpenSearchService) DeleteInboundConnectionRequest(input *DeleteInboundConnectionInput) (req *request.Request, output *DeleteInboundConnectionOutput)
func (c *OpenSearchService) DeleteInboundConnectionWithContext(ctx aws.Context, input *DeleteInboundConnectionInput, opts ...request.Option) (*DeleteInboundConnectionOutput, error)
func (c *OpenSearchService) DeleteOutboundConnection(input *DeleteOutboundConnectionInput) (*DeleteOutboundConnectionOutput, error)
func (c *OpenSearchService) DeleteOutboundConnectionRequest(input *DeleteOutboundConnectionInput) (req *request.Request, output *DeleteOutboundConnectionOutput)
func (c *OpenSearchService) DeleteOutboundConnectionWithContext(ctx aws.Context, input *DeleteOutboundConnectionInput, opts ...request.Option) (*DeleteOutboundConnectionOutput, error)
func (c *OpenSearchService) DeletePackage(input *DeletePackageInput) (*DeletePackageOutput, error)
func (c *OpenSearchService) DeletePackageRequest(input *DeletePackageInput) (req *request.Request, output *DeletePackageOutput)
func (c *OpenSearchService) DeletePackageWithContext(ctx aws.Context, input *DeletePackageInput, opts ...request.Option) (*DeletePackageOutput, error)
func (c *OpenSearchService) DeleteVpcEndpoint(input *DeleteVpcEndpointInput) (*DeleteVpcEndpointOutput, error)
func (c *OpenSearchService) DeleteVpcEndpointRequest(input *DeleteVpcEndpointInput) (req *request.Request, output *DeleteVpcEndpointOutput)
func (c *OpenSearchService) DeleteVpcEndpointWithContext(ctx aws.Context, input *DeleteVpcEndpointInput, opts ...request.Option) (*DeleteVpcEndpointOutput, error)
func (c *OpenSearchService) DescribeDomain(input *DescribeDomainInput) (*DescribeDomainOutput, error)
func (c *OpenSearchService) DescribeDomainAutoTunes(input *DescribeDomainAutoTunesInput) (*DescribeDomainAutoTunesOutput, error)
func (c *OpenSearchService) DescribeDomainAutoTunesPages(input *DescribeDomainAutoTunesInput, fn func(*DescribeDomainAutoTunesOutput, bool) bool) error
func (c *OpenSearchService) DescribeDomainAutoTunesPagesWithContext(ctx aws.Context, input *DescribeDomainAutoTunesInput, fn func(*DescribeDomainAutoTunesOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) DescribeDomainAutoTunesRequest(input *DescribeDomainAutoTunesInput) (req *request.Request, output *DescribeDomainAutoTunesOutput)
func (c *OpenSearchService) DescribeDomainAutoTunesWithContext(ctx aws.Context, input *DescribeDomainAutoTunesInput, opts ...request.Option) (*DescribeDomainAutoTunesOutput, error)
func (c *OpenSearchService) DescribeDomainChangeProgress(input *DescribeDomainChangeProgressInput) (*DescribeDomainChangeProgressOutput, error)
func (c *OpenSearchService) DescribeDomainChangeProgressRequest(input *DescribeDomainChangeProgressInput) (req *request.Request, output *DescribeDomainChangeProgressOutput)
func (c *OpenSearchService) DescribeDomainChangeProgressWithContext(ctx aws.Context, input *DescribeDomainChangeProgressInput, opts ...request.Option) (*DescribeDomainChangeProgressOutput, error)
func (c *OpenSearchService) DescribeDomainConfig(input *DescribeDomainConfigInput) (*DescribeDomainConfigOutput, error)
func (c *OpenSearchService) DescribeDomainConfigRequest(input *DescribeDomainConfigInput) (req *request.Request, output *DescribeDomainConfigOutput)
func (c *OpenSearchService) DescribeDomainConfigWithContext(ctx aws.Context, input *DescribeDomainConfigInput, opts ...request.Option) (*DescribeDomainConfigOutput, error)
func (c *OpenSearchService) DescribeDomainHealth(input *DescribeDomainHealthInput) (*DescribeDomainHealthOutput, error)
func (c *OpenSearchService) DescribeDomainHealthRequest(input *DescribeDomainHealthInput) (req *request.Request, output *DescribeDomainHealthOutput)
func (c *OpenSearchService) DescribeDomainHealthWithContext(ctx aws.Context, input *DescribeDomainHealthInput, opts ...request.Option) (*DescribeDomainHealthOutput, error)
func (c *OpenSearchService) DescribeDomainNodes(input *DescribeDomainNodesInput) (*DescribeDomainNodesOutput, error)
func (c *OpenSearchService) DescribeDomainNodesRequest(input *DescribeDomainNodesInput) (req *request.Request, output *DescribeDomainNodesOutput)
func (c *OpenSearchService) DescribeDomainNodesWithContext(ctx aws.Context, input *DescribeDomainNodesInput, opts ...request.Option) (*DescribeDomainNodesOutput, error)
func (c *OpenSearchService) DescribeDomainRequest(input *DescribeDomainInput) (req *request.Request, output *DescribeDomainOutput)
func (c *OpenSearchService) DescribeDomainWithContext(ctx aws.Context, input *DescribeDomainInput, opts ...request.Option) (*DescribeDomainOutput, error)
func (c *OpenSearchService) DescribeDomains(input *DescribeDomainsInput) (*DescribeDomainsOutput, error)
func (c *OpenSearchService) DescribeDomainsRequest(input *DescribeDomainsInput) (req *request.Request, output *DescribeDomainsOutput)
func (c *OpenSearchService) DescribeDomainsWithContext(ctx aws.Context, input *DescribeDomainsInput, opts ...request.Option) (*DescribeDomainsOutput, error)
func (c *OpenSearchService) DescribeDryRunProgress(input *DescribeDryRunProgressInput) (*DescribeDryRunProgressOutput, error)
func (c *OpenSearchService) DescribeDryRunProgressRequest(input *DescribeDryRunProgressInput) (req *request.Request, output *DescribeDryRunProgressOutput)
func (c *OpenSearchService) DescribeDryRunProgressWithContext(ctx aws.Context, input *DescribeDryRunProgressInput, opts ...request.Option) (*DescribeDryRunProgressOutput, error)
func (c *OpenSearchService) DescribeInboundConnections(input *DescribeInboundConnectionsInput) (*DescribeInboundConnectionsOutput, error)
func (c *OpenSearchService) DescribeInboundConnectionsPages(input *DescribeInboundConnectionsInput, fn func(*DescribeInboundConnectionsOutput, bool) bool) error
func (c *OpenSearchService) DescribeInboundConnectionsPagesWithContext(ctx aws.Context, input *DescribeInboundConnectionsInput, fn func(*DescribeInboundConnectionsOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) DescribeInboundConnectionsRequest(input *DescribeInboundConnectionsInput) (req *request.Request, output *DescribeInboundConnectionsOutput)
func (c *OpenSearchService) DescribeInboundConnectionsWithContext(ctx aws.Context, input *DescribeInboundConnectionsInput, opts ...request.Option) (*DescribeInboundConnectionsOutput, error)
func (c *OpenSearchService) DescribeInstanceTypeLimits(input *DescribeInstanceTypeLimitsInput) (*DescribeInstanceTypeLimitsOutput, error)
func (c *OpenSearchService) DescribeInstanceTypeLimitsRequest(input *DescribeInstanceTypeLimitsInput) (req *request.Request, output *DescribeInstanceTypeLimitsOutput)
func (c *OpenSearchService) DescribeInstanceTypeLimitsWithContext(ctx aws.Context, input *DescribeInstanceTypeLimitsInput, opts ...request.Option) (*DescribeInstanceTypeLimitsOutput, error)
func (c *OpenSearchService) DescribeOutboundConnections(input *DescribeOutboundConnectionsInput) (*DescribeOutboundConnectionsOutput, error)
func (c *OpenSearchService) DescribeOutboundConnectionsPages(input *DescribeOutboundConnectionsInput, fn func(*DescribeOutboundConnectionsOutput, bool) bool) error
func (c *OpenSearchService) DescribeOutboundConnectionsPagesWithContext(ctx aws.Context, input *DescribeOutboundConnectionsInput, fn func(*DescribeOutboundConnectionsOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) DescribeOutboundConnectionsRequest(input *DescribeOutboundConnectionsInput) (req *request.Request, output *DescribeOutboundConnectionsOutput)
func (c *OpenSearchService) DescribeOutboundConnectionsWithContext(ctx aws.Context, input *DescribeOutboundConnectionsInput, opts ...request.Option) (*DescribeOutboundConnectionsOutput, error)
func (c *OpenSearchService) DescribePackages(input *DescribePackagesInput) (*DescribePackagesOutput, error)
func (c *OpenSearchService) DescribePackagesPages(input *DescribePackagesInput, fn func(*DescribePackagesOutput, bool) bool) error
func (c *OpenSearchService) DescribePackagesPagesWithContext(ctx aws.Context, input *DescribePackagesInput, fn func(*DescribePackagesOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) DescribePackagesRequest(input *DescribePackagesInput) (req *request.Request, output *DescribePackagesOutput)
func (c *OpenSearchService) DescribePackagesWithContext(ctx aws.Context, input *DescribePackagesInput, opts ...request.Option) (*DescribePackagesOutput, error)
func (c *OpenSearchService) DescribeReservedInstanceOfferings(input *DescribeReservedInstanceOfferingsInput) (*DescribeReservedInstanceOfferingsOutput, error)
func (c *OpenSearchService) DescribeReservedInstanceOfferingsPages(input *DescribeReservedInstanceOfferingsInput, fn func(*DescribeReservedInstanceOfferingsOutput, bool) bool) error
func (c *OpenSearchService) DescribeReservedInstanceOfferingsPagesWithContext(ctx aws.Context, input *DescribeReservedInstanceOfferingsInput, fn func(*DescribeReservedInstanceOfferingsOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) DescribeReservedInstanceOfferingsRequest(input *DescribeReservedInstanceOfferingsInput) (req *request.Request, output *DescribeReservedInstanceOfferingsOutput)
func (c *OpenSearchService) DescribeReservedInstanceOfferingsWithContext(ctx aws.Context, input *DescribeReservedInstanceOfferingsInput, opts ...request.Option) (*DescribeReservedInstanceOfferingsOutput, error)
func (c *OpenSearchService) DescribeReservedInstances(input *DescribeReservedInstancesInput) (*DescribeReservedInstancesOutput, error)
func (c *OpenSearchService) DescribeReservedInstancesPages(input *DescribeReservedInstancesInput, fn func(*DescribeReservedInstancesOutput, bool) bool) error
func (c *OpenSearchService) DescribeReservedInstancesPagesWithContext(ctx aws.Context, input *DescribeReservedInstancesInput, fn func(*DescribeReservedInstancesOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) DescribeReservedInstancesRequest(input *DescribeReservedInstancesInput) (req *request.Request, output *DescribeReservedInstancesOutput)
func (c *OpenSearchService) DescribeReservedInstancesWithContext(ctx aws.Context, input *DescribeReservedInstancesInput, opts ...request.Option) (*DescribeReservedInstancesOutput, error)
func (c *OpenSearchService) DescribeVpcEndpoints(input *DescribeVpcEndpointsInput) (*DescribeVpcEndpointsOutput, error)
func (c *OpenSearchService) DescribeVpcEndpointsRequest(input *DescribeVpcEndpointsInput) (req *request.Request, output *DescribeVpcEndpointsOutput)
func (c *OpenSearchService) DescribeVpcEndpointsWithContext(ctx aws.Context, input *DescribeVpcEndpointsInput, opts ...request.Option) (*DescribeVpcEndpointsOutput, error)
func (c *OpenSearchService) DissociatePackage(input *DissociatePackageInput) (*DissociatePackageOutput, error)
func (c *OpenSearchService) DissociatePackageRequest(input *DissociatePackageInput) (req *request.Request, output *DissociatePackageOutput)
func (c *OpenSearchService) DissociatePackageWithContext(ctx aws.Context, input *DissociatePackageInput, opts ...request.Option) (*DissociatePackageOutput, error)
func (c *OpenSearchService) GetCompatibleVersions(input *GetCompatibleVersionsInput) (*GetCompatibleVersionsOutput, error)
func (c *OpenSearchService) GetCompatibleVersionsRequest(input *GetCompatibleVersionsInput) (req *request.Request, output *GetCompatibleVersionsOutput)
func (c *OpenSearchService) GetCompatibleVersionsWithContext(ctx aws.Context, input *GetCompatibleVersionsInput, opts ...request.Option) (*GetCompatibleVersionsOutput, error)
func (c *OpenSearchService) GetDataSource(input *GetDataSourceInput) (*GetDataSourceOutput, error)
func (c *OpenSearchService) GetDataSourceRequest(input *GetDataSourceInput) (req *request.Request, output *GetDataSourceOutput)
func (c *OpenSearchService) GetDataSourceWithContext(ctx aws.Context, input *GetDataSourceInput, opts ...request.Option) (*GetDataSourceOutput, error)
func (c *OpenSearchService) GetDomainMaintenanceStatus(input *GetDomainMaintenanceStatusInput) (*GetDomainMaintenanceStatusOutput, error)
func (c *OpenSearchService) GetDomainMaintenanceStatusRequest(input *GetDomainMaintenanceStatusInput) (req *request.Request, output *GetDomainMaintenanceStatusOutput)
func (c *OpenSearchService) GetDomainMaintenanceStatusWithContext(ctx aws.Context, input *GetDomainMaintenanceStatusInput, opts ...request.Option) (*GetDomainMaintenanceStatusOutput, error)
func (c *OpenSearchService) GetPackageVersionHistory(input *GetPackageVersionHistoryInput) (*GetPackageVersionHistoryOutput, error)
func (c *OpenSearchService) GetPackageVersionHistoryPages(input *GetPackageVersionHistoryInput, fn func(*GetPackageVersionHistoryOutput, bool) bool) error
func (c *OpenSearchService) GetPackageVersionHistoryPagesWithContext(ctx aws.Context, input *GetPackageVersionHistoryInput, fn func(*GetPackageVersionHistoryOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) GetPackageVersionHistoryRequest(input *GetPackageVersionHistoryInput) (req *request.Request, output *GetPackageVersionHistoryOutput)
func (c *OpenSearchService) GetPackageVersionHistoryWithContext(ctx aws.Context, input *GetPackageVersionHistoryInput, opts ...request.Option) (*GetPackageVersionHistoryOutput, error)
func (c *OpenSearchService) GetUpgradeHistory(input *GetUpgradeHistoryInput) (*GetUpgradeHistoryOutput, error)
func (c *OpenSearchService) GetUpgradeHistoryPages(input *GetUpgradeHistoryInput, fn func(*GetUpgradeHistoryOutput, bool) bool) error
func (c *OpenSearchService) GetUpgradeHistoryPagesWithContext(ctx aws.Context, input *GetUpgradeHistoryInput, fn func(*GetUpgradeHistoryOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) GetUpgradeHistoryRequest(input *GetUpgradeHistoryInput) (req *request.Request, output *GetUpgradeHistoryOutput)
func (c *OpenSearchService) GetUpgradeHistoryWithContext(ctx aws.Context, input *GetUpgradeHistoryInput, opts ...request.Option) (*GetUpgradeHistoryOutput, error)
func (c *OpenSearchService) GetUpgradeStatus(input *GetUpgradeStatusInput) (*GetUpgradeStatusOutput, error)
func (c *OpenSearchService) GetUpgradeStatusRequest(input *GetUpgradeStatusInput) (req *request.Request, output *GetUpgradeStatusOutput)
func (c *OpenSearchService) GetUpgradeStatusWithContext(ctx aws.Context, input *GetUpgradeStatusInput, opts ...request.Option) (*GetUpgradeStatusOutput, error)
func (c *OpenSearchService) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)
func (c *OpenSearchService) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)
func (c *OpenSearchService) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)
func (c *OpenSearchService) ListDomainMaintenances(input *ListDomainMaintenancesInput) (*ListDomainMaintenancesOutput, error)
func (c *OpenSearchService) ListDomainMaintenancesPages(input *ListDomainMaintenancesInput, fn func(*ListDomainMaintenancesOutput, bool) bool) error
func (c *OpenSearchService) ListDomainMaintenancesPagesWithContext(ctx aws.Context, input *ListDomainMaintenancesInput, fn func(*ListDomainMaintenancesOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) ListDomainMaintenancesRequest(input *ListDomainMaintenancesInput) (req *request.Request, output *ListDomainMaintenancesOutput)
func (c *OpenSearchService) ListDomainMaintenancesWithContext(ctx aws.Context, input *ListDomainMaintenancesInput, opts ...request.Option) (*ListDomainMaintenancesOutput, error)
func (c *OpenSearchService) ListDomainNames(input *ListDomainNamesInput) (*ListDomainNamesOutput, error)
func (c *OpenSearchService) ListDomainNamesRequest(input *ListDomainNamesInput) (req *request.Request, output *ListDomainNamesOutput)
func (c *OpenSearchService) ListDomainNamesWithContext(ctx aws.Context, input *ListDomainNamesInput, opts ...request.Option) (*ListDomainNamesOutput, error)
func (c *OpenSearchService) ListDomainsForPackage(input *ListDomainsForPackageInput) (*ListDomainsForPackageOutput, error)
func (c *OpenSearchService) ListDomainsForPackagePages(input *ListDomainsForPackageInput, fn func(*ListDomainsForPackageOutput, bool) bool) error
func (c *OpenSearchService) ListDomainsForPackagePagesWithContext(ctx aws.Context, input *ListDomainsForPackageInput, fn func(*ListDomainsForPackageOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) ListDomainsForPackageRequest(input *ListDomainsForPackageInput) (req *request.Request, output *ListDomainsForPackageOutput)
func (c *OpenSearchService) ListDomainsForPackageWithContext(ctx aws.Context, input *ListDomainsForPackageInput, opts ...request.Option) (*ListDomainsForPackageOutput, error)
func (c *OpenSearchService) ListInstanceTypeDetails(input *ListInstanceTypeDetailsInput) (*ListInstanceTypeDetailsOutput, error)
func (c *OpenSearchService) ListInstanceTypeDetailsPages(input *ListInstanceTypeDetailsInput, fn func(*ListInstanceTypeDetailsOutput, bool) bool) error
func (c *OpenSearchService) ListInstanceTypeDetailsPagesWithContext(ctx aws.Context, input *ListInstanceTypeDetailsInput, fn func(*ListInstanceTypeDetailsOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) ListInstanceTypeDetailsRequest(input *ListInstanceTypeDetailsInput) (req *request.Request, output *ListInstanceTypeDetailsOutput)
func (c *OpenSearchService) ListInstanceTypeDetailsWithContext(ctx aws.Context, input *ListInstanceTypeDetailsInput, opts ...request.Option) (*ListInstanceTypeDetailsOutput, error)
func (c *OpenSearchService) ListPackagesForDomain(input *ListPackagesForDomainInput) (*ListPackagesForDomainOutput, error)
func (c *OpenSearchService) ListPackagesForDomainPages(input *ListPackagesForDomainInput, fn func(*ListPackagesForDomainOutput, bool) bool) error
func (c *OpenSearchService) ListPackagesForDomainPagesWithContext(ctx aws.Context, input *ListPackagesForDomainInput, fn func(*ListPackagesForDomainOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) ListPackagesForDomainRequest(input *ListPackagesForDomainInput) (req *request.Request, output *ListPackagesForDomainOutput)
func (c *OpenSearchService) ListPackagesForDomainWithContext(ctx aws.Context, input *ListPackagesForDomainInput, opts ...request.Option) (*ListPackagesForDomainOutput, error)
func (c *OpenSearchService) ListScheduledActions(input *ListScheduledActionsInput) (*ListScheduledActionsOutput, error)
func (c *OpenSearchService) ListScheduledActionsPages(input *ListScheduledActionsInput, fn func(*ListScheduledActionsOutput, bool) bool) error
func (c *OpenSearchService) ListScheduledActionsPagesWithContext(ctx aws.Context, input *ListScheduledActionsInput, fn func(*ListScheduledActionsOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) ListScheduledActionsRequest(input *ListScheduledActionsInput) (req *request.Request, output *ListScheduledActionsOutput)
func (c *OpenSearchService) ListScheduledActionsWithContext(ctx aws.Context, input *ListScheduledActionsInput, opts ...request.Option) (*ListScheduledActionsOutput, error)
func (c *OpenSearchService) ListTags(input *ListTagsInput) (*ListTagsOutput, error)
func (c *OpenSearchService) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)
func (c *OpenSearchService) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)
func (c *OpenSearchService) ListVersions(input *ListVersionsInput) (*ListVersionsOutput, error)
func (c *OpenSearchService) ListVersionsPages(input *ListVersionsInput, fn func(*ListVersionsOutput, bool) bool) error
func (c *OpenSearchService) ListVersionsPagesWithContext(ctx aws.Context, input *ListVersionsInput, fn func(*ListVersionsOutput, bool) bool, opts ...request.Option) error
func (c *OpenSearchService) ListVersionsRequest(input *ListVersionsInput) (req *request.Request, output *ListVersionsOutput)
func (c *OpenSearchService) ListVersionsWithContext(ctx aws.Context, input *ListVersionsInput, opts ...request.Option) (*ListVersionsOutput, error)
func (c *OpenSearchService) ListVpcEndpointAccess(input *ListVpcEndpointAccessInput) (*ListVpcEndpointAccessOutput, error)
func (c *OpenSearchService) ListVpcEndpointAccessRequest(input *ListVpcEndpointAccessInput) (req *request.Request, output *ListVpcEndpointAccessOutput)
func (c *OpenSearchService) ListVpcEndpointAccessWithContext(ctx aws.Context, input *ListVpcEndpointAccessInput, opts ...request.Option) (*ListVpcEndpointAccessOutput, error)
func (c *OpenSearchService) ListVpcEndpoints(input *ListVpcEndpointsInput) (*ListVpcEndpointsOutput, error)
func (c *OpenSearchService) ListVpcEndpointsForDomain(input *ListVpcEndpointsForDomainInput) (*ListVpcEndpointsForDomainOutput, error)
func (c *OpenSearchService) ListVpcEndpointsForDomainRequest(input *ListVpcEndpointsForDomainInput) (req *request.Request, output *ListVpcEndpointsForDomainOutput)
func (c *OpenSearchService) ListVpcEndpointsForDomainWithContext(ctx aws.Context, input *ListVpcEndpointsForDomainInput, opts ...request.Option) (*ListVpcEndpointsForDomainOutput, error)
func (c *OpenSearchService) ListVpcEndpointsRequest(input *ListVpcEndpointsInput) (req *request.Request, output *ListVpcEndpointsOutput)
func (c *OpenSearchService) ListVpcEndpointsWithContext(ctx aws.Context, input *ListVpcEndpointsInput, opts ...request.Option) (*ListVpcEndpointsOutput, error)
func (c *OpenSearchService) PurchaseReservedInstanceOffering(input *PurchaseReservedInstanceOfferingInput) (*PurchaseReservedInstanceOfferingOutput, error)
func (c *OpenSearchService) PurchaseReservedInstanceOfferingRequest(input *PurchaseReservedInstanceOfferingInput) (req *request.Request, output *PurchaseReservedInstanceOfferingOutput)
func (c *OpenSearchService) PurchaseReservedInstanceOfferingWithContext(ctx aws.Context, input *PurchaseReservedInstanceOfferingInput, opts ...request.Option) (*PurchaseReservedInstanceOfferingOutput, error)
func (c *OpenSearchService) RejectInboundConnection(input *RejectInboundConnectionInput) (*RejectInboundConnectionOutput, error)
func (c *OpenSearchService) RejectInboundConnectionRequest(input *RejectInboundConnectionInput) (req *request.Request, output *RejectInboundConnectionOutput)
func (c *OpenSearchService) RejectInboundConnectionWithContext(ctx aws.Context, input *RejectInboundConnectionInput, opts ...request.Option) (*RejectInboundConnectionOutput, error)
func (c *OpenSearchService) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error)
func (c *OpenSearchService) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput)
func (c *OpenSearchService) RemoveTagsWithContext(ctx aws.Context, input *RemoveTagsInput, opts ...request.Option) (*RemoveTagsOutput, error)
func (c *OpenSearchService) RevokeVpcEndpointAccess(input *RevokeVpcEndpointAccessInput) (*RevokeVpcEndpointAccessOutput, error)
func (c *OpenSearchService) RevokeVpcEndpointAccessRequest(input *RevokeVpcEndpointAccessInput) (req *request.Request, output *RevokeVpcEndpointAccessOutput)
func (c *OpenSearchService) RevokeVpcEndpointAccessWithContext(ctx aws.Context, input *RevokeVpcEndpointAccessInput, opts ...request.Option) (*RevokeVpcEndpointAccessOutput, error)
func (c *OpenSearchService) StartDomainMaintenance(input *StartDomainMaintenanceInput) (*StartDomainMaintenanceOutput, error)
func (c *OpenSearchService) StartDomainMaintenanceRequest(input *StartDomainMaintenanceInput) (req *request.Request, output *StartDomainMaintenanceOutput)
func (c *OpenSearchService) StartDomainMaintenanceWithContext(ctx aws.Context, input *StartDomainMaintenanceInput, opts ...request.Option) (*StartDomainMaintenanceOutput, error)
func (c *OpenSearchService) StartServiceSoftwareUpdate(input *StartServiceSoftwareUpdateInput) (*StartServiceSoftwareUpdateOutput, error)
func (c *OpenSearchService) StartServiceSoftwareUpdateRequest(input *StartServiceSoftwareUpdateInput) (req *request.Request, output *StartServiceSoftwareUpdateOutput)
func (c *OpenSearchService) StartServiceSoftwareUpdateWithContext(ctx aws.Context, input *StartServiceSoftwareUpdateInput, opts ...request.Option) (*StartServiceSoftwareUpdateOutput, error)
func (c *OpenSearchService) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)
func (c *OpenSearchService) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)
func (c *OpenSearchService) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)
func (c *OpenSearchService) UpdateDomainConfig(input *UpdateDomainConfigInput) (*UpdateDomainConfigOutput, error)
func (c *OpenSearchService) UpdateDomainConfigRequest(input *UpdateDomainConfigInput) (req *request.Request, output *UpdateDomainConfigOutput)
func (c *OpenSearchService) UpdateDomainConfigWithContext(ctx aws.Context, input *UpdateDomainConfigInput, opts ...request.Option) (*UpdateDomainConfigOutput, error)
func (c *OpenSearchService) UpdatePackage(input *UpdatePackageInput) (*UpdatePackageOutput, error)
func (c *OpenSearchService) UpdatePackageRequest(input *UpdatePackageInput) (req *request.Request, output *UpdatePackageOutput)
func (c *OpenSearchService) UpdatePackageWithContext(ctx aws.Context, input *UpdatePackageInput, opts ...request.Option) (*UpdatePackageOutput, error)
func (c *OpenSearchService) UpdateScheduledAction(input *UpdateScheduledActionInput) (*UpdateScheduledActionOutput, error)
func (c *OpenSearchService) UpdateScheduledActionRequest(input *UpdateScheduledActionInput) (req *request.Request, output *UpdateScheduledActionOutput)
func (c *OpenSearchService) UpdateScheduledActionWithContext(ctx aws.Context, input *UpdateScheduledActionInput, opts ...request.Option) (*UpdateScheduledActionOutput, error)
func (c *OpenSearchService) UpdateVpcEndpoint(input *UpdateVpcEndpointInput) (*UpdateVpcEndpointOutput, error)
func (c *OpenSearchService) UpdateVpcEndpointRequest(input *UpdateVpcEndpointInput) (req *request.Request, output *UpdateVpcEndpointOutput)
func (c *OpenSearchService) UpdateVpcEndpointWithContext(ctx aws.Context, input *UpdateVpcEndpointInput, opts ...request.Option) (*UpdateVpcEndpointOutput, error)
func (c *OpenSearchService) UpgradeDomain(input *UpgradeDomainInput) (*UpgradeDomainOutput, error)
func (c *OpenSearchService) UpgradeDomainRequest(input *UpgradeDomainInput) (req *request.Request, output *UpgradeDomainOutput)
func (c *OpenSearchService) UpgradeDomainWithContext(ctx aws.Context, input *UpgradeDomainInput, opts ...request.Option) (*UpgradeDomainOutput, error)
func ActionSeverity_Values() []string
func ActionStatus_Values() []string
func ActionType_Values() []string
func AutoTuneDesiredState_Values() []string
func AutoTuneState_Values() []string
func AutoTuneType_Values() []string
func ConfigChangeStatus_Values() []string
func ConnectionMode_Values() []string
func DataSourceStatus_Values() []string
func DeploymentStatus_Values() []string
func DescribePackagesFilterName_Values() []string
func DomainHealth_Values() []string
func DomainPackageStatus_Values() []string
func DomainProcessingStatusType_Values() []string
func DomainState_Values() []string
func DryRunMode_Values() []string
func EngineType_Values() []string
func IPAddressType_Values() []string
func InboundConnectionStatusCode_Values() []string
func InitiatedBy_Values() []string
func LogType_Values() []string
func MaintenanceStatus_Values() []string
func MaintenanceType_Values() []string
func MasterNodeStatus_Values() []string
func NaturalLanguageQueryGenerationCurrentState_Values() []string
func NaturalLanguageQueryGenerationDesiredState_Values() []string
func NodeStatus_Values() []string
func NodeType_Values() []string
func OpenSearchPartitionInstanceType_Values() []string
func OpenSearchWarmPartitionInstanceType_Values() []string
func OptionState_Values() []string
func OutboundConnectionStatusCode_Values() []string
func OverallChangeStatus_Values() []string
func PackageStatus_Values() []string
func PackageType_Values() []string
func PrincipalType_Values() []string
func PropertyValueType_Values() []string
func ReservedInstancePaymentOption_Values() []string
func RollbackOnDisable_Values() []string
func ScheduleAt_Values() []string
func ScheduledAutoTuneActionType_Values() []string
func ScheduledAutoTuneSeverityType_Values() []string
func ScheduledBy_Values() []string
func SkipUnavailableStatus_Values() []string
func TLSSecurityPolicy_Values() []string
func TimeUnit_Values() []string
func UpgradeStatus_Values() []string
func UpgradeStep_Values() []string
func VolumeType_Values() []string
func VpcEndpointErrorCode_Values() []string
func VpcEndpointStatus_Values() []string
func ZoneStatus_Values() []string
type AIMLOptionsInput_
type AIMLOptionsOutput_
type AIMLOptionsStatus
type AWSDomainInformation
type AcceptInboundConnectionInput
type AcceptInboundConnectionOutput
type AccessDeniedException
type AccessPoliciesStatus
type AddDataSourceInput
type AddDataSourceOutput
type AddTagsInput
type AddTagsOutput
type AdditionalLimit
type AdvancedOptionsStatus
type AdvancedSecurityOptions
type AdvancedSecurityOptionsInput_
type AdvancedSecurityOptionsStatus
type AssociatePackageInput
type AssociatePackageOutput
type AuthorizeVpcEndpointAccessInput
type AuthorizeVpcEndpointAccessOutput
type AuthorizedPrincipal
type AutoTune
type AutoTuneDetails
type AutoTuneMaintenanceSchedule
type AutoTuneOptions
type AutoTuneOptionsInput_
type AutoTuneOptionsOutput_
type AutoTuneOptionsStatus
type AutoTuneStatus
type AvailabilityZoneInfo
type BaseException
type CancelDomainConfigChangeInput
type CancelDomainConfigChangeOutput
type CancelServiceSoftwareUpdateInput
type CancelServiceSoftwareUpdateOutput
type CancelledChangeProperty
type ChangeProgressDetails
type ChangeProgressStage
type ChangeProgressStatusDetails
type ClusterConfig
type ClusterConfigStatus
type CognitoOptions
type CognitoOptionsStatus
type ColdStorageOptions
type CompatibleVersionsMap
type ConflictException
type ConnectionProperties
type CreateDomainInput
type CreateDomainOutput
type CreateOutboundConnectionInput
type CreateOutboundConnectionOutput
type CreatePackageInput
type CreatePackageOutput
type CreateVpcEndpointInput
type CreateVpcEndpointOutput
type CrossClusterSearchConnectionProperties
type DataSourceDetails
type DataSourceType
type DeleteDataSourceInput
type DeleteDataSourceOutput
type DeleteDomainInput
type DeleteDomainOutput
type DeleteInboundConnectionInput
type DeleteInboundConnectionOutput
type DeleteOutboundConnectionInput
type DeleteOutboundConnectionOutput
type DeletePackageInput
type DeletePackageOutput
type DeleteVpcEndpointInput
type DeleteVpcEndpointOutput
type DependencyFailureException
type DescribeDomainAutoTunesInput
type DescribeDomainAutoTunesOutput
type DescribeDomainChangeProgressInput
type DescribeDomainChangeProgressOutput
type DescribeDomainConfigInput
type DescribeDomainConfigOutput
type DescribeDomainHealthInput
type DescribeDomainHealthOutput
type DescribeDomainInput
type DescribeDomainNodesInput
type DescribeDomainNodesOutput
type DescribeDomainOutput
type DescribeDomainsInput
type DescribeDomainsOutput
type DescribeDryRunProgressInput
type DescribeDryRunProgressOutput
type DescribeInboundConnectionsInput
type DescribeInboundConnectionsOutput
type DescribeInstanceTypeLimitsInput
type DescribeInstanceTypeLimitsOutput
type DescribeOutboundConnectionsInput
type DescribeOutboundConnectionsOutput
type DescribePackagesFilter
type DescribePackagesInput
type DescribePackagesOutput
type DescribeReservedInstanceOfferingsInput
type DescribeReservedInstanceOfferingsOutput
type DescribeReservedInstancesInput
type DescribeReservedInstancesOutput
type DescribeVpcEndpointsInput
type DescribeVpcEndpointsOutput
type DisabledOperationException
type DissociatePackageInput
type DissociatePackageOutput
type DomainConfig
type DomainEndpointOptions
type DomainEndpointOptionsStatus
type DomainInfo
type DomainInformationContainer
type DomainMaintenanceDetails
type DomainNodesStatus
type DomainPackageDetails
type DomainStatus
type DryRunProgressStatus
type DryRunResults
type Duration
type EBSOptions
type EBSOptionsStatus
type EncryptionAtRestOptions
type EncryptionAtRestOptionsStatus
type EnvironmentInfo
type ErrorDetails
type Filter
type GetCompatibleVersionsInput
type GetCompatibleVersionsOutput
type GetDataSourceInput
type GetDataSourceOutput
type GetDomainMaintenanceStatusInput
type GetDomainMaintenanceStatusOutput
type GetPackageVersionHistoryInput
type GetPackageVersionHistoryOutput
type GetUpgradeHistoryInput
type GetUpgradeHistoryOutput
type GetUpgradeStatusInput
type GetUpgradeStatusOutput
type IPAddressTypeStatus
type InboundConnection
type InboundConnectionStatus
type InstanceCountLimits
type InstanceLimits
type InstanceTypeDetails
type InternalException
type InvalidPaginationTokenException
type InvalidTypeException
type JWTOptionsInput_
type JWTOptionsOutput_
type LimitExceededException
type Limits
type ListDataSourcesInput
type ListDataSourcesOutput
type ListDomainMaintenancesInput
type ListDomainMaintenancesOutput
type ListDomainNamesInput
type ListDomainNamesOutput
type ListDomainsForPackageInput
type ListDomainsForPackageOutput
type ListInstanceTypeDetailsInput
type ListInstanceTypeDetailsOutput
type ListPackagesForDomainInput
type ListPackagesForDomainOutput
type ListScheduledActionsInput
type ListScheduledActionsOutput
type ListTagsInput
type ListTagsOutput
type ListVersionsInput
type ListVersionsOutput
type ListVpcEndpointAccessInput
type ListVpcEndpointAccessOutput
type ListVpcEndpointsForDomainInput
type ListVpcEndpointsForDomainOutput
type ListVpcEndpointsInput
type ListVpcEndpointsOutput
type LogPublishingOption
type LogPublishingOptionsStatus
type MasterUserOptions
type ModifyingProperties
type NaturalLanguageQueryGenerationOptionsInput_
type NaturalLanguageQueryGenerationOptionsOutput_
type NodeToNodeEncryptionOptions
type NodeToNodeEncryptionOptionsStatus
type OffPeakWindow
type OffPeakWindowOptions
type OffPeakWindowOptionsStatus
type OptionStatus
type OutboundConnection
type OutboundConnectionStatus
type PackageDetails
type PackageSource
type PackageVersionHistory
type PluginProperties
type PurchaseReservedInstanceOfferingInput
type PurchaseReservedInstanceOfferingOutput
type RecurringCharge
type RejectInboundConnectionInput
type RejectInboundConnectionOutput
type RemoveTagsInput
type RemoveTagsOutput
type ReservedInstance
type ReservedInstanceOffering
type ResourceAlreadyExistsException
type ResourceNotFoundException
type RevokeVpcEndpointAccessInput
type RevokeVpcEndpointAccessOutput
type S3GlueDataCatalog
type SAMLIdp
type SAMLOptionsInput_
type SAMLOptionsOutput_
type ScheduledAction
type ScheduledAutoTuneDetails
type ServiceSoftwareOptions
type SlotNotAvailableException
type SnapshotOptions
type SnapshotOptionsStatus
type SoftwareUpdateOptions
type SoftwareUpdateOptionsStatus
type StartDomainMaintenanceInput
type StartDomainMaintenanceOutput
type StartServiceSoftwareUpdateInput
type StartServiceSoftwareUpdateOutput
type StorageType
type StorageTypeLimit
type Tag
type UpdateDataSourceInput
type UpdateDataSourceOutput
type UpdateDomainConfigInput
type UpdateDomainConfigOutput
type UpdatePackageInput
type UpdatePackageOutput
type UpdateScheduledActionInput
type UpdateScheduledActionOutput
type UpdateVpcEndpointInput
type UpdateVpcEndpointOutput
type UpgradeDomainInput
type UpgradeDomainOutput
type UpgradeHistory
type UpgradeStepItem
type VPCDerivedInfo
type VPCDerivedInfoStatus
type VPCOptions
type ValidationException
type ValidationFailure
type VersionStatus
type VpcEndpoint
type VpcEndpointError
type VpcEndpointSummary
type WindowStartTime
type ZoneAwarenessConfig

Constants ▾

const (
    // ActionSeverityHigh is a ActionSeverity enum value
    ActionSeverityHigh = "HIGH"

    // ActionSeverityMedium is a ActionSeverity enum value
    ActionSeverityMedium = "MEDIUM"

    // ActionSeverityLow is a ActionSeverity enum value
    ActionSeverityLow = "LOW"
)
const (
    // ActionStatusPendingUpdate is a ActionStatus enum value
    ActionStatusPendingUpdate = "PENDING_UPDATE"

    // ActionStatusInProgress is a ActionStatus enum value
    ActionStatusInProgress = "IN_PROGRESS"

    // ActionStatusFailed is a ActionStatus enum value
    ActionStatusFailed = "FAILED"

    // ActionStatusCompleted is a ActionStatus enum value
    ActionStatusCompleted = "COMPLETED"

    // ActionStatusNotEligible is a ActionStatus enum value
    ActionStatusNotEligible = "NOT_ELIGIBLE"

    // ActionStatusEligible is a ActionStatus enum value
    ActionStatusEligible = "ELIGIBLE"
)
const (
    // ActionTypeServiceSoftwareUpdate is a ActionType enum value
    ActionTypeServiceSoftwareUpdate = "SERVICE_SOFTWARE_UPDATE"

    // ActionTypeJvmHeapSizeTuning is a ActionType enum value
    ActionTypeJvmHeapSizeTuning = "JVM_HEAP_SIZE_TUNING"

    // ActionTypeJvmYoungGenTuning is a ActionType enum value
    ActionTypeJvmYoungGenTuning = "JVM_YOUNG_GEN_TUNING"
)
const (
    // AutoTuneDesiredStateEnabled is a AutoTuneDesiredState enum value
    AutoTuneDesiredStateEnabled = "ENABLED"

    // AutoTuneDesiredStateDisabled is a AutoTuneDesiredState enum value
    AutoTuneDesiredStateDisabled = "DISABLED"
)

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

const (
    // AutoTuneStateEnabled is a AutoTuneState enum value
    AutoTuneStateEnabled = "ENABLED"

    // AutoTuneStateDisabled is a AutoTuneState enum value
    AutoTuneStateDisabled = "DISABLED"

    // AutoTuneStateEnableInProgress is a AutoTuneState enum value
    AutoTuneStateEnableInProgress = "ENABLE_IN_PROGRESS"

    // AutoTuneStateDisableInProgress is a AutoTuneState enum value
    AutoTuneStateDisableInProgress = "DISABLE_IN_PROGRESS"

    // AutoTuneStateDisabledAndRollbackScheduled is a AutoTuneState enum value
    AutoTuneStateDisabledAndRollbackScheduled = "DISABLED_AND_ROLLBACK_SCHEDULED"

    // AutoTuneStateDisabledAndRollbackInProgress is a AutoTuneState enum value
    AutoTuneStateDisabledAndRollbackInProgress = "DISABLED_AND_ROLLBACK_IN_PROGRESS"

    // AutoTuneStateDisabledAndRollbackComplete is a AutoTuneState enum value
    AutoTuneStateDisabledAndRollbackComplete = "DISABLED_AND_ROLLBACK_COMPLETE"

    // AutoTuneStateDisabledAndRollbackError is a AutoTuneState enum value
    AutoTuneStateDisabledAndRollbackError = "DISABLED_AND_ROLLBACK_ERROR"

    // AutoTuneStateError is a AutoTuneState enum value
    AutoTuneStateError = "ERROR"
)

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

const (
    // ConfigChangeStatusPending is a ConfigChangeStatus enum value
    ConfigChangeStatusPending = "Pending"

    // ConfigChangeStatusInitializing is a ConfigChangeStatus enum value
    ConfigChangeStatusInitializing = "Initializing"

    // ConfigChangeStatusValidating is a ConfigChangeStatus enum value
    ConfigChangeStatusValidating = "Validating"

    // ConfigChangeStatusValidationFailed is a ConfigChangeStatus enum value
    ConfigChangeStatusValidationFailed = "ValidationFailed"

    // ConfigChangeStatusApplyingChanges is a ConfigChangeStatus enum value
    ConfigChangeStatusApplyingChanges = "ApplyingChanges"

    // ConfigChangeStatusCompleted is a ConfigChangeStatus enum value
    ConfigChangeStatusCompleted = "Completed"

    // ConfigChangeStatusPendingUserInput is a ConfigChangeStatus enum value
    ConfigChangeStatusPendingUserInput = "PendingUserInput"

    // ConfigChangeStatusCancelled is a ConfigChangeStatus enum value
    ConfigChangeStatusCancelled = "Cancelled"
)
const (
    // ConnectionModeDirect is a ConnectionMode enum value
    ConnectionModeDirect = "DIRECT"

    // ConnectionModeVpcEndpoint is a ConnectionMode enum value
    ConnectionModeVpcEndpoint = "VPC_ENDPOINT"
)

The connection mode for the cross-cluster connection.

  • DIRECT - Used for cross-cluster search or cross-cluster replication.

  • VPC_ENDPOINT - Used for remote reindex between Amazon OpenSearch Service VPC domains.

const (
    // DataSourceStatusActive is a DataSourceStatus enum value
    DataSourceStatusActive = "ACTIVE"

    // DataSourceStatusDisabled is a DataSourceStatus enum value
    DataSourceStatusDisabled = "DISABLED"
)
const (
    // DeploymentStatusPendingUpdate is a DeploymentStatus enum value
    DeploymentStatusPendingUpdate = "PENDING_UPDATE"

    // DeploymentStatusInProgress is a DeploymentStatus enum value
    DeploymentStatusInProgress = "IN_PROGRESS"

    // DeploymentStatusCompleted is a DeploymentStatus enum value
    DeploymentStatusCompleted = "COMPLETED"

    // DeploymentStatusNotEligible is a DeploymentStatus enum value
    DeploymentStatusNotEligible = "NOT_ELIGIBLE"

    // DeploymentStatusEligible is a DeploymentStatus enum value
    DeploymentStatusEligible = "ELIGIBLE"
)
const (
    // DescribePackagesFilterNamePackageId is a DescribePackagesFilterName enum value
    DescribePackagesFilterNamePackageId = "PackageID"

    // DescribePackagesFilterNamePackageName is a DescribePackagesFilterName enum value
    DescribePackagesFilterNamePackageName = "PackageName"

    // DescribePackagesFilterNamePackageStatus is a DescribePackagesFilterName enum value
    DescribePackagesFilterNamePackageStatus = "PackageStatus"

    // DescribePackagesFilterNamePackageType is a DescribePackagesFilterName enum value
    DescribePackagesFilterNamePackageType = "PackageType"

    // DescribePackagesFilterNameEngineVersion is a DescribePackagesFilterName enum value
    DescribePackagesFilterNameEngineVersion = "EngineVersion"
)
const (
    // DomainHealthRed is a DomainHealth enum value
    DomainHealthRed = "Red"

    // DomainHealthYellow is a DomainHealth enum value
    DomainHealthYellow = "Yellow"

    // DomainHealthGreen is a DomainHealth enum value
    DomainHealthGreen = "Green"

    // DomainHealthNotAvailable is a DomainHealth enum value
    DomainHealthNotAvailable = "NotAvailable"
)
const (
    // DomainPackageStatusAssociating is a DomainPackageStatus enum value
    DomainPackageStatusAssociating = "ASSOCIATING"

    // DomainPackageStatusAssociationFailed is a DomainPackageStatus enum value
    DomainPackageStatusAssociationFailed = "ASSOCIATION_FAILED"

    // DomainPackageStatusActive is a DomainPackageStatus enum value
    DomainPackageStatusActive = "ACTIVE"

    // DomainPackageStatusDissociating is a DomainPackageStatus enum value
    DomainPackageStatusDissociating = "DISSOCIATING"

    // DomainPackageStatusDissociationFailed is a DomainPackageStatus enum value
    DomainPackageStatusDissociationFailed = "DISSOCIATION_FAILED"
)
const (
    // DomainProcessingStatusTypeCreating is a DomainProcessingStatusType enum value
    DomainProcessingStatusTypeCreating = "Creating"

    // DomainProcessingStatusTypeActive is a DomainProcessingStatusType enum value
    DomainProcessingStatusTypeActive = "Active"

    // DomainProcessingStatusTypeModifying is a DomainProcessingStatusType enum value
    DomainProcessingStatusTypeModifying = "Modifying"

    // DomainProcessingStatusTypeUpgradingEngineVersion is a DomainProcessingStatusType enum value
    DomainProcessingStatusTypeUpgradingEngineVersion = "UpgradingEngineVersion"

    // DomainProcessingStatusTypeUpdatingServiceSoftware is a DomainProcessingStatusType enum value
    DomainProcessingStatusTypeUpdatingServiceSoftware = "UpdatingServiceSoftware"

    // DomainProcessingStatusTypeIsolated is a DomainProcessingStatusType enum value
    DomainProcessingStatusTypeIsolated = "Isolated"

    // DomainProcessingStatusTypeDeleting is a DomainProcessingStatusType enum value
    DomainProcessingStatusTypeDeleting = "Deleting"
)
const (
    // DomainStateActive is a DomainState enum value
    DomainStateActive = "Active"

    // DomainStateProcessing is a DomainState enum value
    DomainStateProcessing = "Processing"

    // DomainStateNotAvailable is a DomainState enum value
    DomainStateNotAvailable = "NotAvailable"
)
const (
    // DryRunModeBasic is a DryRunMode enum value
    DryRunModeBasic = "Basic"

    // DryRunModeVerbose is a DryRunMode enum value
    DryRunModeVerbose = "Verbose"
)
const (
    // EngineTypeOpenSearch is a EngineType enum value
    EngineTypeOpenSearch = "OpenSearch"

    // EngineTypeElasticsearch is a EngineType enum value
    EngineTypeElasticsearch = "Elasticsearch"
)
const (
    // IPAddressTypeIpv4 is a IPAddressType enum value
    IPAddressTypeIpv4 = "ipv4"

    // IPAddressTypeDualstack is a IPAddressType enum value
    IPAddressTypeDualstack = "dualstack"
)
const (
    // InboundConnectionStatusCodePendingAcceptance is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodePendingAcceptance = "PENDING_ACCEPTANCE"

    // InboundConnectionStatusCodeApproved is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodeApproved = "APPROVED"

    // InboundConnectionStatusCodeProvisioning is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodeProvisioning = "PROVISIONING"

    // InboundConnectionStatusCodeActive is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodeActive = "ACTIVE"

    // InboundConnectionStatusCodeRejecting is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodeRejecting = "REJECTING"

    // InboundConnectionStatusCodeRejected is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodeRejected = "REJECTED"

    // InboundConnectionStatusCodeDeleting is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodeDeleting = "DELETING"

    // InboundConnectionStatusCodeDeleted is a InboundConnectionStatusCode enum value
    InboundConnectionStatusCodeDeleted = "DELETED"
)
const (
    // InitiatedByCustomer is a InitiatedBy enum value
    InitiatedByCustomer = "CUSTOMER"

    // InitiatedByService is a InitiatedBy enum value
    InitiatedByService = "SERVICE"
)
const (
    // LogTypeIndexSlowLogs is a LogType enum value
    LogTypeIndexSlowLogs = "INDEX_SLOW_LOGS"

    // LogTypeSearchSlowLogs is a LogType enum value
    LogTypeSearchSlowLogs = "SEARCH_SLOW_LOGS"

    // LogTypeEsApplicationLogs is a LogType enum value
    LogTypeEsApplicationLogs = "ES_APPLICATION_LOGS"

    // LogTypeAuditLogs is a LogType enum value
    LogTypeAuditLogs = "AUDIT_LOGS"
)

The type of log file. Can be one of the following:

  • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

  • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

  • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

  • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

const (
    // MaintenanceStatusPending is a MaintenanceStatus enum value
    MaintenanceStatusPending = "PENDING"

    // MaintenanceStatusInProgress is a MaintenanceStatus enum value
    MaintenanceStatusInProgress = "IN_PROGRESS"

    // MaintenanceStatusCompleted is a MaintenanceStatus enum value
    MaintenanceStatusCompleted = "COMPLETED"

    // MaintenanceStatusFailed is a MaintenanceStatus enum value
    MaintenanceStatusFailed = "FAILED"

    // MaintenanceStatusTimedOut is a MaintenanceStatus enum value
    MaintenanceStatusTimedOut = "TIMED_OUT"
)
const (
    // MaintenanceTypeRebootNode is a MaintenanceType enum value
    MaintenanceTypeRebootNode = "REBOOT_NODE"

    // MaintenanceTypeRestartSearchProcess is a MaintenanceType enum value
    MaintenanceTypeRestartSearchProcess = "RESTART_SEARCH_PROCESS"

    // MaintenanceTypeRestartDashboard is a MaintenanceType enum value
    MaintenanceTypeRestartDashboard = "RESTART_DASHBOARD"
)
const (
    // MasterNodeStatusAvailable is a MasterNodeStatus enum value
    MasterNodeStatusAvailable = "Available"

    // MasterNodeStatusUnAvailable is a MasterNodeStatus enum value
    MasterNodeStatusUnAvailable = "UnAvailable"
)
const (
    // NaturalLanguageQueryGenerationCurrentStateNotEnabled is a NaturalLanguageQueryGenerationCurrentState enum value
    NaturalLanguageQueryGenerationCurrentStateNotEnabled = "NOT_ENABLED"

    // NaturalLanguageQueryGenerationCurrentStateEnableComplete is a NaturalLanguageQueryGenerationCurrentState enum value
    NaturalLanguageQueryGenerationCurrentStateEnableComplete = "ENABLE_COMPLETE"

    // NaturalLanguageQueryGenerationCurrentStateEnableInProgress is a NaturalLanguageQueryGenerationCurrentState enum value
    NaturalLanguageQueryGenerationCurrentStateEnableInProgress = "ENABLE_IN_PROGRESS"

    // NaturalLanguageQueryGenerationCurrentStateEnableFailed is a NaturalLanguageQueryGenerationCurrentState enum value
    NaturalLanguageQueryGenerationCurrentStateEnableFailed = "ENABLE_FAILED"

    // NaturalLanguageQueryGenerationCurrentStateDisableComplete is a NaturalLanguageQueryGenerationCurrentState enum value
    NaturalLanguageQueryGenerationCurrentStateDisableComplete = "DISABLE_COMPLETE"

    // NaturalLanguageQueryGenerationCurrentStateDisableInProgress is a NaturalLanguageQueryGenerationCurrentState enum value
    NaturalLanguageQueryGenerationCurrentStateDisableInProgress = "DISABLE_IN_PROGRESS"

    // NaturalLanguageQueryGenerationCurrentStateDisableFailed is a NaturalLanguageQueryGenerationCurrentState enum value
    NaturalLanguageQueryGenerationCurrentStateDisableFailed = "DISABLE_FAILED"
)
const (
    // NaturalLanguageQueryGenerationDesiredStateEnabled is a NaturalLanguageQueryGenerationDesiredState enum value
    NaturalLanguageQueryGenerationDesiredStateEnabled = "ENABLED"

    // NaturalLanguageQueryGenerationDesiredStateDisabled is a NaturalLanguageQueryGenerationDesiredState enum value
    NaturalLanguageQueryGenerationDesiredStateDisabled = "DISABLED"
)
const (
    // NodeStatusActive is a NodeStatus enum value
    NodeStatusActive = "Active"

    // NodeStatusStandBy is a NodeStatus enum value
    NodeStatusStandBy = "StandBy"

    // NodeStatusNotAvailable is a NodeStatus enum value
    NodeStatusNotAvailable = "NotAvailable"
)
const (
    // NodeTypeData is a NodeType enum value
    NodeTypeData = "Data"

    // NodeTypeUltrawarm is a NodeType enum value
    NodeTypeUltrawarm = "Ultrawarm"

    // NodeTypeMaster is a NodeType enum value
    NodeTypeMaster = "Master"
)
const (
    // OpenSearchPartitionInstanceTypeM3MediumSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM3MediumSearch = "m3.medium.search"

    // OpenSearchPartitionInstanceTypeM3LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM3LargeSearch = "m3.large.search"

    // OpenSearchPartitionInstanceTypeM3XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM3XlargeSearch = "m3.xlarge.search"

    // OpenSearchPartitionInstanceTypeM32xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM32xlargeSearch = "m3.2xlarge.search"

    // OpenSearchPartitionInstanceTypeM4LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM4LargeSearch = "m4.large.search"

    // OpenSearchPartitionInstanceTypeM4XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM4XlargeSearch = "m4.xlarge.search"

    // OpenSearchPartitionInstanceTypeM42xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM42xlargeSearch = "m4.2xlarge.search"

    // OpenSearchPartitionInstanceTypeM44xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM44xlargeSearch = "m4.4xlarge.search"

    // OpenSearchPartitionInstanceTypeM410xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM410xlargeSearch = "m4.10xlarge.search"

    // OpenSearchPartitionInstanceTypeM5LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM5LargeSearch = "m5.large.search"

    // OpenSearchPartitionInstanceTypeM5XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM5XlargeSearch = "m5.xlarge.search"

    // OpenSearchPartitionInstanceTypeM52xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM52xlargeSearch = "m5.2xlarge.search"

    // OpenSearchPartitionInstanceTypeM54xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM54xlargeSearch = "m5.4xlarge.search"

    // OpenSearchPartitionInstanceTypeM512xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM512xlargeSearch = "m5.12xlarge.search"

    // OpenSearchPartitionInstanceTypeM524xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM524xlargeSearch = "m5.24xlarge.search"

    // OpenSearchPartitionInstanceTypeR5LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR5LargeSearch = "r5.large.search"

    // OpenSearchPartitionInstanceTypeR5XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR5XlargeSearch = "r5.xlarge.search"

    // OpenSearchPartitionInstanceTypeR52xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR52xlargeSearch = "r5.2xlarge.search"

    // OpenSearchPartitionInstanceTypeR54xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR54xlargeSearch = "r5.4xlarge.search"

    // OpenSearchPartitionInstanceTypeR512xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR512xlargeSearch = "r5.12xlarge.search"

    // OpenSearchPartitionInstanceTypeR524xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR524xlargeSearch = "r5.24xlarge.search"

    // OpenSearchPartitionInstanceTypeC5LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC5LargeSearch = "c5.large.search"

    // OpenSearchPartitionInstanceTypeC5XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC5XlargeSearch = "c5.xlarge.search"

    // OpenSearchPartitionInstanceTypeC52xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC52xlargeSearch = "c5.2xlarge.search"

    // OpenSearchPartitionInstanceTypeC54xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC54xlargeSearch = "c5.4xlarge.search"

    // OpenSearchPartitionInstanceTypeC59xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC59xlargeSearch = "c5.9xlarge.search"

    // OpenSearchPartitionInstanceTypeC518xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC518xlargeSearch = "c5.18xlarge.search"

    // OpenSearchPartitionInstanceTypeT3NanoSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT3NanoSearch = "t3.nano.search"

    // OpenSearchPartitionInstanceTypeT3MicroSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT3MicroSearch = "t3.micro.search"

    // OpenSearchPartitionInstanceTypeT3SmallSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT3SmallSearch = "t3.small.search"

    // OpenSearchPartitionInstanceTypeT3MediumSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT3MediumSearch = "t3.medium.search"

    // OpenSearchPartitionInstanceTypeT3LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT3LargeSearch = "t3.large.search"

    // OpenSearchPartitionInstanceTypeT3XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT3XlargeSearch = "t3.xlarge.search"

    // OpenSearchPartitionInstanceTypeT32xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT32xlargeSearch = "t3.2xlarge.search"

    // OpenSearchPartitionInstanceTypeOr1MediumSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr1MediumSearch = "or1.medium.search"

    // OpenSearchPartitionInstanceTypeOr1LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr1LargeSearch = "or1.large.search"

    // OpenSearchPartitionInstanceTypeOr1XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr1XlargeSearch = "or1.xlarge.search"

    // OpenSearchPartitionInstanceTypeOr12xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr12xlargeSearch = "or1.2xlarge.search"

    // OpenSearchPartitionInstanceTypeOr14xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr14xlargeSearch = "or1.4xlarge.search"

    // OpenSearchPartitionInstanceTypeOr18xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr18xlargeSearch = "or1.8xlarge.search"

    // OpenSearchPartitionInstanceTypeOr112xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr112xlargeSearch = "or1.12xlarge.search"

    // OpenSearchPartitionInstanceTypeOr116xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeOr116xlargeSearch = "or1.16xlarge.search"

    // OpenSearchPartitionInstanceTypeUltrawarm1MediumSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeUltrawarm1MediumSearch = "ultrawarm1.medium.search"

    // OpenSearchPartitionInstanceTypeUltrawarm1LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeUltrawarm1LargeSearch = "ultrawarm1.large.search"

    // OpenSearchPartitionInstanceTypeUltrawarm1XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeUltrawarm1XlargeSearch = "ultrawarm1.xlarge.search"

    // OpenSearchPartitionInstanceTypeT2MicroSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT2MicroSearch = "t2.micro.search"

    // OpenSearchPartitionInstanceTypeT2SmallSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT2SmallSearch = "t2.small.search"

    // OpenSearchPartitionInstanceTypeT2MediumSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT2MediumSearch = "t2.medium.search"

    // OpenSearchPartitionInstanceTypeR3LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR3LargeSearch = "r3.large.search"

    // OpenSearchPartitionInstanceTypeR3XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR3XlargeSearch = "r3.xlarge.search"

    // OpenSearchPartitionInstanceTypeR32xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR32xlargeSearch = "r3.2xlarge.search"

    // OpenSearchPartitionInstanceTypeR34xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR34xlargeSearch = "r3.4xlarge.search"

    // OpenSearchPartitionInstanceTypeR38xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR38xlargeSearch = "r3.8xlarge.search"

    // OpenSearchPartitionInstanceTypeI2XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI2XlargeSearch = "i2.xlarge.search"

    // OpenSearchPartitionInstanceTypeI22xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI22xlargeSearch = "i2.2xlarge.search"

    // OpenSearchPartitionInstanceTypeD2XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeD2XlargeSearch = "d2.xlarge.search"

    // OpenSearchPartitionInstanceTypeD22xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeD22xlargeSearch = "d2.2xlarge.search"

    // OpenSearchPartitionInstanceTypeD24xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeD24xlargeSearch = "d2.4xlarge.search"

    // OpenSearchPartitionInstanceTypeD28xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeD28xlargeSearch = "d2.8xlarge.search"

    // OpenSearchPartitionInstanceTypeC4LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC4LargeSearch = "c4.large.search"

    // OpenSearchPartitionInstanceTypeC4XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC4XlargeSearch = "c4.xlarge.search"

    // OpenSearchPartitionInstanceTypeC42xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC42xlargeSearch = "c4.2xlarge.search"

    // OpenSearchPartitionInstanceTypeC44xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC44xlargeSearch = "c4.4xlarge.search"

    // OpenSearchPartitionInstanceTypeC48xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC48xlargeSearch = "c4.8xlarge.search"

    // OpenSearchPartitionInstanceTypeR4LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR4LargeSearch = "r4.large.search"

    // OpenSearchPartitionInstanceTypeR4XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR4XlargeSearch = "r4.xlarge.search"

    // OpenSearchPartitionInstanceTypeR42xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR42xlargeSearch = "r4.2xlarge.search"

    // OpenSearchPartitionInstanceTypeR44xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR44xlargeSearch = "r4.4xlarge.search"

    // OpenSearchPartitionInstanceTypeR48xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR48xlargeSearch = "r4.8xlarge.search"

    // OpenSearchPartitionInstanceTypeR416xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR416xlargeSearch = "r4.16xlarge.search"

    // OpenSearchPartitionInstanceTypeI3LargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI3LargeSearch = "i3.large.search"

    // OpenSearchPartitionInstanceTypeI3XlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI3XlargeSearch = "i3.xlarge.search"

    // OpenSearchPartitionInstanceTypeI32xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI32xlargeSearch = "i3.2xlarge.search"

    // OpenSearchPartitionInstanceTypeI34xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI34xlargeSearch = "i3.4xlarge.search"

    // OpenSearchPartitionInstanceTypeI38xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI38xlargeSearch = "i3.8xlarge.search"

    // OpenSearchPartitionInstanceTypeI316xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeI316xlargeSearch = "i3.16xlarge.search"

    // OpenSearchPartitionInstanceTypeR6gLargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gLargeSearch = "r6g.large.search"

    // OpenSearchPartitionInstanceTypeR6gXlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gXlargeSearch = "r6g.xlarge.search"

    // OpenSearchPartitionInstanceTypeR6g2xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6g2xlargeSearch = "r6g.2xlarge.search"

    // OpenSearchPartitionInstanceTypeR6g4xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6g4xlargeSearch = "r6g.4xlarge.search"

    // OpenSearchPartitionInstanceTypeR6g8xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6g8xlargeSearch = "r6g.8xlarge.search"

    // OpenSearchPartitionInstanceTypeR6g12xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6g12xlargeSearch = "r6g.12xlarge.search"

    // OpenSearchPartitionInstanceTypeM6gLargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM6gLargeSearch = "m6g.large.search"

    // OpenSearchPartitionInstanceTypeM6gXlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM6gXlargeSearch = "m6g.xlarge.search"

    // OpenSearchPartitionInstanceTypeM6g2xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM6g2xlargeSearch = "m6g.2xlarge.search"

    // OpenSearchPartitionInstanceTypeM6g4xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM6g4xlargeSearch = "m6g.4xlarge.search"

    // OpenSearchPartitionInstanceTypeM6g8xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM6g8xlargeSearch = "m6g.8xlarge.search"

    // OpenSearchPartitionInstanceTypeM6g12xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeM6g12xlargeSearch = "m6g.12xlarge.search"

    // OpenSearchPartitionInstanceTypeC6gLargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC6gLargeSearch = "c6g.large.search"

    // OpenSearchPartitionInstanceTypeC6gXlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC6gXlargeSearch = "c6g.xlarge.search"

    // OpenSearchPartitionInstanceTypeC6g2xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC6g2xlargeSearch = "c6g.2xlarge.search"

    // OpenSearchPartitionInstanceTypeC6g4xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC6g4xlargeSearch = "c6g.4xlarge.search"

    // OpenSearchPartitionInstanceTypeC6g8xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC6g8xlargeSearch = "c6g.8xlarge.search"

    // OpenSearchPartitionInstanceTypeC6g12xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeC6g12xlargeSearch = "c6g.12xlarge.search"

    // OpenSearchPartitionInstanceTypeR6gdLargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gdLargeSearch = "r6gd.large.search"

    // OpenSearchPartitionInstanceTypeR6gdXlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gdXlargeSearch = "r6gd.xlarge.search"

    // OpenSearchPartitionInstanceTypeR6gd2xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gd2xlargeSearch = "r6gd.2xlarge.search"

    // OpenSearchPartitionInstanceTypeR6gd4xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gd4xlargeSearch = "r6gd.4xlarge.search"

    // OpenSearchPartitionInstanceTypeR6gd8xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gd8xlargeSearch = "r6gd.8xlarge.search"

    // OpenSearchPartitionInstanceTypeR6gd12xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gd12xlargeSearch = "r6gd.12xlarge.search"

    // OpenSearchPartitionInstanceTypeR6gd16xlargeSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeR6gd16xlargeSearch = "r6gd.16xlarge.search"

    // OpenSearchPartitionInstanceTypeT4gSmallSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT4gSmallSearch = "t4g.small.search"

    // OpenSearchPartitionInstanceTypeT4gMediumSearch is a OpenSearchPartitionInstanceType enum value
    OpenSearchPartitionInstanceTypeT4gMediumSearch = "t4g.medium.search"
)
const (
    // OpenSearchWarmPartitionInstanceTypeUltrawarm1MediumSearch is a OpenSearchWarmPartitionInstanceType enum value
    OpenSearchWarmPartitionInstanceTypeUltrawarm1MediumSearch = "ultrawarm1.medium.search"

    // OpenSearchWarmPartitionInstanceTypeUltrawarm1LargeSearch is a OpenSearchWarmPartitionInstanceType enum value
    OpenSearchWarmPartitionInstanceTypeUltrawarm1LargeSearch = "ultrawarm1.large.search"

    // OpenSearchWarmPartitionInstanceTypeUltrawarm1XlargeSearch is a OpenSearchWarmPartitionInstanceType enum value
    OpenSearchWarmPartitionInstanceTypeUltrawarm1XlargeSearch = "ultrawarm1.xlarge.search"
)
const (
    // OptionStateRequiresIndexDocuments is a OptionState enum value
    OptionStateRequiresIndexDocuments = "RequiresIndexDocuments"

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

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

The state of a requested domain configuration change. Can be one of the following:

  • Processing - The requested change is still in progress.

  • Active - The requested change is processed and deployed to the domain.

const (
    // OutboundConnectionStatusCodeValidating is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeValidating = "VALIDATING"

    // OutboundConnectionStatusCodeValidationFailed is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeValidationFailed = "VALIDATION_FAILED"

    // OutboundConnectionStatusCodePendingAcceptance is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodePendingAcceptance = "PENDING_ACCEPTANCE"

    // OutboundConnectionStatusCodeApproved is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeApproved = "APPROVED"

    // OutboundConnectionStatusCodeProvisioning is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeProvisioning = "PROVISIONING"

    // OutboundConnectionStatusCodeActive is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeActive = "ACTIVE"

    // OutboundConnectionStatusCodeRejecting is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeRejecting = "REJECTING"

    // OutboundConnectionStatusCodeRejected is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeRejected = "REJECTED"

    // OutboundConnectionStatusCodeDeleting is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeDeleting = "DELETING"

    // OutboundConnectionStatusCodeDeleted is a OutboundConnectionStatusCode enum value
    OutboundConnectionStatusCodeDeleted = "DELETED"
)
const (
    // OverallChangeStatusPending is a OverallChangeStatus enum value
    OverallChangeStatusPending = "PENDING"

    // OverallChangeStatusProcessing is a OverallChangeStatus enum value
    OverallChangeStatusProcessing = "PROCESSING"

    // OverallChangeStatusCompleted is a OverallChangeStatus enum value
    OverallChangeStatusCompleted = "COMPLETED"

    // OverallChangeStatusFailed is a OverallChangeStatus enum value
    OverallChangeStatusFailed = "FAILED"
)

The overall status value of the domain configuration change.

const (
    // PackageStatusCopying is a PackageStatus enum value
    PackageStatusCopying = "COPYING"

    // PackageStatusCopyFailed is a PackageStatus enum value
    PackageStatusCopyFailed = "COPY_FAILED"

    // PackageStatusValidating is a PackageStatus enum value
    PackageStatusValidating = "VALIDATING"

    // PackageStatusValidationFailed is a PackageStatus enum value
    PackageStatusValidationFailed = "VALIDATION_FAILED"

    // PackageStatusAvailable is a PackageStatus enum value
    PackageStatusAvailable = "AVAILABLE"

    // PackageStatusDeleting is a PackageStatus enum value
    PackageStatusDeleting = "DELETING"

    // PackageStatusDeleted is a PackageStatus enum value
    PackageStatusDeleted = "DELETED"

    // PackageStatusDeleteFailed is a PackageStatus enum value
    PackageStatusDeleteFailed = "DELETE_FAILED"
)
const (
    // PackageTypeTxtDictionary is a PackageType enum value
    PackageTypeTxtDictionary = "TXT-DICTIONARY"

    // PackageTypeZipPlugin is a PackageType enum value
    PackageTypeZipPlugin = "ZIP-PLUGIN"
)
const (
    // PrincipalTypeAwsAccount is a PrincipalType enum value
    PrincipalTypeAwsAccount = "AWS_ACCOUNT"

    // PrincipalTypeAwsService is a PrincipalType enum value
    PrincipalTypeAwsService = "AWS_SERVICE"
)
const (
    // PropertyValueTypePlainText is a PropertyValueType enum value
    PropertyValueTypePlainText = "PLAIN_TEXT"

    // PropertyValueTypeStringifiedJson is a PropertyValueType enum value
    PropertyValueTypeStringifiedJson = "STRINGIFIED_JSON"
)
const (
    // ReservedInstancePaymentOptionAllUpfront is a ReservedInstancePaymentOption enum value
    ReservedInstancePaymentOptionAllUpfront = "ALL_UPFRONT"

    // ReservedInstancePaymentOptionPartialUpfront is a ReservedInstancePaymentOption enum value
    ReservedInstancePaymentOptionPartialUpfront = "PARTIAL_UPFRONT"

    // ReservedInstancePaymentOptionNoUpfront is a ReservedInstancePaymentOption enum value
    ReservedInstancePaymentOptionNoUpfront = "NO_UPFRONT"
)
const (
    // RollbackOnDisableNoRollback is a RollbackOnDisable enum value
    RollbackOnDisableNoRollback = "NO_ROLLBACK"

    // RollbackOnDisableDefaultRollback is a RollbackOnDisable enum value
    RollbackOnDisableDefaultRollback = "DEFAULT_ROLLBACK"
)

The rollback state while disabling Auto-Tune for the domain.

const (
    // ScheduleAtNow is a ScheduleAt enum value
    ScheduleAtNow = "NOW"

    // ScheduleAtTimestamp is a ScheduleAt enum value
    ScheduleAtTimestamp = "TIMESTAMP"

    // ScheduleAtOffPeakWindow is a ScheduleAt enum value
    ScheduleAtOffPeakWindow = "OFF_PEAK_WINDOW"
)
const (
    // ScheduledAutoTuneActionTypeJvmHeapSizeTuning is a ScheduledAutoTuneActionType enum value
    ScheduledAutoTuneActionTypeJvmHeapSizeTuning = "JVM_HEAP_SIZE_TUNING"

    // ScheduledAutoTuneActionTypeJvmYoungGenTuning is a ScheduledAutoTuneActionType enum value
    ScheduledAutoTuneActionTypeJvmYoungGenTuning = "JVM_YOUNG_GEN_TUNING"
)

The Auto-Tune action type.

const (
    // ScheduledAutoTuneSeverityTypeLow is a ScheduledAutoTuneSeverityType enum value
    ScheduledAutoTuneSeverityTypeLow = "LOW"

    // ScheduledAutoTuneSeverityTypeMedium is a ScheduledAutoTuneSeverityType enum value
    ScheduledAutoTuneSeverityTypeMedium = "MEDIUM"

    // ScheduledAutoTuneSeverityTypeHigh is a ScheduledAutoTuneSeverityType enum value
    ScheduledAutoTuneSeverityTypeHigh = "HIGH"
)

The Auto-Tune action severity.

const (
    // ScheduledByCustomer is a ScheduledBy enum value
    ScheduledByCustomer = "CUSTOMER"

    // ScheduledBySystem is a ScheduledBy enum value
    ScheduledBySystem = "SYSTEM"
)
const (
    // SkipUnavailableStatusEnabled is a SkipUnavailableStatus enum value
    SkipUnavailableStatusEnabled = "ENABLED"

    // SkipUnavailableStatusDisabled is a SkipUnavailableStatus enum value
    SkipUnavailableStatusDisabled = "DISABLED"
)

The status of SkipUnavailable setting for the outbound connection.

  • ENABLED - The SkipUnavailable setting is enabled for the connection.

  • DISABLED - The SkipUnavailable setting is disabled for the connection.

const (
    // TLSSecurityPolicyPolicyMinTls10201907 is a TLSSecurityPolicy enum value
    TLSSecurityPolicyPolicyMinTls10201907 = "Policy-Min-TLS-1-0-2019-07"

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

    // TLSSecurityPolicyPolicyMinTls12Pfs202310 is a TLSSecurityPolicy enum value
    TLSSecurityPolicyPolicyMinTls12Pfs202310 = "Policy-Min-TLS-1-2-PFS-2023-10"
)
const (
    // UpgradeStatusInProgress is a UpgradeStatus enum value
    UpgradeStatusInProgress = "IN_PROGRESS"

    // UpgradeStatusSucceeded is a UpgradeStatus enum value
    UpgradeStatusSucceeded = "SUCCEEDED"

    // UpgradeStatusSucceededWithIssues is a UpgradeStatus enum value
    UpgradeStatusSucceededWithIssues = "SUCCEEDED_WITH_ISSUES"

    // UpgradeStatusFailed is a UpgradeStatus enum value
    UpgradeStatusFailed = "FAILED"
)
const (
    // UpgradeStepPreUpgradeCheck is a UpgradeStep enum value
    UpgradeStepPreUpgradeCheck = "PRE_UPGRADE_CHECK"

    // UpgradeStepSnapshot is a UpgradeStep enum value
    UpgradeStepSnapshot = "SNAPSHOT"

    // UpgradeStepUpgrade is a UpgradeStep enum value
    UpgradeStepUpgrade = "UPGRADE"
)
const (
    // VolumeTypeStandard is a VolumeType enum value
    VolumeTypeStandard = "standard"

    // VolumeTypeGp2 is a VolumeType enum value
    VolumeTypeGp2 = "gp2"

    // VolumeTypeIo1 is a VolumeType enum value
    VolumeTypeIo1 = "io1"

    // VolumeTypeGp3 is a VolumeType enum value
    VolumeTypeGp3 = "gp3"
)

The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs).

const (
    // VpcEndpointErrorCodeEndpointNotFound is a VpcEndpointErrorCode enum value
    VpcEndpointErrorCodeEndpointNotFound = "ENDPOINT_NOT_FOUND"

    // VpcEndpointErrorCodeServerError is a VpcEndpointErrorCode enum value
    VpcEndpointErrorCodeServerError = "SERVER_ERROR"
)
const (
    // VpcEndpointStatusCreating is a VpcEndpointStatus enum value
    VpcEndpointStatusCreating = "CREATING"

    // VpcEndpointStatusCreateFailed is a VpcEndpointStatus enum value
    VpcEndpointStatusCreateFailed = "CREATE_FAILED"

    // VpcEndpointStatusActive is a VpcEndpointStatus enum value
    VpcEndpointStatusActive = "ACTIVE"

    // VpcEndpointStatusUpdating is a VpcEndpointStatus enum value
    VpcEndpointStatusUpdating = "UPDATING"

    // VpcEndpointStatusUpdateFailed is a VpcEndpointStatus enum value
    VpcEndpointStatusUpdateFailed = "UPDATE_FAILED"

    // VpcEndpointStatusDeleting is a VpcEndpointStatus enum value
    VpcEndpointStatusDeleting = "DELETING"

    // VpcEndpointStatusDeleteFailed is a VpcEndpointStatus enum value
    VpcEndpointStatusDeleteFailed = "DELETE_FAILED"
)
const (
    // ZoneStatusActive is a ZoneStatus enum value
    ZoneStatusActive = "Active"

    // ZoneStatusStandBy is a ZoneStatus enum value
    ZoneStatusStandBy = "StandBy"

    // ZoneStatusNotAvailable is a ZoneStatus enum value
    ZoneStatusNotAvailable = "NotAvailable"
)
const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // An error occurred because you don't have permissions to access the resource.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeBaseException for service response error code
    // "BaseException".
    //
    // An error occurred while processing the request.
    ErrCodeBaseException = "BaseException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    //
    // An error occurred because the client attempts to remove a resource that is
    // currently in use.
    ErrCodeConflictException = "ConflictException"

    // ErrCodeDependencyFailureException for service response error code
    // "DependencyFailureException".
    //
    // An exception for when a failure in one of the dependencies results in the
    // service being unable to fetch details about the resource.
    ErrCodeDependencyFailureException = "DependencyFailureException"

    // ErrCodeDisabledOperationException for service response error code
    // "DisabledOperationException".
    //
    // An error occured because the client wanted to access an unsupported operation.
    ErrCodeDisabledOperationException = "DisabledOperationException"

    // ErrCodeInternalException for service response error code
    // "InternalException".
    //
    // Request processing failed because of an unknown error, exception, or internal
    // failure.
    ErrCodeInternalException = "InternalException"

    // ErrCodeInvalidPaginationTokenException for service response error code
    // "InvalidPaginationTokenException".
    //
    // Request processing failed because you provided an invalid pagination token.
    ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException"

    // ErrCodeInvalidTypeException for service response error code
    // "InvalidTypeException".
    //
    // An exception for trying to create or access a sub-resource that's either
    // invalid or not supported.
    ErrCodeInvalidTypeException = "InvalidTypeException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // An exception for trying to create more than the allowed number of resources
    // or sub-resources.
    ErrCodeLimitExceededException = "LimitExceededException"

    // ErrCodeResourceAlreadyExistsException for service response error code
    // "ResourceAlreadyExistsException".
    //
    // An exception for creating a resource that already exists.
    ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // An exception for accessing or deleting a resource that doesn't exist.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeSlotNotAvailableException for service response error code
    // "SlotNotAvailableException".
    //
    // An exception for attempting to schedule a domain action during an unavailable
    // time slot.
    ErrCodeSlotNotAvailableException = "SlotNotAvailableException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // An exception for accessing or deleting a resource that doesn't exist.
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "OpenSearch" // Name of service.
    EndpointsID = "es"         // ID to lookup a service endpoint with.
    ServiceID   = "OpenSearch" // ServiceID is a unique identifier of a specific service.
)

Service information constants

const (
    // AutoTuneTypeScheduledAction is a AutoTuneType enum value
    AutoTuneTypeScheduledAction = "SCHEDULED_ACTION"
)

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

const (
    // TimeUnitHours is a TimeUnit enum value
    TimeUnitHours = "HOURS"
)

The unit of a maintenance schedule duration. Valid value is HOUR.

func ActionSeverity_Values

func ActionSeverity_Values() []string

ActionSeverity_Values returns all elements of the ActionSeverity enum

func ActionStatus_Values

func ActionStatus_Values() []string

ActionStatus_Values returns all elements of the ActionStatus enum

func ActionType_Values

func ActionType_Values() []string

ActionType_Values returns all elements of the ActionType enum

func AutoTuneDesiredState_Values

func AutoTuneDesiredState_Values() []string

AutoTuneDesiredState_Values returns all elements of the AutoTuneDesiredState enum

func AutoTuneState_Values

func AutoTuneState_Values() []string

AutoTuneState_Values returns all elements of the AutoTuneState enum

func AutoTuneType_Values

func AutoTuneType_Values() []string

AutoTuneType_Values returns all elements of the AutoTuneType enum

func ConfigChangeStatus_Values

func ConfigChangeStatus_Values() []string

ConfigChangeStatus_Values returns all elements of the ConfigChangeStatus enum

func ConnectionMode_Values

func ConnectionMode_Values() []string

ConnectionMode_Values returns all elements of the ConnectionMode enum

func DataSourceStatus_Values

func DataSourceStatus_Values() []string

DataSourceStatus_Values returns all elements of the DataSourceStatus enum

func DeploymentStatus_Values

func DeploymentStatus_Values() []string

DeploymentStatus_Values returns all elements of the DeploymentStatus enum

func DescribePackagesFilterName_Values

func DescribePackagesFilterName_Values() []string

DescribePackagesFilterName_Values returns all elements of the DescribePackagesFilterName enum

func DomainHealth_Values

func DomainHealth_Values() []string

DomainHealth_Values returns all elements of the DomainHealth enum

func DomainPackageStatus_Values

func DomainPackageStatus_Values() []string

DomainPackageStatus_Values returns all elements of the DomainPackageStatus enum

func DomainProcessingStatusType_Values

func DomainProcessingStatusType_Values() []string

DomainProcessingStatusType_Values returns all elements of the DomainProcessingStatusType enum

func DomainState_Values

func DomainState_Values() []string

DomainState_Values returns all elements of the DomainState enum

func DryRunMode_Values

func DryRunMode_Values() []string

DryRunMode_Values returns all elements of the DryRunMode enum

func EngineType_Values

func EngineType_Values() []string

EngineType_Values returns all elements of the EngineType enum

func IPAddressType_Values

func IPAddressType_Values() []string

IPAddressType_Values returns all elements of the IPAddressType enum

func InboundConnectionStatusCode_Values

func InboundConnectionStatusCode_Values() []string

InboundConnectionStatusCode_Values returns all elements of the InboundConnectionStatusCode enum

func InitiatedBy_Values

func InitiatedBy_Values() []string

InitiatedBy_Values returns all elements of the InitiatedBy enum

func LogType_Values

func LogType_Values() []string

LogType_Values returns all elements of the LogType enum

func MaintenanceStatus_Values

func MaintenanceStatus_Values() []string

MaintenanceStatus_Values returns all elements of the MaintenanceStatus enum

func MaintenanceType_Values

func MaintenanceType_Values() []string

MaintenanceType_Values returns all elements of the MaintenanceType enum

func MasterNodeStatus_Values

func MasterNodeStatus_Values() []string

MasterNodeStatus_Values returns all elements of the MasterNodeStatus enum

func NaturalLanguageQueryGenerationCurrentState_Values

func NaturalLanguageQueryGenerationCurrentState_Values() []string

NaturalLanguageQueryGenerationCurrentState_Values returns all elements of the NaturalLanguageQueryGenerationCurrentState enum

func NaturalLanguageQueryGenerationDesiredState_Values

func NaturalLanguageQueryGenerationDesiredState_Values() []string

NaturalLanguageQueryGenerationDesiredState_Values returns all elements of the NaturalLanguageQueryGenerationDesiredState enum

func NodeStatus_Values

func NodeStatus_Values() []string

NodeStatus_Values returns all elements of the NodeStatus enum

func NodeType_Values

func NodeType_Values() []string

NodeType_Values returns all elements of the NodeType enum

func OpenSearchPartitionInstanceType_Values

func OpenSearchPartitionInstanceType_Values() []string

OpenSearchPartitionInstanceType_Values returns all elements of the OpenSearchPartitionInstanceType enum

func OpenSearchWarmPartitionInstanceType_Values

func OpenSearchWarmPartitionInstanceType_Values() []string

OpenSearchWarmPartitionInstanceType_Values returns all elements of the OpenSearchWarmPartitionInstanceType enum

func OptionState_Values

func OptionState_Values() []string

OptionState_Values returns all elements of the OptionState enum

func OutboundConnectionStatusCode_Values

func OutboundConnectionStatusCode_Values() []string

OutboundConnectionStatusCode_Values returns all elements of the OutboundConnectionStatusCode enum

func OverallChangeStatus_Values

func OverallChangeStatus_Values() []string

OverallChangeStatus_Values returns all elements of the OverallChangeStatus enum

func PackageStatus_Values

func PackageStatus_Values() []string

PackageStatus_Values returns all elements of the PackageStatus enum

func PackageType_Values

func PackageType_Values() []string

PackageType_Values returns all elements of the PackageType enum

func PrincipalType_Values

func PrincipalType_Values() []string

PrincipalType_Values returns all elements of the PrincipalType enum

func PropertyValueType_Values

func PropertyValueType_Values() []string

PropertyValueType_Values returns all elements of the PropertyValueType enum

func ReservedInstancePaymentOption_Values

func ReservedInstancePaymentOption_Values() []string

ReservedInstancePaymentOption_Values returns all elements of the ReservedInstancePaymentOption enum

func RollbackOnDisable_Values

func RollbackOnDisable_Values() []string

RollbackOnDisable_Values returns all elements of the RollbackOnDisable enum

func ScheduleAt_Values

func ScheduleAt_Values() []string

ScheduleAt_Values returns all elements of the ScheduleAt enum

func ScheduledAutoTuneActionType_Values

func ScheduledAutoTuneActionType_Values() []string

ScheduledAutoTuneActionType_Values returns all elements of the ScheduledAutoTuneActionType enum

func ScheduledAutoTuneSeverityType_Values

func ScheduledAutoTuneSeverityType_Values() []string

ScheduledAutoTuneSeverityType_Values returns all elements of the ScheduledAutoTuneSeverityType enum

func ScheduledBy_Values

func ScheduledBy_Values() []string

ScheduledBy_Values returns all elements of the ScheduledBy enum

func SkipUnavailableStatus_Values

func SkipUnavailableStatus_Values() []string

SkipUnavailableStatus_Values returns all elements of the SkipUnavailableStatus enum

func TLSSecurityPolicy_Values

func TLSSecurityPolicy_Values() []string

TLSSecurityPolicy_Values returns all elements of the TLSSecurityPolicy enum

func TimeUnit_Values

func TimeUnit_Values() []string

TimeUnit_Values returns all elements of the TimeUnit enum

func UpgradeStatus_Values

func UpgradeStatus_Values() []string

UpgradeStatus_Values returns all elements of the UpgradeStatus enum

func UpgradeStep_Values

func UpgradeStep_Values() []string

UpgradeStep_Values returns all elements of the UpgradeStep enum

func VolumeType_Values

func VolumeType_Values() []string

VolumeType_Values returns all elements of the VolumeType enum

func VpcEndpointErrorCode_Values

func VpcEndpointErrorCode_Values() []string

VpcEndpointErrorCode_Values returns all elements of the VpcEndpointErrorCode enum

func VpcEndpointStatus_Values

func VpcEndpointStatus_Values() []string

VpcEndpointStatus_Values returns all elements of the VpcEndpointStatus enum

func ZoneStatus_Values

func ZoneStatus_Values() []string

ZoneStatus_Values returns all elements of the ZoneStatus enum

type AIMLOptionsInput_

type AIMLOptionsInput_ struct {

    // Container for parameters required for natural language query generation on
    // the specified domain.
    NaturalLanguageQueryGenerationOptions *NaturalLanguageQueryGenerationOptionsInput_ `type:"structure"`
    // contains filtered or unexported fields
}

Container for parameters required to enable all machine learning features.

func (AIMLOptionsInput_) GoString

func (s AIMLOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AIMLOptionsInput_) SetNaturalLanguageQueryGenerationOptions

func (s *AIMLOptionsInput_) SetNaturalLanguageQueryGenerationOptions(v *NaturalLanguageQueryGenerationOptionsInput_) *AIMLOptionsInput_

SetNaturalLanguageQueryGenerationOptions sets the NaturalLanguageQueryGenerationOptions field's value.

func (AIMLOptionsInput_) String

func (s AIMLOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AIMLOptionsOutput_

type AIMLOptionsOutput_ struct {

    // Container for parameters required for natural language query generation on
    // the specified domain.
    NaturalLanguageQueryGenerationOptions *NaturalLanguageQueryGenerationOptionsOutput_ `type:"structure"`
    // contains filtered or unexported fields
}

Container for parameters representing the state of machine learning features on the specified domain.

func (AIMLOptionsOutput_) GoString

func (s AIMLOptionsOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AIMLOptionsOutput_) SetNaturalLanguageQueryGenerationOptions

func (s *AIMLOptionsOutput_) SetNaturalLanguageQueryGenerationOptions(v *NaturalLanguageQueryGenerationOptionsOutput_) *AIMLOptionsOutput_

SetNaturalLanguageQueryGenerationOptions sets the NaturalLanguageQueryGenerationOptions field's value.

func (AIMLOptionsOutput_) String

func (s AIMLOptionsOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AIMLOptionsStatus

type AIMLOptionsStatus struct {

    // Machine learning options on the specified domain.
    Options *AIMLOptionsOutput_ `type:"structure"`

    // Provides the current status of an entity.
    Status *OptionStatus `type:"structure"`
    // contains filtered or unexported fields
}

The status of machine learning options on the specified domain.

func (AIMLOptionsStatus) GoString

func (s AIMLOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AIMLOptionsStatus) SetOptions

func (s *AIMLOptionsStatus) SetOptions(v *AIMLOptionsOutput_) *AIMLOptionsStatus

SetOptions sets the Options field's value.

func (*AIMLOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (AIMLOptionsStatus) String

func (s AIMLOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AWSDomainInformation

type AWSDomainInformation struct {

    // Name of the domain.
    //
    // DomainName is a required field
    DomainName *string `min:"3" type:"string" required:"true"`

    // The Amazon Web Services account ID of the domain owner.
    OwnerId *string `min:"12" type:"string"`

    // The Amazon Web Services Region in which the domain is located.
    Region *string `min:"5" type:"string"`
    // contains filtered or unexported fields
}

Information about an Amazon OpenSearch Service domain.

func (AWSDomainInformation) GoString

func (s AWSDomainInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AWSDomainInformation) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*AWSDomainInformation) SetOwnerId

func (s *AWSDomainInformation) SetOwnerId(v string) *AWSDomainInformation

SetOwnerId sets the OwnerId field's value.

func (*AWSDomainInformation) SetRegion

func (s *AWSDomainInformation) SetRegion(v string) *AWSDomainInformation

SetRegion sets the Region field's value.

func (AWSDomainInformation) String

func (s AWSDomainInformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AWSDomainInformation) Validate

func (s *AWSDomainInformation) Validate() error

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

type AcceptInboundConnectionInput

type AcceptInboundConnectionInput struct {

    // The ID of the inbound connection to accept.
    //
    // ConnectionId is a required field
    ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the AcceptInboundConnection operation.

func (AcceptInboundConnectionInput) GoString

func (s AcceptInboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInboundConnectionInput) SetConnectionId

func (s *AcceptInboundConnectionInput) SetConnectionId(v string) *AcceptInboundConnectionInput

SetConnectionId sets the ConnectionId field's value.

func (AcceptInboundConnectionInput) String

func (s AcceptInboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInboundConnectionInput) Validate

func (s *AcceptInboundConnectionInput) Validate() error

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

type AcceptInboundConnectionOutput

type AcceptInboundConnectionOutput struct {

    // Information about the accepted inbound connection.
    Connection *InboundConnection `type:"structure"`
    // contains filtered or unexported fields
}

Contains details about the accepted inbound connection.

func (AcceptInboundConnectionOutput) GoString

func (s AcceptInboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInboundConnectionOutput) SetConnection

func (s *AcceptInboundConnectionOutput) SetConnection(v *InboundConnection) *AcceptInboundConnectionOutput

SetConnection sets the Connection field's value.

func (AcceptInboundConnectionOutput) String

func (s AcceptInboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessDeniedException

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

An error occurred because you don't have permissions to access the resource.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessPoliciesStatus

type AccessPoliciesStatus struct {

    // The access policy configured for the domain. Access policies can be resource-based,
    // IP-based, or IAM-based. For more information, see Configuring access policies
    // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies).
    //
    // Options is a required field
    Options *string `type:"string" required:"true"`

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

The configured access rules for the domain's search endpoint, and the current status of those rules.

func (AccessPoliciesStatus) GoString

func (s AccessPoliciesStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessPoliciesStatus) SetOptions

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

SetOptions sets the Options field's value.

func (*AccessPoliciesStatus) SetStatus

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

SetStatus sets the Status field's value.

func (AccessPoliciesStatus) String

func (s AccessPoliciesStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddDataSourceInput

type AddDataSourceInput struct {

    // The type of data source.
    //
    // DataSourceType is a required field
    DataSourceType *DataSourceType `type:"structure" required:"true"`

    // A description of the data source.
    Description *string `type:"string"`

    // The name of the domain to add the data source to.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // A name for the data source.
    //
    // Name is a required field
    Name *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the AddDataSource operation.

func (AddDataSourceInput) GoString

func (s AddDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddDataSourceInput) SetDataSourceType

func (s *AddDataSourceInput) SetDataSourceType(v *DataSourceType) *AddDataSourceInput

SetDataSourceType sets the DataSourceType field's value.

func (*AddDataSourceInput) SetDescription

func (s *AddDataSourceInput) SetDescription(v string) *AddDataSourceInput

SetDescription sets the Description field's value.

func (*AddDataSourceInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*AddDataSourceInput) SetName

func (s *AddDataSourceInput) SetName(v string) *AddDataSourceInput

SetName sets the Name field's value.

func (AddDataSourceInput) String

func (s AddDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddDataSourceInput) Validate

func (s *AddDataSourceInput) Validate() error

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

type AddDataSourceOutput

type AddDataSourceOutput struct {

    // A message associated with creation of the data source.
    Message *string `type:"string"`
    // contains filtered or unexported fields
}

The result of an AddDataSource operation.

func (AddDataSourceOutput) GoString

func (s AddDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddDataSourceOutput) SetMessage

func (s *AddDataSourceOutput) SetMessage(v string) *AddDataSourceOutput

SetMessage sets the Message field's value.

func (AddDataSourceOutput) String

func (s AddDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddTagsInput

type AddTagsInput struct {

    // Amazon Resource Name (ARN) for the OpenSearch Service domain to which you
    // want to attach resource tags.
    //
    // ARN is a required field
    ARN *string `min:"20" type:"string" required:"true"`

    // List of resource tags.
    //
    // TagList is a required field
    TagList []*Tag `type:"list" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.

func (AddTagsInput) GoString

func (s AddTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsInput) SetARN

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

SetARN sets the ARN field's value.

func (*AddTagsInput) SetTagList

func (s *AddTagsInput) SetTagList(v []*Tag) *AddTagsInput

SetTagList sets the TagList field's value.

func (AddTagsInput) String

func (s AddTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsInput) Validate

func (s *AddTagsInput) Validate() error

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

type AddTagsOutput

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

func (AddTagsOutput) GoString

func (s AddTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddTagsOutput) String

func (s AddTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdditionalLimit

type AdditionalLimit struct {

    //    * MaximumNumberOfDataNodesSupported - This attribute only applies to master
    //    nodes and specifies the maximum number of data nodes of a given instance
    //    type a master node can support.
    //
    //    * MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies
    //    to data nodes and specifies the maximum number of data nodes of a given
    //    instance type can exist without a master node governing them.
    LimitName *string `type:"string"`

    // The values of the additional instance type limits.
    LimitValues []*string `type:"list"`
    // contains filtered or unexported fields
}

List of limits that are specific to a given instance type.

func (AdditionalLimit) GoString

func (s AdditionalLimit) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdditionalLimit) SetLimitName

func (s *AdditionalLimit) SetLimitName(v string) *AdditionalLimit

SetLimitName sets the LimitName field's value.

func (*AdditionalLimit) SetLimitValues

func (s *AdditionalLimit) SetLimitValues(v []*string) *AdditionalLimit

SetLimitValues sets the LimitValues field's value.

func (AdditionalLimit) String

func (s AdditionalLimit) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdvancedOptionsStatus

type AdvancedOptionsStatus struct {

    // The status of advanced options for the specified domain.
    //
    // Options is a required field
    Options map[string]*string `type:"map" required:"true"`

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

Status of the advanced options for the specified domain. The following options are available:

  • "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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).

func (AdvancedOptionsStatus) GoString

func (s AdvancedOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedOptionsStatus) SetOptions

func (s *AdvancedOptionsStatus) SetOptions(v map[string]*string) *AdvancedOptionsStatus

SetOptions sets the Options field's value.

func (*AdvancedOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (AdvancedOptionsStatus) String

func (s AdvancedOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdvancedSecurityOptions

type AdvancedSecurityOptions struct {

    // Date and time when the migration period will be disabled. Only necessary
    // when enabling fine-grained access control on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing).
    AnonymousAuthDisableDate *time.Time `type:"timestamp"`

    // True if a 30-day migration period is enabled, during which administrators
    // can create role mappings. Only necessary when enabling fine-grained access
    // control on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing).
    AnonymousAuthEnabled *bool `type:"boolean"`

    // True if fine-grained access control is enabled.
    Enabled *bool `type:"boolean"`

    // True if the internal user database is enabled.
    InternalUserDatabaseEnabled *bool `type:"boolean"`

    // Container for information about the JWT configuration of the Amazon OpenSearch
    // Service.
    JWTOptions *JWTOptionsOutput_ `type:"structure"`

    // Container for information about the SAML configuration for OpenSearch Dashboards.
    SAMLOptions *SAMLOptionsOutput_ `type:"structure"`
    // contains filtered or unexported fields
}

Container for fine-grained access control settings.

func (AdvancedSecurityOptions) GoString

func (s AdvancedSecurityOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptions) SetAnonymousAuthDisableDate

func (s *AdvancedSecurityOptions) SetAnonymousAuthDisableDate(v time.Time) *AdvancedSecurityOptions

SetAnonymousAuthDisableDate sets the AnonymousAuthDisableDate field's value.

func (*AdvancedSecurityOptions) SetAnonymousAuthEnabled

func (s *AdvancedSecurityOptions) SetAnonymousAuthEnabled(v bool) *AdvancedSecurityOptions

SetAnonymousAuthEnabled sets the AnonymousAuthEnabled field's value.

func (*AdvancedSecurityOptions) SetEnabled

func (s *AdvancedSecurityOptions) SetEnabled(v bool) *AdvancedSecurityOptions

SetEnabled sets the Enabled field's value.

func (*AdvancedSecurityOptions) SetInternalUserDatabaseEnabled

func (s *AdvancedSecurityOptions) SetInternalUserDatabaseEnabled(v bool) *AdvancedSecurityOptions

SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.

func (*AdvancedSecurityOptions) SetJWTOptions

func (s *AdvancedSecurityOptions) SetJWTOptions(v *JWTOptionsOutput_) *AdvancedSecurityOptions

SetJWTOptions sets the JWTOptions field's value.

func (*AdvancedSecurityOptions) SetSAMLOptions

func (s *AdvancedSecurityOptions) SetSAMLOptions(v *SAMLOptionsOutput_) *AdvancedSecurityOptions

SetSAMLOptions sets the SAMLOptions field's value.

func (AdvancedSecurityOptions) String

func (s AdvancedSecurityOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdvancedSecurityOptionsInput_

type AdvancedSecurityOptionsInput_ struct {

    // True to enable a 30-day migration period during which administrators can
    // create role mappings. Only necessary when enabling fine-grained access control
    // on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing).
    AnonymousAuthEnabled *bool `type:"boolean"`

    // True to enable fine-grained access control.
    Enabled *bool `type:"boolean"`

    // True to enable the internal user database.
    InternalUserDatabaseEnabled *bool `type:"boolean"`

    // Container for information about the JWT configuration of the Amazon OpenSearch
    // Service.
    JWTOptions *JWTOptionsInput_ `type:"structure"`

    // Container for information about the master user.
    MasterUserOptions *MasterUserOptions `type:"structure"`

    // Container for information about the SAML configuration for OpenSearch Dashboards.
    SAMLOptions *SAMLOptionsInput_ `type:"structure"`
    // contains filtered or unexported fields
}

Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html).

func (AdvancedSecurityOptionsInput_) GoString

func (s AdvancedSecurityOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptionsInput_) SetAnonymousAuthEnabled

func (s *AdvancedSecurityOptionsInput_) SetAnonymousAuthEnabled(v bool) *AdvancedSecurityOptionsInput_

SetAnonymousAuthEnabled sets the AnonymousAuthEnabled field's value.

func (*AdvancedSecurityOptionsInput_) SetEnabled

func (s *AdvancedSecurityOptionsInput_) SetEnabled(v bool) *AdvancedSecurityOptionsInput_

SetEnabled sets the Enabled field's value.

func (*AdvancedSecurityOptionsInput_) SetInternalUserDatabaseEnabled

func (s *AdvancedSecurityOptionsInput_) SetInternalUserDatabaseEnabled(v bool) *AdvancedSecurityOptionsInput_

SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.

func (*AdvancedSecurityOptionsInput_) SetJWTOptions

func (s *AdvancedSecurityOptionsInput_) SetJWTOptions(v *JWTOptionsInput_) *AdvancedSecurityOptionsInput_

SetJWTOptions sets the JWTOptions field's value.

func (*AdvancedSecurityOptionsInput_) SetMasterUserOptions

func (s *AdvancedSecurityOptionsInput_) SetMasterUserOptions(v *MasterUserOptions) *AdvancedSecurityOptionsInput_

SetMasterUserOptions sets the MasterUserOptions field's value.

func (*AdvancedSecurityOptionsInput_) SetSAMLOptions

func (s *AdvancedSecurityOptionsInput_) SetSAMLOptions(v *SAMLOptionsInput_) *AdvancedSecurityOptionsInput_

SetSAMLOptions sets the SAMLOptions field's value.

func (AdvancedSecurityOptionsInput_) String

func (s AdvancedSecurityOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptionsInput_) Validate

func (s *AdvancedSecurityOptionsInput_) Validate() error

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

type AdvancedSecurityOptionsStatus

type AdvancedSecurityOptionsStatus struct {

    // Container for fine-grained access control settings.
    //
    // Options is a required field
    Options *AdvancedSecurityOptions `type:"structure" required:"true"`

    // Status of the fine-grained access control settings for a domain.
    //
    // Status is a required field
    Status *OptionStatus `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

The status of fine-grained access control settings for a domain.

func (AdvancedSecurityOptionsStatus) GoString

func (s AdvancedSecurityOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdvancedSecurityOptionsStatus) SetOptions

func (s *AdvancedSecurityOptionsStatus) SetOptions(v *AdvancedSecurityOptions) *AdvancedSecurityOptionsStatus

SetOptions sets the Options field's value.

func (*AdvancedSecurityOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (AdvancedSecurityOptionsStatus) String

func (s AdvancedSecurityOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociatePackageInput

type AssociatePackageInput struct {

    // Name of the domain to associate the package with.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // Internal ID of the package to associate with a domain. Use DescribePackages
    // to find this value.
    //
    // PackageID is a required field
    PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the request parameters to the AssociatePackage operation.

func (AssociatePackageInput) GoString

func (s AssociatePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePackageInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*AssociatePackageInput) SetPackageID

func (s *AssociatePackageInput) SetPackageID(v string) *AssociatePackageInput

SetPackageID sets the PackageID field's value.

func (AssociatePackageInput) String

func (s AssociatePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePackageInput) Validate

func (s *AssociatePackageInput) Validate() error

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

type AssociatePackageOutput

type AssociatePackageOutput struct {

    // Information about a package that is associated with a domain.
    DomainPackageDetails *DomainPackageDetails `type:"structure"`
    // contains filtered or unexported fields
}

Container for the response returned by the AssociatePackage operation.

func (AssociatePackageOutput) GoString

func (s AssociatePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePackageOutput) SetDomainPackageDetails

func (s *AssociatePackageOutput) SetDomainPackageDetails(v *DomainPackageDetails) *AssociatePackageOutput

SetDomainPackageDetails sets the DomainPackageDetails field's value.

func (AssociatePackageOutput) String

func (s AssociatePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthorizeVpcEndpointAccessInput

type AuthorizeVpcEndpointAccessInput struct {

    // The Amazon Web Services account ID to grant access to.
    //
    // Account is a required field
    Account *string `type:"string" required:"true"`

    // The name of the OpenSearch Service domain to provide access to.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (AuthorizeVpcEndpointAccessInput) GoString

func (s AuthorizeVpcEndpointAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeVpcEndpointAccessInput) SetAccount

func (s *AuthorizeVpcEndpointAccessInput) SetAccount(v string) *AuthorizeVpcEndpointAccessInput

SetAccount sets the Account field's value.

func (*AuthorizeVpcEndpointAccessInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (AuthorizeVpcEndpointAccessInput) String

func (s AuthorizeVpcEndpointAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeVpcEndpointAccessInput) Validate

func (s *AuthorizeVpcEndpointAccessInput) Validate() error

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

type AuthorizeVpcEndpointAccessOutput

type AuthorizeVpcEndpointAccessOutput struct {

    // Information about the Amazon Web Services account or service that was provided
    // access to the domain.
    //
    // AuthorizedPrincipal is a required field
    AuthorizedPrincipal *AuthorizedPrincipal `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (AuthorizeVpcEndpointAccessOutput) GoString

func (s AuthorizeVpcEndpointAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeVpcEndpointAccessOutput) SetAuthorizedPrincipal

func (s *AuthorizeVpcEndpointAccessOutput) SetAuthorizedPrincipal(v *AuthorizedPrincipal) *AuthorizeVpcEndpointAccessOutput

SetAuthorizedPrincipal sets the AuthorizedPrincipal field's value.

func (AuthorizeVpcEndpointAccessOutput) String

func (s AuthorizeVpcEndpointAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthorizedPrincipal

type AuthorizedPrincipal struct {

    // The IAM principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html)
    // that is allowed access to the domain.
    Principal *string `type:"string"`

    // The type of principal.
    PrincipalType *string `type:"string" enum:"PrincipalType"`
    // contains filtered or unexported fields
}

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

func (AuthorizedPrincipal) GoString

func (s AuthorizedPrincipal) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizedPrincipal) SetPrincipal

func (s *AuthorizedPrincipal) SetPrincipal(v string) *AuthorizedPrincipal

SetPrincipal sets the Principal field's value.

func (*AuthorizedPrincipal) SetPrincipalType

func (s *AuthorizedPrincipal) SetPrincipalType(v string) *AuthorizedPrincipal

SetPrincipalType sets the PrincipalType field's value.

func (AuthorizedPrincipal) String

func (s AuthorizedPrincipal) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTune

type AutoTune struct {

    // Details about an Auto-Tune action.
    AutoTuneDetails *AutoTuneDetails `type:"structure"`

    // The type of Auto-Tune action.
    AutoTuneType *string `type:"string" enum:"AutoTuneType"`
    // contains filtered or unexported fields
}

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

func (AutoTune) GoString

func (s AutoTune) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTune) SetAutoTuneDetails

func (s *AutoTune) SetAutoTuneDetails(v *AutoTuneDetails) *AutoTune

SetAutoTuneDetails sets the AutoTuneDetails field's value.

func (*AutoTune) SetAutoTuneType

func (s *AutoTune) SetAutoTuneType(v string) *AutoTune

SetAutoTuneType sets the AutoTuneType field's value.

func (AutoTune) String

func (s AutoTune) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneDetails

type AutoTuneDetails struct {

    // Container for details about a scheduled Auto-Tune action.
    ScheduledAutoTuneDetails *ScheduledAutoTuneDetails `type:"structure"`
    // contains filtered or unexported fields
}

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

func (AutoTuneDetails) GoString

func (s AutoTuneDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneDetails) SetScheduledAutoTuneDetails

func (s *AutoTuneDetails) SetScheduledAutoTuneDetails(v *ScheduledAutoTuneDetails) *AutoTuneDetails

SetScheduledAutoTuneDetails sets the ScheduledAutoTuneDetails field's value.

func (AutoTuneDetails) String

func (s AutoTuneDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneMaintenanceSchedule

type AutoTuneMaintenanceSchedule struct {

    // A cron expression for a recurring maintenance schedule during which Auto-Tune
    // can deploy changes.
    CronExpressionForRecurrence *string `type:"string"`

    // The duration of the maintenance schedule. For example, "Duration": {"Value":
    // 2, "Unit": "HOURS"}.
    Duration *Duration `type:"structure"`

    // The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
    StartAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

This object is deprecated. Use the domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate).

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

func (AutoTuneMaintenanceSchedule) GoString

func (s AutoTuneMaintenanceSchedule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneMaintenanceSchedule) SetCronExpressionForRecurrence

func (s *AutoTuneMaintenanceSchedule) SetCronExpressionForRecurrence(v string) *AutoTuneMaintenanceSchedule

SetCronExpressionForRecurrence sets the CronExpressionForRecurrence field's value.

func (*AutoTuneMaintenanceSchedule) SetDuration

func (s *AutoTuneMaintenanceSchedule) SetDuration(v *Duration) *AutoTuneMaintenanceSchedule

SetDuration sets the Duration field's value.

func (*AutoTuneMaintenanceSchedule) SetStartAt

func (s *AutoTuneMaintenanceSchedule) SetStartAt(v time.Time) *AutoTuneMaintenanceSchedule

SetStartAt sets the StartAt field's value.

func (AutoTuneMaintenanceSchedule) String

func (s AutoTuneMaintenanceSchedule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneMaintenanceSchedule) Validate

func (s *AutoTuneMaintenanceSchedule) Validate() error

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

type AutoTuneOptions

type AutoTuneOptions struct {

    // Whether Auto-Tune is enabled or disabled.
    DesiredState *string `type:"string" enum:"AutoTuneDesiredState"`

    // DEPRECATED. Use off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html)
    // instead.
    //
    // A list of maintenance schedules during which Auto-Tune can deploy changes.
    MaintenanceSchedules []*AutoTuneMaintenanceSchedule `type:"list"`

    // When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune
    // settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults.
    // If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in
    // the request. Otherwise, OpenSearch Service is unable to perform the rollback.
    RollbackOnDisable *string `type:"string" enum:"RollbackOnDisable"`

    // Whether to use the domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html)
    // to deploy configuration changes on the domain rather than a maintenance schedule.
    UseOffPeakWindow *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

func (AutoTuneOptions) GoString

func (s AutoTuneOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptions) SetDesiredState

func (s *AutoTuneOptions) SetDesiredState(v string) *AutoTuneOptions

SetDesiredState sets the DesiredState field's value.

func (*AutoTuneOptions) SetMaintenanceSchedules

func (s *AutoTuneOptions) SetMaintenanceSchedules(v []*AutoTuneMaintenanceSchedule) *AutoTuneOptions

SetMaintenanceSchedules sets the MaintenanceSchedules field's value.

func (*AutoTuneOptions) SetRollbackOnDisable

func (s *AutoTuneOptions) SetRollbackOnDisable(v string) *AutoTuneOptions

SetRollbackOnDisable sets the RollbackOnDisable field's value.

func (*AutoTuneOptions) SetUseOffPeakWindow

func (s *AutoTuneOptions) SetUseOffPeakWindow(v bool) *AutoTuneOptions

SetUseOffPeakWindow sets the UseOffPeakWindow field's value.

func (AutoTuneOptions) String

func (s AutoTuneOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptions) Validate

func (s *AutoTuneOptions) Validate() error

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

type AutoTuneOptionsInput_

type AutoTuneOptionsInput_ struct {

    // Whether Auto-Tune is enabled or disabled.
    DesiredState *string `type:"string" enum:"AutoTuneDesiredState"`

    // A list of maintenance schedules during which Auto-Tune can deploy changes.
    // Maintenance windows are deprecated and have been replaced with off-peak windows
    // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html).
    MaintenanceSchedules []*AutoTuneMaintenanceSchedule `type:"list"`

    // Whether to schedule Auto-Tune optimizations that require blue/green deployments
    // during the domain's configured daily off-peak window.
    UseOffPeakWindow *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)

func (AutoTuneOptionsInput_) GoString

func (s AutoTuneOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsInput_) SetDesiredState

func (s *AutoTuneOptionsInput_) SetDesiredState(v string) *AutoTuneOptionsInput_

SetDesiredState sets the DesiredState field's value.

func (*AutoTuneOptionsInput_) SetMaintenanceSchedules

func (s *AutoTuneOptionsInput_) SetMaintenanceSchedules(v []*AutoTuneMaintenanceSchedule) *AutoTuneOptionsInput_

SetMaintenanceSchedules sets the MaintenanceSchedules field's value.

func (*AutoTuneOptionsInput_) SetUseOffPeakWindow

func (s *AutoTuneOptionsInput_) SetUseOffPeakWindow(v bool) *AutoTuneOptionsInput_

SetUseOffPeakWindow sets the UseOffPeakWindow field's value.

func (AutoTuneOptionsInput_) String

func (s AutoTuneOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsInput_) Validate

func (s *AutoTuneOptionsInput_) Validate() error

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

type AutoTuneOptionsOutput_

type AutoTuneOptionsOutput_ struct {

    // Any errors that occurred while enabling or disabling Auto-Tune.
    ErrorMessage *string `type:"string"`

    // The current state of Auto-Tune on the domain.
    State *string `type:"string" enum:"AutoTuneState"`

    // Whether the domain's off-peak window will be used to deploy Auto-Tune changes
    // rather than a maintenance schedule.
    UseOffPeakWindow *bool `type:"boolean"`
    // contains filtered or unexported fields
}

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

func (AutoTuneOptionsOutput_) GoString

func (s AutoTuneOptionsOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsOutput_) SetErrorMessage

func (s *AutoTuneOptionsOutput_) SetErrorMessage(v string) *AutoTuneOptionsOutput_

SetErrorMessage sets the ErrorMessage field's value.

func (*AutoTuneOptionsOutput_) SetState

func (s *AutoTuneOptionsOutput_) SetState(v string) *AutoTuneOptionsOutput_

SetState sets the State field's value.

func (*AutoTuneOptionsOutput_) SetUseOffPeakWindow

func (s *AutoTuneOptionsOutput_) SetUseOffPeakWindow(v bool) *AutoTuneOptionsOutput_

SetUseOffPeakWindow sets the UseOffPeakWindow field's value.

func (AutoTuneOptionsOutput_) String

func (s AutoTuneOptionsOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneOptionsStatus

type AutoTuneOptionsStatus struct {

    // Auto-Tune settings for updating a domain.
    Options *AutoTuneOptions `type:"structure"`

    // The current status of Auto-Tune for a domain.
    Status *AutoTuneStatus `type:"structure"`
    // contains filtered or unexported fields
}

The Auto-Tune status for the domain.

func (AutoTuneOptionsStatus) GoString

func (s AutoTuneOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneOptionsStatus) SetOptions

func (s *AutoTuneOptionsStatus) SetOptions(v *AutoTuneOptions) *AutoTuneOptionsStatus

SetOptions sets the Options field's value.

func (*AutoTuneOptionsStatus) SetStatus

func (s *AutoTuneOptionsStatus) SetStatus(v *AutoTuneStatus) *AutoTuneOptionsStatus

SetStatus sets the Status field's value.

func (AutoTuneOptionsStatus) String

func (s AutoTuneOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoTuneStatus

type AutoTuneStatus struct {

    // Date and time when Auto-Tune was enabled for the domain.
    //
    // CreationDate is a required field
    CreationDate *time.Time `type:"timestamp" required:"true"`

    // Any errors that occurred while enabling or disabling Auto-Tune.
    ErrorMessage *string `type:"string"`

    // Indicates whether the domain is being deleted.
    PendingDeletion *bool `type:"boolean"`

    // The current state of Auto-Tune on the domain.
    //
    // State is a required field
    State *string `type:"string" required:"true" enum:"AutoTuneState"`

    // Date and time when the Auto-Tune options were last updated for the domain.
    //
    // UpdateDate is a required field
    UpdateDate *time.Time `type:"timestamp" required:"true"`

    // The latest version of the Auto-Tune options.
    UpdateVersion *int64 `type:"integer"`
    // contains filtered or unexported fields
}

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

func (AutoTuneStatus) GoString

func (s AutoTuneStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoTuneStatus) SetCreationDate

func (s *AutoTuneStatus) SetCreationDate(v time.Time) *AutoTuneStatus

SetCreationDate sets the CreationDate field's value.

func (*AutoTuneStatus) SetErrorMessage

func (s *AutoTuneStatus) SetErrorMessage(v string) *AutoTuneStatus

SetErrorMessage sets the ErrorMessage field's value.

func (*AutoTuneStatus) SetPendingDeletion

func (s *AutoTuneStatus) SetPendingDeletion(v bool) *AutoTuneStatus

SetPendingDeletion sets the PendingDeletion field's value.

func (*AutoTuneStatus) SetState

func (s *AutoTuneStatus) SetState(v string) *AutoTuneStatus

SetState sets the State field's value.

func (*AutoTuneStatus) SetUpdateDate

func (s *AutoTuneStatus) SetUpdateDate(v time.Time) *AutoTuneStatus

SetUpdateDate sets the UpdateDate field's value.

func (*AutoTuneStatus) SetUpdateVersion

func (s *AutoTuneStatus) SetUpdateVersion(v int64) *AutoTuneStatus

SetUpdateVersion sets the UpdateVersion field's value.

func (AutoTuneStatus) String

func (s AutoTuneStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AvailabilityZoneInfo

type AvailabilityZoneInfo struct {

    // The name of the Availability Zone.
    AvailabilityZoneName *string `min:"1" type:"string"`

    // The number of data nodes active in the Availability Zone.
    AvailableDataNodeCount *string `type:"string"`

    // The total number of data nodes configured in the Availability Zone.
    ConfiguredDataNodeCount *string `type:"string"`

    // The total number of primary and replica shards in the Availability Zone.
    TotalShards *string `type:"string"`

    // The total number of primary and replica shards that aren't allocated to any
    // of the nodes in the Availability Zone.
    TotalUnAssignedShards *string `type:"string"`

    // The current state of the Availability Zone. Current options are Active and
    // StandBy.
    //
    //    * Active - Data nodes in the Availability Zone are in use.
    //
    //    * StandBy - Data nodes in the Availability Zone are in a standby state.
    //
    //    * NotAvailable - Unable to retrieve information.
    ZoneStatus *string `type:"string" enum:"ZoneStatus"`
    // contains filtered or unexported fields
}

Information about an Availability Zone on a domain.

func (AvailabilityZoneInfo) GoString

func (s AvailabilityZoneInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AvailabilityZoneInfo) SetAvailabilityZoneName

func (s *AvailabilityZoneInfo) SetAvailabilityZoneName(v string) *AvailabilityZoneInfo

SetAvailabilityZoneName sets the AvailabilityZoneName field's value.

func (*AvailabilityZoneInfo) SetAvailableDataNodeCount

func (s *AvailabilityZoneInfo) SetAvailableDataNodeCount(v string) *AvailabilityZoneInfo

SetAvailableDataNodeCount sets the AvailableDataNodeCount field's value.

func (*AvailabilityZoneInfo) SetConfiguredDataNodeCount

func (s *AvailabilityZoneInfo) SetConfiguredDataNodeCount(v string) *AvailabilityZoneInfo

SetConfiguredDataNodeCount sets the ConfiguredDataNodeCount field's value.

func (*AvailabilityZoneInfo) SetTotalShards

func (s *AvailabilityZoneInfo) SetTotalShards(v string) *AvailabilityZoneInfo

SetTotalShards sets the TotalShards field's value.

func (*AvailabilityZoneInfo) SetTotalUnAssignedShards

func (s *AvailabilityZoneInfo) SetTotalUnAssignedShards(v string) *AvailabilityZoneInfo

SetTotalUnAssignedShards sets the TotalUnAssignedShards field's value.

func (*AvailabilityZoneInfo) SetZoneStatus

func (s *AvailabilityZoneInfo) SetZoneStatus(v string) *AvailabilityZoneInfo

SetZoneStatus sets the ZoneStatus field's value.

func (AvailabilityZoneInfo) String

func (s AvailabilityZoneInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BaseException

type BaseException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // A description of the error.
    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

An error occurred while processing the request.

func (*BaseException) Code

func (s *BaseException) Code() string

Code returns the exception type name.

func (*BaseException) Error

func (s *BaseException) Error() string

func (BaseException) GoString

func (s BaseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BaseException) Message

func (s *BaseException) Message() string

Message returns the exception's message.

func (*BaseException) OrigErr

func (s *BaseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BaseException) RequestID

func (s *BaseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BaseException) StatusCode

func (s *BaseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BaseException) String

func (s BaseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelDomainConfigChangeInput

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.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

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

func (CancelDomainConfigChangeInput) GoString

func (s CancelDomainConfigChangeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDomainConfigChangeInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*CancelDomainConfigChangeInput) SetDryRun

func (s *CancelDomainConfigChangeInput) SetDryRun(v bool) *CancelDomainConfigChangeInput

SetDryRun sets the DryRun field's value.

func (CancelDomainConfigChangeInput) String

func (s CancelDomainConfigChangeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDomainConfigChangeInput) Validate

func (s *CancelDomainConfigChangeInput) Validate() error

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

type CancelDomainConfigChangeOutput

type CancelDomainConfigChangeOutput struct {

    // The unique identifiers of the changes that were cancelled.
    CancelledChangeIds []*string `type:"list"`

    // The domain change properties that were cancelled.
    CancelledChangeProperties []*CancelledChangeProperty `type:"list"`

    // Whether or not the request was a dry run. If True, the changes were not actually
    // cancelled.
    DryRun *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (CancelDomainConfigChangeOutput) GoString

func (s CancelDomainConfigChangeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDomainConfigChangeOutput) SetCancelledChangeIds

func (s *CancelDomainConfigChangeOutput) SetCancelledChangeIds(v []*string) *CancelDomainConfigChangeOutput

SetCancelledChangeIds sets the CancelledChangeIds field's value.

func (*CancelDomainConfigChangeOutput) SetCancelledChangeProperties

func (s *CancelDomainConfigChangeOutput) SetCancelledChangeProperties(v []*CancelledChangeProperty) *CancelDomainConfigChangeOutput

SetCancelledChangeProperties sets the CancelledChangeProperties field's value.

func (*CancelDomainConfigChangeOutput) SetDryRun

func (s *CancelDomainConfigChangeOutput) SetDryRun(v bool) *CancelDomainConfigChangeOutput

SetDryRun sets the DryRun field's value.

func (CancelDomainConfigChangeOutput) String

func (s CancelDomainConfigChangeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelServiceSoftwareUpdateInput

type CancelServiceSoftwareUpdateInput struct {

    // Name of the OpenSearch Service domain that you want to cancel the service
    // software update on.
    //
    // DomainName is a required field
    DomainName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

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

func (CancelServiceSoftwareUpdateInput) GoString

func (s CancelServiceSoftwareUpdateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelServiceSoftwareUpdateInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (CancelServiceSoftwareUpdateInput) String

func (s CancelServiceSoftwareUpdateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelServiceSoftwareUpdateInput) Validate

func (s *CancelServiceSoftwareUpdateInput) Validate() error

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

type CancelServiceSoftwareUpdateOutput

type CancelServiceSoftwareUpdateOutput struct {

    // Container for the state of your domain relative to the latest service software.
    ServiceSoftwareOptions *ServiceSoftwareOptions `type:"structure"`
    // contains filtered or unexported fields
}

Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

func (CancelServiceSoftwareUpdateOutput) GoString

func (s CancelServiceSoftwareUpdateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelServiceSoftwareUpdateOutput) SetServiceSoftwareOptions

func (s *CancelServiceSoftwareUpdateOutput) SetServiceSoftwareOptions(v *ServiceSoftwareOptions) *CancelServiceSoftwareUpdateOutput

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (CancelServiceSoftwareUpdateOutput) String

func (s CancelServiceSoftwareUpdateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelledChangeProperty

type CancelledChangeProperty struct {

    // The current value of the property, after the change was cancelled.
    ActiveValue *string `type:"string"`

    // The pending value of the property that was cancelled. This would have been
    // the eventual value of the property if the chance had not been cancelled.
    CancelledValue *string `type:"string"`

    // The name of the property whose change was cancelled.
    PropertyName *string `type:"string"`
    // contains filtered or unexported fields
}

A property change that was cancelled for an Amazon OpenSearch Service domain.

func (CancelledChangeProperty) GoString

func (s CancelledChangeProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelledChangeProperty) SetActiveValue

func (s *CancelledChangeProperty) SetActiveValue(v string) *CancelledChangeProperty

SetActiveValue sets the ActiveValue field's value.

func (*CancelledChangeProperty) SetCancelledValue

func (s *CancelledChangeProperty) SetCancelledValue(v string) *CancelledChangeProperty

SetCancelledValue sets the CancelledValue field's value.

func (*CancelledChangeProperty) SetPropertyName

func (s *CancelledChangeProperty) SetPropertyName(v string) *CancelledChangeProperty

SetPropertyName sets the PropertyName field's value.

func (CancelledChangeProperty) String

func (s CancelledChangeProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangeProgressDetails

type ChangeProgressDetails struct {

    // The ID of the configuration change.
    ChangeId *string `min:"36" type:"string"`

    // The current status of the configuration change.
    ConfigChangeStatus *string `type:"string" enum:"ConfigChangeStatus"`

    // The IAM principal who initiated the configuration change.
    InitiatedBy *string `type:"string" enum:"InitiatedBy"`

    // The last time that the configuration change was updated.
    LastUpdatedTime *time.Time `type:"timestamp"`

    // A message corresponding to the status of the configuration change.
    Message *string `type:"string"`

    // The time that the configuration change was initiated, in Universal Coordinated
    // Time (UTC).
    StartTime *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Container for information about a configuration change happening on a domain.

func (ChangeProgressDetails) GoString

func (s ChangeProgressDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangeProgressDetails) SetChangeId

func (s *ChangeProgressDetails) SetChangeId(v string) *ChangeProgressDetails

SetChangeId sets the ChangeId field's value.

func (*ChangeProgressDetails) SetConfigChangeStatus

func (s *ChangeProgressDetails) SetConfigChangeStatus(v string) *ChangeProgressDetails

SetConfigChangeStatus sets the ConfigChangeStatus field's value.

func (*ChangeProgressDetails) SetInitiatedBy

func (s *ChangeProgressDetails) SetInitiatedBy(v string) *ChangeProgressDetails

SetInitiatedBy sets the InitiatedBy field's value.

func (*ChangeProgressDetails) SetLastUpdatedTime

func (s *ChangeProgressDetails) SetLastUpdatedTime(v time.Time) *ChangeProgressDetails

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*ChangeProgressDetails) SetMessage

func (s *ChangeProgressDetails) SetMessage(v string) *ChangeProgressDetails

SetMessage sets the Message field's value.

func (*ChangeProgressDetails) SetStartTime

func (s *ChangeProgressDetails) SetStartTime(v time.Time) *ChangeProgressDetails

SetStartTime sets the StartTime field's value.

func (ChangeProgressDetails) String

func (s ChangeProgressDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangeProgressStage

type ChangeProgressStage struct {

    // The description of the stage.
    Description *string `type:"string"`

    // The most recent updated timestamp of the stage.
    LastUpdated *time.Time `type:"timestamp"`

    // The name of the stage.
    Name *string `min:"1" type:"string"`

    // The status of the stage.
    Status *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Progress details for each stage of a domain update.

func (ChangeProgressStage) GoString

func (s ChangeProgressStage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangeProgressStage) SetDescription

func (s *ChangeProgressStage) SetDescription(v string) *ChangeProgressStage

SetDescription sets the Description field's value.

func (*ChangeProgressStage) SetLastUpdated

func (s *ChangeProgressStage) SetLastUpdated(v time.Time) *ChangeProgressStage

SetLastUpdated sets the LastUpdated field's value.

func (*ChangeProgressStage) SetName

func (s *ChangeProgressStage) SetName(v string) *ChangeProgressStage

SetName sets the Name field's value.

func (*ChangeProgressStage) SetStatus

func (s *ChangeProgressStage) SetStatus(v string) *ChangeProgressStage

SetStatus sets the Status field's value.

func (ChangeProgressStage) String

func (s ChangeProgressStage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangeProgressStatusDetails

type ChangeProgressStatusDetails struct {

    // The unique change identifier associated with a specific domain configuration
    // change.
    ChangeId *string `min:"36" type:"string"`

    // The specific stages that the domain is going through to perform the configuration
    // change.
    ChangeProgressStages []*ChangeProgressStage `type:"list"`

    // The list of properties in the domain configuration change that have completed.
    CompletedProperties []*string `type:"list"`

    // The current status of the configuration change.
    ConfigChangeStatus *string `type:"string" enum:"ConfigChangeStatus"`

    // The IAM principal who initiated the configuration change.
    InitiatedBy *string `type:"string" enum:"InitiatedBy"`

    // The last time that the status of the configuration change was updated.
    LastUpdatedTime *time.Time `type:"timestamp"`

    // The list of properties in the domain configuration change that are still
    // pending.
    PendingProperties []*string `type:"list"`

    // The time at which the configuration change is made on the domain.
    StartTime *time.Time `type:"timestamp"`

    // The overall status of the domain configuration change.
    Status *string `type:"string" enum:"OverallChangeStatus"`

    // The total number of stages required for the configuration change.
    TotalNumberOfStages *int64 `type:"integer"`
    // contains filtered or unexported fields
}

The progress details of a specific domain configuration change.

func (ChangeProgressStatusDetails) GoString

func (s ChangeProgressStatusDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangeProgressStatusDetails) SetChangeId

func (s *ChangeProgressStatusDetails) SetChangeId(v string) *ChangeProgressStatusDetails

SetChangeId sets the ChangeId field's value.

func (*ChangeProgressStatusDetails) SetChangeProgressStages

func (s *ChangeProgressStatusDetails) SetChangeProgressStages(v []*ChangeProgressStage) *ChangeProgressStatusDetails

SetChangeProgressStages sets the ChangeProgressStages field's value.

func (*ChangeProgressStatusDetails) SetCompletedProperties

func (s *ChangeProgressStatusDetails) SetCompletedProperties(v []*string) *ChangeProgressStatusDetails

SetCompletedProperties sets the CompletedProperties field's value.

func (*ChangeProgressStatusDetails) SetConfigChangeStatus

func (s *ChangeProgressStatusDetails) SetConfigChangeStatus(v string) *ChangeProgressStatusDetails

SetConfigChangeStatus sets the ConfigChangeStatus field's value.

func (*ChangeProgressStatusDetails) SetInitiatedBy

func (s *ChangeProgressStatusDetails) SetInitiatedBy(v string) *ChangeProgressStatusDetails

SetInitiatedBy sets the InitiatedBy field's value.

func (*ChangeProgressStatusDetails) SetLastUpdatedTime

func (s *ChangeProgressStatusDetails) SetLastUpdatedTime(v time.Time) *ChangeProgressStatusDetails

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*ChangeProgressStatusDetails) SetPendingProperties

func (s *ChangeProgressStatusDetails) SetPendingProperties(v []*string) *ChangeProgressStatusDetails

SetPendingProperties sets the PendingProperties field's value.

func (*ChangeProgressStatusDetails) SetStartTime

func (s *ChangeProgressStatusDetails) SetStartTime(v time.Time) *ChangeProgressStatusDetails

SetStartTime sets the StartTime field's value.

func (*ChangeProgressStatusDetails) SetStatus

func (s *ChangeProgressStatusDetails) SetStatus(v string) *ChangeProgressStatusDetails

SetStatus sets the Status field's value.

func (*ChangeProgressStatusDetails) SetTotalNumberOfStages

func (s *ChangeProgressStatusDetails) SetTotalNumberOfStages(v int64) *ChangeProgressStatusDetails

SetTotalNumberOfStages sets the TotalNumberOfStages field's value.

func (ChangeProgressStatusDetails) String

func (s ChangeProgressStatusDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterConfig

type ClusterConfig struct {

    // Container for cold storage configuration options.
    ColdStorageOptions *ColdStorageOptions `type:"structure"`

    // Number of dedicated master nodes in the cluster. This number must be greater
    // than 2 and not 4, otherwise you receive a validation exception.
    DedicatedMasterCount *int64 `type:"integer"`

    // Indicates whether dedicated master nodes are enabled for the cluster.True
    // if the cluster will use a dedicated master node.False if the cluster will
    // not.
    DedicatedMasterEnabled *bool `type:"boolean"`

    // OpenSearch Service instance type of the dedicated master nodes in the cluster.
    DedicatedMasterType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

    // Number of data nodes in the cluster. This number must be greater than 1,
    // otherwise you receive a validation exception.
    InstanceCount *int64 `type:"integer"`

    // Instance type of data nodes in the cluster.
    InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

    // A boolean that indicates whether a multi-AZ domain is turned on with a standby
    // AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch
    // Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html).
    MultiAZWithStandbyEnabled *bool `type:"boolean"`

    // The number of warm nodes in the cluster.
    WarmCount *int64 `type:"integer"`

    // Whether to enable warm storage for the cluster.
    WarmEnabled *bool `type:"boolean"`

    // The instance type for the cluster's warm nodes.
    WarmType *string `type:"string" enum:"OpenSearchWarmPartitionInstanceType"`

    // Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled
    // is true.
    ZoneAwarenessConfig *ZoneAwarenessConfig `type:"structure"`

    // Indicates whether multiple Availability Zones are enabled. For more information,
    // see Configuring a multi-AZ domain in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html).
    ZoneAwarenessEnabled *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html).

func (ClusterConfig) GoString

func (s ClusterConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterConfig) SetColdStorageOptions

func (s *ClusterConfig) SetColdStorageOptions(v *ColdStorageOptions) *ClusterConfig

SetColdStorageOptions sets the ColdStorageOptions field's value.

func (*ClusterConfig) SetDedicatedMasterCount

func (s *ClusterConfig) SetDedicatedMasterCount(v int64) *ClusterConfig

SetDedicatedMasterCount sets the DedicatedMasterCount field's value.

func (*ClusterConfig) SetDedicatedMasterEnabled

func (s *ClusterConfig) SetDedicatedMasterEnabled(v bool) *ClusterConfig

SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.

func (*ClusterConfig) SetDedicatedMasterType

func (s *ClusterConfig) SetDedicatedMasterType(v string) *ClusterConfig

SetDedicatedMasterType sets the DedicatedMasterType field's value.

func (*ClusterConfig) SetInstanceCount

func (s *ClusterConfig) SetInstanceCount(v int64) *ClusterConfig

SetInstanceCount sets the InstanceCount field's value.

func (*ClusterConfig) SetInstanceType

func (s *ClusterConfig) SetInstanceType(v string) *ClusterConfig

SetInstanceType sets the InstanceType field's value.

func (*ClusterConfig) SetMultiAZWithStandbyEnabled

func (s *ClusterConfig) SetMultiAZWithStandbyEnabled(v bool) *ClusterConfig

SetMultiAZWithStandbyEnabled sets the MultiAZWithStandbyEnabled field's value.

func (*ClusterConfig) SetWarmCount

func (s *ClusterConfig) SetWarmCount(v int64) *ClusterConfig

SetWarmCount sets the WarmCount field's value.

func (*ClusterConfig) SetWarmEnabled

func (s *ClusterConfig) SetWarmEnabled(v bool) *ClusterConfig

SetWarmEnabled sets the WarmEnabled field's value.

func (*ClusterConfig) SetWarmType

func (s *ClusterConfig) SetWarmType(v string) *ClusterConfig

SetWarmType sets the WarmType field's value.

func (*ClusterConfig) SetZoneAwarenessConfig

func (s *ClusterConfig) SetZoneAwarenessConfig(v *ZoneAwarenessConfig) *ClusterConfig

SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.

func (*ClusterConfig) SetZoneAwarenessEnabled

func (s *ClusterConfig) SetZoneAwarenessEnabled(v bool) *ClusterConfig

SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.

func (ClusterConfig) String

func (s ClusterConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterConfig) Validate

func (s *ClusterConfig) Validate() error

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

type ClusterConfigStatus

type ClusterConfigStatus struct {

    // Cluster configuration options for the specified domain.
    //
    // Options is a required field
    Options *ClusterConfig `type:"structure" required:"true"`

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

The cluster configuration status for a domain.

func (ClusterConfigStatus) GoString

func (s ClusterConfigStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterConfigStatus) SetOptions

func (s *ClusterConfigStatus) SetOptions(v *ClusterConfig) *ClusterConfigStatus

SetOptions sets the Options field's value.

func (*ClusterConfigStatus) SetStatus

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

SetStatus sets the Status field's value.

func (ClusterConfigStatus) String

func (s ClusterConfigStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CognitoOptions

type CognitoOptions struct {

    // Whether to enable or disable Amazon Cognito authentication for OpenSearch
    // Dashboards.
    Enabled *bool `type:"boolean"`

    // The Amazon Cognito identity pool ID that you want OpenSearch Service to use
    // for OpenSearch Dashboards authentication.
    IdentityPoolId *string `min:"1" type:"string"`

    // The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service
    // to configure your user pool and identity pool.
    RoleArn *string `min:"20" type:"string"`

    // The Amazon Cognito user pool ID that you want OpenSearch Service to use for
    // OpenSearch Dashboards authentication.
    UserPoolId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).

func (CognitoOptions) GoString

func (s CognitoOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CognitoOptions) SetEnabled

func (s *CognitoOptions) SetEnabled(v bool) *CognitoOptions

SetEnabled sets the Enabled field's value.

func (*CognitoOptions) SetIdentityPoolId

func (s *CognitoOptions) SetIdentityPoolId(v string) *CognitoOptions

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*CognitoOptions) SetRoleArn

func (s *CognitoOptions) SetRoleArn(v string) *CognitoOptions

SetRoleArn sets the RoleArn field's value.

func (*CognitoOptions) SetUserPoolId

func (s *CognitoOptions) SetUserPoolId(v string) *CognitoOptions

SetUserPoolId sets the UserPoolId field's value.

func (CognitoOptions) String

func (s CognitoOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CognitoOptions) Validate

func (s *CognitoOptions) Validate() error

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

type CognitoOptionsStatus

type CognitoOptionsStatus struct {

    // Cognito options for the specified domain.
    //
    // Options is a required field
    Options *CognitoOptions `type:"structure" required:"true"`

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

The status of the Cognito options for the specified domain.

func (CognitoOptionsStatus) GoString

func (s CognitoOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CognitoOptionsStatus) SetOptions

func (s *CognitoOptionsStatus) SetOptions(v *CognitoOptions) *CognitoOptionsStatus

SetOptions sets the Options field's value.

func (*CognitoOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (CognitoOptionsStatus) String

func (s CognitoOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ColdStorageOptions

type ColdStorageOptions struct {

    // Whether to enable or disable cold storage on the domain. You must enable
    // UltraWarm storage to enable cold storage.
    //
    // Enabled is a required field
    Enabled *bool `type:"boolean" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html).

func (ColdStorageOptions) GoString

func (s ColdStorageOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColdStorageOptions) SetEnabled

func (s *ColdStorageOptions) SetEnabled(v bool) *ColdStorageOptions

SetEnabled sets the Enabled field's value.

func (ColdStorageOptions) String

func (s ColdStorageOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColdStorageOptions) Validate

func (s *ColdStorageOptions) Validate() error

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

type CompatibleVersionsMap

type CompatibleVersionsMap struct {

    // The current version that the OpenSearch Service domain is running.
    SourceVersion *string `min:"14" type:"string"`

    // The possible versions that you can upgrade the domain to.
    TargetVersions []*string `type:"list"`
    // contains filtered or unexported fields
}

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

func (CompatibleVersionsMap) GoString

func (s CompatibleVersionsMap) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompatibleVersionsMap) SetSourceVersion

func (s *CompatibleVersionsMap) SetSourceVersion(v string) *CompatibleVersionsMap

SetSourceVersion sets the SourceVersion field's value.

func (*CompatibleVersionsMap) SetTargetVersions

func (s *CompatibleVersionsMap) SetTargetVersions(v []*string) *CompatibleVersionsMap

SetTargetVersions sets the TargetVersions field's value.

func (CompatibleVersionsMap) String

func (s CompatibleVersionsMap) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

An error occurred because the client attempts to remove a resource that is currently in use.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionProperties

type ConnectionProperties struct {

    // The connection properties for cross cluster search.
    CrossClusterSearch *CrossClusterSearchConnectionProperties `type:"structure"`

    //
    // The Endpoint attribute cannot be modified.
    //
    // The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection
    // mode.
    Endpoint *string `type:"string"`
    // contains filtered or unexported fields
}

The connection properties of an outbound connection.

func (ConnectionProperties) GoString

func (s ConnectionProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionProperties) SetCrossClusterSearch

func (s *ConnectionProperties) SetCrossClusterSearch(v *CrossClusterSearchConnectionProperties) *ConnectionProperties

SetCrossClusterSearch sets the CrossClusterSearch field's value.

func (*ConnectionProperties) SetEndpoint

func (s *ConnectionProperties) SetEndpoint(v string) *ConnectionProperties

SetEndpoint sets the Endpoint field's value.

func (ConnectionProperties) String

func (s ConnectionProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDomainInput

type CreateDomainInput struct {

    // Options for all machine learning features for the specified domain.
    AIMLOptions *AIMLOptionsInput_ `type:"structure"`

    // Identity and Access Management (IAM) policy document specifying the access
    // policies for the new domain.
    AccessPolicies *string `type:"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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).
    AdvancedOptions map[string]*string `type:"map"`

    // Options for fine-grained access control.
    AdvancedSecurityOptions *AdvancedSecurityOptionsInput_ `type:"structure"`

    // Options for Auto-Tune.
    AutoTuneOptions *AutoTuneOptionsInput_ `type:"structure"`

    // Container for the cluster configuration of a domain.
    ClusterConfig *ClusterConfig `type:"structure"`

    // Key-value pairs to configure Amazon Cognito authentication. For more information,
    // see Configuring Amazon Cognito authentication for OpenSearch Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).
    CognitoOptions *CognitoOptions `type:"structure"`

    // Additional options for the domain endpoint, such as whether to require HTTPS
    // for all traffic.
    DomainEndpointOptions *DomainEndpointOptions `type:"structure"`

    // 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.
    //
    // DomainName is a required field
    DomainName *string `min:"3" type:"string" required:"true"`

    // Container for the parameters required to enable EBS-based storage for an
    // OpenSearch Service domain.
    EBSOptions *EBSOptions `type:"structure"`

    // Key-value pairs to enable encryption at rest.
    EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

    // 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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains).
    EngineVersion *string `min:"14" type:"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 *string `type:"string" enum:"IPAddressType"`

    // Key-value pairs to configure log publishing.
    LogPublishingOptions map[string]*LogPublishingOption `type:"map"`

    // Enables node-to-node encryption.
    NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions `type:"structure"`

    // 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 *OffPeakWindowOptions `type:"structure"`

    // DEPRECATED. Container for the parameters required to configure automated
    // snapshots of domain indexes.
    SnapshotOptions *SnapshotOptions `type:"structure"`

    // Software update options for the domain.
    SoftwareUpdateOptions *SoftwareUpdateOptions `type:"structure"`

    // List of tags to add to the domain upon creation.
    TagList []*Tag `type:"list"`

    // 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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
    VPCOptions *VPCOptions `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateDomainInput) GoString

func (s CreateDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainInput) SetAIMLOptions

func (s *CreateDomainInput) SetAIMLOptions(v *AIMLOptionsInput_) *CreateDomainInput

SetAIMLOptions sets the AIMLOptions field's value.

func (*CreateDomainInput) SetAccessPolicies

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

SetAccessPolicies sets the AccessPolicies field's value.

func (*CreateDomainInput) SetAdvancedOptions

func (s *CreateDomainInput) SetAdvancedOptions(v map[string]*string) *CreateDomainInput

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*CreateDomainInput) SetAdvancedSecurityOptions

func (s *CreateDomainInput) SetAdvancedSecurityOptions(v *AdvancedSecurityOptionsInput_) *CreateDomainInput

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*CreateDomainInput) SetAutoTuneOptions

func (s *CreateDomainInput) SetAutoTuneOptions(v *AutoTuneOptionsInput_) *CreateDomainInput

SetAutoTuneOptions sets the AutoTuneOptions field's value.

func (*CreateDomainInput) SetClusterConfig

func (s *CreateDomainInput) SetClusterConfig(v *ClusterConfig) *CreateDomainInput

SetClusterConfig sets the ClusterConfig field's value.

func (*CreateDomainInput) SetCognitoOptions

func (s *CreateDomainInput) SetCognitoOptions(v *CognitoOptions) *CreateDomainInput

SetCognitoOptions sets the CognitoOptions field's value.

func (*CreateDomainInput) SetDomainEndpointOptions

func (s *CreateDomainInput) SetDomainEndpointOptions(v *DomainEndpointOptions) *CreateDomainInput

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*CreateDomainInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*CreateDomainInput) SetEBSOptions

func (s *CreateDomainInput) SetEBSOptions(v *EBSOptions) *CreateDomainInput

SetEBSOptions sets the EBSOptions field's value.

func (*CreateDomainInput) SetEncryptionAtRestOptions

func (s *CreateDomainInput) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *CreateDomainInput

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*CreateDomainInput) SetEngineVersion

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

SetEngineVersion sets the EngineVersion field's value.

func (*CreateDomainInput) SetIPAddressType

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

SetIPAddressType sets the IPAddressType field's value.

func (*CreateDomainInput) SetLogPublishingOptions

func (s *CreateDomainInput) SetLogPublishingOptions(v map[string]*LogPublishingOption) *CreateDomainInput

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*CreateDomainInput) SetNodeToNodeEncryptionOptions

func (s *CreateDomainInput) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptions) *CreateDomainInput

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*CreateDomainInput) SetOffPeakWindowOptions

func (s *CreateDomainInput) SetOffPeakWindowOptions(v *OffPeakWindowOptions) *CreateDomainInput

SetOffPeakWindowOptions sets the OffPeakWindowOptions field's value.

func (*CreateDomainInput) SetSnapshotOptions

func (s *CreateDomainInput) SetSnapshotOptions(v *SnapshotOptions) *CreateDomainInput

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*CreateDomainInput) SetSoftwareUpdateOptions

func (s *CreateDomainInput) SetSoftwareUpdateOptions(v *SoftwareUpdateOptions) *CreateDomainInput

SetSoftwareUpdateOptions sets the SoftwareUpdateOptions field's value.

func (*CreateDomainInput) SetTagList

func (s *CreateDomainInput) SetTagList(v []*Tag) *CreateDomainInput

SetTagList sets the TagList field's value.

func (*CreateDomainInput) SetVPCOptions

func (s *CreateDomainInput) SetVPCOptions(v *VPCOptions) *CreateDomainInput

SetVPCOptions sets the VPCOptions field's value.

func (CreateDomainInput) String

func (s CreateDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainInput) Validate

func (s *CreateDomainInput) Validate() error

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

type CreateDomainOutput

type CreateDomainOutput struct {

    // The status of the newly created domain.
    DomainStatus *DomainStatus `type:"structure"`
    // contains filtered or unexported fields
}

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

func (CreateDomainOutput) GoString

func (s CreateDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainOutput) SetDomainStatus

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

SetDomainStatus sets the DomainStatus field's value.

func (CreateDomainOutput) String

func (s CreateDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateOutboundConnectionInput

type CreateOutboundConnectionInput struct {

    // Name of the connection.
    //
    // ConnectionAlias is a required field
    ConnectionAlias *string `min:"2" type:"string" required:"true"`

    // The connection mode.
    ConnectionMode *string `type:"string" enum:"ConnectionMode"`

    // The ConnectionProperties for the outbound connection.
    ConnectionProperties *ConnectionProperties `type:"structure"`

    // Name and Region of the source (local) domain.
    //
    // LocalDomainInfo is a required field
    LocalDomainInfo *DomainInformationContainer `type:"structure" required:"true"`

    // Name and Region of the destination (remote) domain.
    //
    // RemoteDomainInfo is a required field
    RemoteDomainInfo *DomainInformationContainer `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the CreateOutboundConnection operation.

func (CreateOutboundConnectionInput) GoString

func (s CreateOutboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOutboundConnectionInput) SetConnectionAlias

func (s *CreateOutboundConnectionInput) SetConnectionAlias(v string) *CreateOutboundConnectionInput

SetConnectionAlias sets the ConnectionAlias field's value.

func (*CreateOutboundConnectionInput) SetConnectionMode

func (s *CreateOutboundConnectionInput) SetConnectionMode(v string) *CreateOutboundConnectionInput

SetConnectionMode sets the ConnectionMode field's value.

func (*CreateOutboundConnectionInput) SetConnectionProperties

func (s *CreateOutboundConnectionInput) SetConnectionProperties(v *ConnectionProperties) *CreateOutboundConnectionInput

SetConnectionProperties sets the ConnectionProperties field's value.

func (*CreateOutboundConnectionInput) SetLocalDomainInfo

func (s *CreateOutboundConnectionInput) SetLocalDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionInput

SetLocalDomainInfo sets the LocalDomainInfo field's value.

func (*CreateOutboundConnectionInput) SetRemoteDomainInfo

func (s *CreateOutboundConnectionInput) SetRemoteDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionInput

SetRemoteDomainInfo sets the RemoteDomainInfo field's value.

func (CreateOutboundConnectionInput) String

func (s CreateOutboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOutboundConnectionInput) Validate

func (s *CreateOutboundConnectionInput) Validate() error

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

type CreateOutboundConnectionOutput

type CreateOutboundConnectionOutput struct {

    // Name of the connection.
    ConnectionAlias *string `min:"2" type:"string"`

    // The unique identifier for the created outbound connection, which is used
    // for subsequent operations on the connection.
    ConnectionId *string `min:"10" type:"string"`

    // The connection mode.
    ConnectionMode *string `type:"string" enum:"ConnectionMode"`

    // The ConnectionProperties for the newly created connection.
    ConnectionProperties *ConnectionProperties `type:"structure"`

    // The status of the connection.
    ConnectionStatus *OutboundConnectionStatus `type:"structure"`

    // Information about the source (local) domain.
    LocalDomainInfo *DomainInformationContainer `type:"structure"`

    // Information about the destination (remote) domain.
    RemoteDomainInfo *DomainInformationContainer `type:"structure"`
    // contains filtered or unexported fields
}

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

func (CreateOutboundConnectionOutput) GoString

func (s CreateOutboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOutboundConnectionOutput) SetConnectionAlias

func (s *CreateOutboundConnectionOutput) SetConnectionAlias(v string) *CreateOutboundConnectionOutput

SetConnectionAlias sets the ConnectionAlias field's value.

func (*CreateOutboundConnectionOutput) SetConnectionId

func (s *CreateOutboundConnectionOutput) SetConnectionId(v string) *CreateOutboundConnectionOutput

SetConnectionId sets the ConnectionId field's value.

func (*CreateOutboundConnectionOutput) SetConnectionMode

func (s *CreateOutboundConnectionOutput) SetConnectionMode(v string) *CreateOutboundConnectionOutput

SetConnectionMode sets the ConnectionMode field's value.

func (*CreateOutboundConnectionOutput) SetConnectionProperties

func (s *CreateOutboundConnectionOutput) SetConnectionProperties(v *ConnectionProperties) *CreateOutboundConnectionOutput

SetConnectionProperties sets the ConnectionProperties field's value.

func (*CreateOutboundConnectionOutput) SetConnectionStatus

func (s *CreateOutboundConnectionOutput) SetConnectionStatus(v *OutboundConnectionStatus) *CreateOutboundConnectionOutput

SetConnectionStatus sets the ConnectionStatus field's value.

func (*CreateOutboundConnectionOutput) SetLocalDomainInfo

func (s *CreateOutboundConnectionOutput) SetLocalDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionOutput

SetLocalDomainInfo sets the LocalDomainInfo field's value.

func (*CreateOutboundConnectionOutput) SetRemoteDomainInfo

func (s *CreateOutboundConnectionOutput) SetRemoteDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionOutput

SetRemoteDomainInfo sets the RemoteDomainInfo field's value.

func (CreateOutboundConnectionOutput) String

func (s CreateOutboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePackageInput

type CreatePackageInput struct {

    // Description of the package.
    PackageDescription *string `type:"string"`

    // Unique name for the package.
    //
    // PackageName is a required field
    PackageName *string `min:"3" type:"string" required:"true"`

    // The Amazon S3 location from which to import the package.
    //
    // PackageSource is a required field
    PackageSource *PackageSource `type:"structure" required:"true"`

    // The type of package.
    //
    // PackageType is a required field
    PackageType *string `type:"string" required:"true" enum:"PackageType"`
    // contains filtered or unexported fields
}

Container for request parameters to the CreatePackage operation.

func (CreatePackageInput) GoString

func (s CreatePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePackageInput) SetPackageDescription

func (s *CreatePackageInput) SetPackageDescription(v string) *CreatePackageInput

SetPackageDescription sets the PackageDescription field's value.

func (*CreatePackageInput) SetPackageName

func (s *CreatePackageInput) SetPackageName(v string) *CreatePackageInput

SetPackageName sets the PackageName field's value.

func (*CreatePackageInput) SetPackageSource

func (s *CreatePackageInput) SetPackageSource(v *PackageSource) *CreatePackageInput

SetPackageSource sets the PackageSource field's value.

func (*CreatePackageInput) SetPackageType

func (s *CreatePackageInput) SetPackageType(v string) *CreatePackageInput

SetPackageType sets the PackageType field's value.

func (CreatePackageInput) String

func (s CreatePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePackageInput) Validate

func (s *CreatePackageInput) Validate() error

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

type CreatePackageOutput

type CreatePackageOutput struct {

    // Basic information about an OpenSearch Service package.
    PackageDetails *PackageDetails `type:"structure"`
    // contains filtered or unexported fields
}

Container for the response returned by the CreatePackage operation.

func (CreatePackageOutput) GoString

func (s CreatePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePackageOutput) SetPackageDetails

func (s *CreatePackageOutput) SetPackageDetails(v *PackageDetails) *CreatePackageOutput

SetPackageDetails sets the PackageDetails field's value.

func (CreatePackageOutput) String

func (s CreatePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateVpcEndpointInput

type CreateVpcEndpointInput struct {

    // Unique, case-sensitive identifier to ensure idempotency of the request.
    ClientToken *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the domain to create the endpoint for.
    //
    // DomainArn is a required field
    DomainArn *string `min:"1" type:"string" required:"true"`

    // Options to specify the subnets and security groups for the endpoint.
    //
    // VpcOptions is a required field
    VpcOptions *VPCOptions `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateVpcEndpointInput) GoString

func (s CreateVpcEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcEndpointInput) SetClientToken

func (s *CreateVpcEndpointInput) SetClientToken(v string) *CreateVpcEndpointInput

SetClientToken sets the ClientToken field's value.

func (*CreateVpcEndpointInput) SetDomainArn

func (s *CreateVpcEndpointInput) SetDomainArn(v string) *CreateVpcEndpointInput

SetDomainArn sets the DomainArn field's value.

func (*CreateVpcEndpointInput) SetVpcOptions

func (s *CreateVpcEndpointInput) SetVpcOptions(v *VPCOptions) *CreateVpcEndpointInput

SetVpcOptions sets the VpcOptions field's value.

func (CreateVpcEndpointInput) String

func (s CreateVpcEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcEndpointInput) Validate

func (s *CreateVpcEndpointInput) Validate() error

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

type CreateVpcEndpointOutput

type CreateVpcEndpointOutput struct {

    // Information about the newly created VPC endpoint.
    //
    // VpcEndpoint is a required field
    VpcEndpoint *VpcEndpoint `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateVpcEndpointOutput) GoString

func (s CreateVpcEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVpcEndpointOutput) SetVpcEndpoint

func (s *CreateVpcEndpointOutput) SetVpcEndpoint(v *VpcEndpoint) *CreateVpcEndpointOutput

SetVpcEndpoint sets the VpcEndpoint field's value.

func (CreateVpcEndpointOutput) String

func (s CreateVpcEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CrossClusterSearchConnectionProperties

type CrossClusterSearchConnectionProperties struct {

    // The status of the SkipUnavailable setting for the outbound connection. This
    // feature allows you to specify some clusters as optional and ensure that your
    // cross-cluster queries return partial results despite failures on one or more
    // remote clusters.
    SkipUnavailable *string `type:"string" enum:"SkipUnavailableStatus"`
    // contains filtered or unexported fields
}

Cross-cluster search specific connection properties.

func (CrossClusterSearchConnectionProperties) GoString

func (s CrossClusterSearchConnectionProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CrossClusterSearchConnectionProperties) SetSkipUnavailable

func (s *CrossClusterSearchConnectionProperties) SetSkipUnavailable(v string) *CrossClusterSearchConnectionProperties

SetSkipUnavailable sets the SkipUnavailable field's value.

func (CrossClusterSearchConnectionProperties) String

func (s CrossClusterSearchConnectionProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSourceDetails

type DataSourceDetails struct {

    // The type of data source.
    DataSourceType *DataSourceType `type:"structure"`

    // A description of the data source.
    Description *string `type:"string"`

    // The name of the data source.
    Name *string `min:"3" type:"string"`

    // The status of the data source.
    Status *string `type:"string" enum:"DataSourceStatus"`
    // contains filtered or unexported fields
}

Details about a direct-query data source.

func (DataSourceDetails) GoString

func (s DataSourceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceDetails) SetDataSourceType

func (s *DataSourceDetails) SetDataSourceType(v *DataSourceType) *DataSourceDetails

SetDataSourceType sets the DataSourceType field's value.

func (*DataSourceDetails) SetDescription

func (s *DataSourceDetails) SetDescription(v string) *DataSourceDetails

SetDescription sets the Description field's value.

func (*DataSourceDetails) SetName

func (s *DataSourceDetails) SetName(v string) *DataSourceDetails

SetName sets the Name field's value.

func (*DataSourceDetails) SetStatus

func (s *DataSourceDetails) SetStatus(v string) *DataSourceDetails

SetStatus sets the Status field's value.

func (DataSourceDetails) String

func (s DataSourceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSourceType

type DataSourceType struct {

    // An Amazon S3 data source.
    S3GlueDataCatalog *S3GlueDataCatalog `type:"structure"`
    // contains filtered or unexported fields
}

The type of data source.

func (DataSourceType) GoString

func (s DataSourceType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceType) SetS3GlueDataCatalog

func (s *DataSourceType) SetS3GlueDataCatalog(v *S3GlueDataCatalog) *DataSourceType

SetS3GlueDataCatalog sets the S3GlueDataCatalog field's value.

func (DataSourceType) String

func (s DataSourceType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceType) Validate

func (s *DataSourceType) Validate() error

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

type DeleteDataSourceInput

type DeleteDataSourceInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // The name of the data source to delete.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"DataSourceName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DeleteDataSource operation.

func (DeleteDataSourceInput) GoString

func (s DeleteDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DeleteDataSourceInput) SetName

func (s *DeleteDataSourceInput) SetName(v string) *DeleteDataSourceInput

SetName sets the Name field's value.

func (DeleteDataSourceInput) String

func (s DeleteDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceInput) Validate

func (s *DeleteDataSourceInput) Validate() error

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

type DeleteDataSourceOutput

type DeleteDataSourceOutput struct {

    // A message associated with deletion of the data source.
    Message *string `type:"string"`
    // contains filtered or unexported fields
}

The result of a GetDataSource operation.

func (DeleteDataSourceOutput) GoString

func (s DeleteDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceOutput) SetMessage

func (s *DeleteDataSourceOutput) SetMessage(v string) *DeleteDataSourceOutput

SetMessage sets the Message field's value.

func (DeleteDataSourceOutput) String

func (s DeleteDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDomainInput

type DeleteDomainInput struct {

    // The name of the domain you want to permanently delete.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DeleteDomain operation.

func (DeleteDomainInput) GoString

func (s DeleteDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (DeleteDomainInput) String

func (s DeleteDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainInput) Validate

func (s *DeleteDomainInput) Validate() error

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

type DeleteDomainOutput

type DeleteDomainOutput struct {

    // The status of the domain being deleted.
    DomainStatus *DomainStatus `type:"structure"`
    // 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.

func (DeleteDomainOutput) GoString

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainOutput) SetDomainStatus

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

SetDomainStatus sets the DomainStatus field's value.

func (DeleteDomainOutput) String

func (s DeleteDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteInboundConnectionInput

type DeleteInboundConnectionInput struct {

    // The ID of the inbound connection to permanently delete.
    //
    // ConnectionId is a required field
    ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DeleteInboundConnection operation.

func (DeleteInboundConnectionInput) GoString

func (s DeleteInboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInboundConnectionInput) SetConnectionId

func (s *DeleteInboundConnectionInput) SetConnectionId(v string) *DeleteInboundConnectionInput

SetConnectionId sets the ConnectionId field's value.

func (DeleteInboundConnectionInput) String

func (s DeleteInboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInboundConnectionInput) Validate

func (s *DeleteInboundConnectionInput) Validate() error

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

type DeleteInboundConnectionOutput

type DeleteInboundConnectionOutput struct {

    // The deleted inbound connection.
    Connection *InboundConnection `type:"structure"`
    // contains filtered or unexported fields
}

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

func (DeleteInboundConnectionOutput) GoString

func (s DeleteInboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInboundConnectionOutput) SetConnection

func (s *DeleteInboundConnectionOutput) SetConnection(v *InboundConnection) *DeleteInboundConnectionOutput

SetConnection sets the Connection field's value.

func (DeleteInboundConnectionOutput) String

func (s DeleteInboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteOutboundConnectionInput

type DeleteOutboundConnectionInput struct {

    // The ID of the outbound connection you want to permanently delete.
    //
    // ConnectionId is a required field
    ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DeleteOutboundConnection operation.

func (DeleteOutboundConnectionInput) GoString

func (s DeleteOutboundConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOutboundConnectionInput) SetConnectionId

func (s *DeleteOutboundConnectionInput) SetConnectionId(v string) *DeleteOutboundConnectionInput

SetConnectionId sets the ConnectionId field's value.

func (DeleteOutboundConnectionInput) String

func (s DeleteOutboundConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOutboundConnectionInput) Validate

func (s *DeleteOutboundConnectionInput) Validate() error

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

type DeleteOutboundConnectionOutput

type DeleteOutboundConnectionOutput struct {

    // The deleted inbound connection.
    Connection *OutboundConnection `type:"structure"`
    // contains filtered or unexported fields
}

Details about the deleted outbound connection.

func (DeleteOutboundConnectionOutput) GoString

func (s DeleteOutboundConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteOutboundConnectionOutput) SetConnection

func (s *DeleteOutboundConnectionOutput) SetConnection(v *OutboundConnection) *DeleteOutboundConnectionOutput

SetConnection sets the Connection field's value.

func (DeleteOutboundConnectionOutput) String

func (s DeleteOutboundConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePackageInput

type DeletePackageInput struct {

    // The internal ID of the package you want to delete. Use DescribePackages to
    // find this value.
    //
    // PackageID is a required field
    PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
    // contains filtered or unexported fields
}

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

func (DeletePackageInput) GoString

func (s DeletePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePackageInput) SetPackageID

func (s *DeletePackageInput) SetPackageID(v string) *DeletePackageInput

SetPackageID sets the PackageID field's value.

func (DeletePackageInput) String

func (s DeletePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePackageInput) Validate

func (s *DeletePackageInput) Validate() error

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

type DeletePackageOutput

type DeletePackageOutput struct {

    // Information about the deleted package.
    PackageDetails *PackageDetails `type:"structure"`
    // contains filtered or unexported fields
}

Container for the response parameters to the DeletePackage operation.

func (DeletePackageOutput) GoString

func (s DeletePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePackageOutput) SetPackageDetails

func (s *DeletePackageOutput) SetPackageDetails(v *PackageDetails) *DeletePackageOutput

SetPackageDetails sets the PackageDetails field's value.

func (DeletePackageOutput) String

func (s DeletePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteVpcEndpointInput

type DeleteVpcEndpointInput struct {

    // The unique identifier of the endpoint.
    //
    // VpcEndpointId is a required field
    VpcEndpointId *string `location:"uri" locationName:"VpcEndpointId" min:"5" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteVpcEndpointInput) GoString

func (s DeleteVpcEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVpcEndpointInput) SetVpcEndpointId

func (s *DeleteVpcEndpointInput) SetVpcEndpointId(v string) *DeleteVpcEndpointInput

SetVpcEndpointId sets the VpcEndpointId field's value.

func (DeleteVpcEndpointInput) String

func (s DeleteVpcEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVpcEndpointInput) Validate

func (s *DeleteVpcEndpointInput) Validate() error

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

type DeleteVpcEndpointOutput

type DeleteVpcEndpointOutput struct {

    // Information about the deleted endpoint, including its current status (DELETING
    // or DELETE_FAILED).
    //
    // VpcEndpointSummary is a required field
    VpcEndpointSummary *VpcEndpointSummary `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteVpcEndpointOutput) GoString

func (s DeleteVpcEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVpcEndpointOutput) SetVpcEndpointSummary

func (s *DeleteVpcEndpointOutput) SetVpcEndpointSummary(v *VpcEndpointSummary) *DeleteVpcEndpointOutput

SetVpcEndpointSummary sets the VpcEndpointSummary field's value.

func (DeleteVpcEndpointOutput) String

func (s DeleteVpcEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DependencyFailureException

type DependencyFailureException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

func (*DependencyFailureException) Code

func (s *DependencyFailureException) Code() string

Code returns the exception type name.

func (*DependencyFailureException) Error

func (s *DependencyFailureException) Error() string

func (DependencyFailureException) GoString

func (s DependencyFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependencyFailureException) Message

func (s *DependencyFailureException) Message() string

Message returns the exception's message.

func (*DependencyFailureException) OrigErr

func (s *DependencyFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependencyFailureException) RequestID

func (s *DependencyFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependencyFailureException) StatusCode

func (s *DependencyFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DependencyFailureException) String

func (s DependencyFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainAutoTunesInput

type DescribeDomainAutoTunesInput struct {

    // Name of the domain that you want Auto-Tune details about.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `type:"integer"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainAutoTunes operation.

func (DescribeDomainAutoTunesInput) GoString

func (s DescribeDomainAutoTunesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainAutoTunesInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DescribeDomainAutoTunesInput) SetMaxResults

func (s *DescribeDomainAutoTunesInput) SetMaxResults(v int64) *DescribeDomainAutoTunesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeDomainAutoTunesInput) SetNextToken

func (s *DescribeDomainAutoTunesInput) SetNextToken(v string) *DescribeDomainAutoTunesInput

SetNextToken sets the NextToken field's value.

func (DescribeDomainAutoTunesInput) String

func (s DescribeDomainAutoTunesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainAutoTunesInput) Validate

func (s *DescribeDomainAutoTunesInput) Validate() error

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

type DescribeDomainAutoTunesOutput

type DescribeDomainAutoTunesOutput struct {

    // The list of setting adjustments that Auto-Tune has made to the domain.
    AutoTunes []*AutoTune `type:"list"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

The result of a DescribeDomainAutoTunes request.

func (DescribeDomainAutoTunesOutput) GoString

func (s DescribeDomainAutoTunesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainAutoTunesOutput) SetAutoTunes

func (s *DescribeDomainAutoTunesOutput) SetAutoTunes(v []*AutoTune) *DescribeDomainAutoTunesOutput

SetAutoTunes sets the AutoTunes field's value.

func (*DescribeDomainAutoTunesOutput) SetNextToken

func (s *DescribeDomainAutoTunesOutput) SetNextToken(v string) *DescribeDomainAutoTunesOutput

SetNextToken sets the NextToken field's value.

func (DescribeDomainAutoTunesOutput) String

func (s DescribeDomainAutoTunesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainChangeProgressInput

type DescribeDomainChangeProgressInput struct {

    // 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 `location:"querystring" locationName:"changeid" min:"36" type:"string"`

    // The name of the domain to get progress information for.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainChangeProgress operation.

func (DescribeDomainChangeProgressInput) GoString

func (s DescribeDomainChangeProgressInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainChangeProgressInput) SetChangeId

func (s *DescribeDomainChangeProgressInput) SetChangeId(v string) *DescribeDomainChangeProgressInput

SetChangeId sets the ChangeId field's value.

func (*DescribeDomainChangeProgressInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (DescribeDomainChangeProgressInput) String

func (s DescribeDomainChangeProgressInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainChangeProgressInput) Validate

func (s *DescribeDomainChangeProgressInput) Validate() error

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

type DescribeDomainChangeProgressOutput

type DescribeDomainChangeProgressOutput struct {

    // Container for information about the stages of a configuration change happening
    // on a domain.
    ChangeProgressStatus *ChangeProgressStatusDetails `type:"structure"`
    // contains filtered or unexported fields
}

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

func (DescribeDomainChangeProgressOutput) GoString

func (s DescribeDomainChangeProgressOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainChangeProgressOutput) SetChangeProgressStatus

func (s *DescribeDomainChangeProgressOutput) SetChangeProgressStatus(v *ChangeProgressStatusDetails) *DescribeDomainChangeProgressOutput

SetChangeProgressStatus sets the ChangeProgressStatus field's value.

func (DescribeDomainChangeProgressOutput) String

func (s DescribeDomainChangeProgressOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainConfigInput

type DescribeDomainConfigInput struct {

    // Name of the OpenSearch Service domain configuration that you want to describe.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainConfig operation.

func (DescribeDomainConfigInput) GoString

func (s DescribeDomainConfigInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (DescribeDomainConfigInput) String

func (s DescribeDomainConfigInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigInput) Validate

func (s *DescribeDomainConfigInput) Validate() error

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

type DescribeDomainConfigOutput

type DescribeDomainConfigOutput struct {

    // Container for the configuration of the OpenSearch Service domain.
    //
    // DomainConfig is a required field
    DomainConfig *DomainConfig `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Contains the configuration information of the requested domain.

func (DescribeDomainConfigOutput) GoString

func (s DescribeDomainConfigOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainConfigOutput) SetDomainConfig

func (s *DescribeDomainConfigOutput) SetDomainConfig(v *DomainConfig) *DescribeDomainConfigOutput

SetDomainConfig sets the DomainConfig field's value.

func (DescribeDomainConfigOutput) String

func (s DescribeDomainConfigOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainHealthInput

type DescribeDomainHealthInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainHealth operation.

func (DescribeDomainHealthInput) GoString

func (s DescribeDomainHealthInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainHealthInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (DescribeDomainHealthInput) String

func (s DescribeDomainHealthInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainHealthInput) Validate

func (s *DescribeDomainHealthInput) Validate() error

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

type DescribeDomainHealthOutput

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

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

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

    // A list of EnvironmentInfo for the domain.
    EnvironmentInformation []*EnvironmentInfo `type:"list"`

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

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

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

    // The number of warm nodes configured for the domain.
    WarmNodeCount *string `type:"string"`
    // contains filtered or unexported fields
}

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

func (DescribeDomainHealthOutput) GoString

func (s DescribeDomainHealthOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainHealthOutput) SetActiveAvailabilityZoneCount

func (s *DescribeDomainHealthOutput) SetActiveAvailabilityZoneCount(v string) *DescribeDomainHealthOutput

SetActiveAvailabilityZoneCount sets the ActiveAvailabilityZoneCount field's value.

func (*DescribeDomainHealthOutput) SetAvailabilityZoneCount

func (s *DescribeDomainHealthOutput) SetAvailabilityZoneCount(v string) *DescribeDomainHealthOutput

SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.

func (*DescribeDomainHealthOutput) SetClusterHealth

func (s *DescribeDomainHealthOutput) SetClusterHealth(v string) *DescribeDomainHealthOutput

SetClusterHealth sets the ClusterHealth field's value.

func (*DescribeDomainHealthOutput) SetDataNodeCount

func (s *DescribeDomainHealthOutput) SetDataNodeCount(v string) *DescribeDomainHealthOutput

SetDataNodeCount sets the DataNodeCount field's value.

func (*DescribeDomainHealthOutput) SetDedicatedMaster

func (s *DescribeDomainHealthOutput) SetDedicatedMaster(v bool) *DescribeDomainHealthOutput

SetDedicatedMaster sets the DedicatedMaster field's value.

func (*DescribeDomainHealthOutput) SetDomainState

func (s *DescribeDomainHealthOutput) SetDomainState(v string) *DescribeDomainHealthOutput

SetDomainState sets the DomainState field's value.

func (*DescribeDomainHealthOutput) SetEnvironmentInformation

func (s *DescribeDomainHealthOutput) SetEnvironmentInformation(v []*EnvironmentInfo) *DescribeDomainHealthOutput

SetEnvironmentInformation sets the EnvironmentInformation field's value.

func (*DescribeDomainHealthOutput) SetMasterEligibleNodeCount

func (s *DescribeDomainHealthOutput) SetMasterEligibleNodeCount(v string) *DescribeDomainHealthOutput

SetMasterEligibleNodeCount sets the MasterEligibleNodeCount field's value.

func (*DescribeDomainHealthOutput) SetMasterNode

func (s *DescribeDomainHealthOutput) SetMasterNode(v string) *DescribeDomainHealthOutput

SetMasterNode sets the MasterNode field's value.

func (*DescribeDomainHealthOutput) SetStandByAvailabilityZoneCount

func (s *DescribeDomainHealthOutput) SetStandByAvailabilityZoneCount(v string) *DescribeDomainHealthOutput

SetStandByAvailabilityZoneCount sets the StandByAvailabilityZoneCount field's value.

func (*DescribeDomainHealthOutput) SetTotalShards

func (s *DescribeDomainHealthOutput) SetTotalShards(v string) *DescribeDomainHealthOutput

SetTotalShards sets the TotalShards field's value.

func (*DescribeDomainHealthOutput) SetTotalUnAssignedShards

func (s *DescribeDomainHealthOutput) SetTotalUnAssignedShards(v string) *DescribeDomainHealthOutput

SetTotalUnAssignedShards sets the TotalUnAssignedShards field's value.

func (*DescribeDomainHealthOutput) SetWarmNodeCount

func (s *DescribeDomainHealthOutput) SetWarmNodeCount(v string) *DescribeDomainHealthOutput

SetWarmNodeCount sets the WarmNodeCount field's value.

func (DescribeDomainHealthOutput) String

func (s DescribeDomainHealthOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainInput

type DescribeDomainInput struct {

    // The name of the domain that you want information about.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeDomain operation.

func (DescribeDomainInput) GoString

func (s DescribeDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (DescribeDomainInput) String

func (s DescribeDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainInput) Validate

func (s *DescribeDomainInput) Validate() error

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

type DescribeDomainNodesInput

type DescribeDomainNodesInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeDomainNodes operation.

func (DescribeDomainNodesInput) GoString

func (s DescribeDomainNodesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainNodesInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (DescribeDomainNodesInput) String

func (s DescribeDomainNodesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainNodesInput) Validate

func (s *DescribeDomainNodesInput) Validate() error

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

type DescribeDomainNodesOutput

type DescribeDomainNodesOutput struct {

    // Contains nodes information list DomainNodesStatusList with details about
    // the all nodes on the requested domain.
    DomainNodesStatusList []*DomainNodesStatus `type:"list"`
    // contains filtered or unexported fields
}

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

func (DescribeDomainNodesOutput) GoString

func (s DescribeDomainNodesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainNodesOutput) SetDomainNodesStatusList

func (s *DescribeDomainNodesOutput) SetDomainNodesStatusList(v []*DomainNodesStatus) *DescribeDomainNodesOutput

SetDomainNodesStatusList sets the DomainNodesStatusList field's value.

func (DescribeDomainNodesOutput) String

func (s DescribeDomainNodesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainOutput

type DescribeDomainOutput struct {

    // List that contains the status of each specified OpenSearch Service domain.
    //
    // DomainStatus is a required field
    DomainStatus *DomainStatus `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Contains the status of the domain specified in the request.

func (DescribeDomainOutput) GoString

func (s DescribeDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainOutput) SetDomainStatus

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

SetDomainStatus sets the DomainStatus field's value.

func (DescribeDomainOutput) String

func (s DescribeDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainsInput

type DescribeDomainsInput struct {

    // Array of OpenSearch Service domain names that you want information about.
    // You must specify at least one domain name.
    //
    // DomainNames is a required field
    DomainNames []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeDomains operation.

func (DescribeDomainsInput) GoString

func (s DescribeDomainsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainsInput) SetDomainNames

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

SetDomainNames sets the DomainNames field's value.

func (DescribeDomainsInput) String

func (s DescribeDomainsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainsInput) Validate

func (s *DescribeDomainsInput) Validate() error

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

type DescribeDomainsOutput

type DescribeDomainsOutput struct {

    // The status of the requested domains.
    //
    // DomainStatusList is a required field
    DomainStatusList []*DomainStatus `type:"list" required:"true"`
    // contains filtered or unexported fields
}

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

func (DescribeDomainsOutput) GoString

func (s DescribeDomainsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainsOutput) SetDomainStatusList

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

SetDomainStatusList sets the DomainStatusList field's value.

func (DescribeDomainsOutput) String

func (s DescribeDomainsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDryRunProgressInput

type DescribeDryRunProgressInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // The unique identifier of the dry run.
    DryRunId *string `location:"querystring" locationName:"dryRunId" min:"36" type:"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 `location:"querystring" locationName:"loadDryRunConfig" type:"boolean"`
    // contains filtered or unexported fields
}

func (DescribeDryRunProgressInput) GoString

func (s DescribeDryRunProgressInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDryRunProgressInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DescribeDryRunProgressInput) SetDryRunId

func (s *DescribeDryRunProgressInput) SetDryRunId(v string) *DescribeDryRunProgressInput

SetDryRunId sets the DryRunId field's value.

func (*DescribeDryRunProgressInput) SetLoadDryRunConfig

func (s *DescribeDryRunProgressInput) SetLoadDryRunConfig(v bool) *DescribeDryRunProgressInput

SetLoadDryRunConfig sets the LoadDryRunConfig field's value.

func (DescribeDryRunProgressInput) String

func (s DescribeDryRunProgressInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDryRunProgressInput) Validate

func (s *DescribeDryRunProgressInput) Validate() error

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

type DescribeDryRunProgressOutput

type DescribeDryRunProgressOutput struct {

    // Details about the changes you're planning to make on the domain.
    DryRunConfig *DomainStatus `type:"structure"`

    // The current status of the dry run, including any validation errors.
    DryRunProgressStatus *DryRunProgressStatus `type:"structure"`

    // The results of the dry run.
    DryRunResults *DryRunResults `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeDryRunProgressOutput) GoString

func (s DescribeDryRunProgressOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDryRunProgressOutput) SetDryRunConfig

func (s *DescribeDryRunProgressOutput) SetDryRunConfig(v *DomainStatus) *DescribeDryRunProgressOutput

SetDryRunConfig sets the DryRunConfig field's value.

func (*DescribeDryRunProgressOutput) SetDryRunProgressStatus

func (s *DescribeDryRunProgressOutput) SetDryRunProgressStatus(v *DryRunProgressStatus) *DescribeDryRunProgressOutput

SetDryRunProgressStatus sets the DryRunProgressStatus field's value.

func (*DescribeDryRunProgressOutput) SetDryRunResults

func (s *DescribeDryRunProgressOutput) SetDryRunResults(v *DryRunResults) *DescribeDryRunProgressOutput

SetDryRunResults sets the DryRunResults field's value.

func (DescribeDryRunProgressOutput) String

func (s DescribeDryRunProgressOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeInboundConnectionsInput

type DescribeInboundConnectionsInput struct {

    // A list of filters used to match properties for inbound cross-cluster connections.
    Filters []*Filter `type:"list"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `type:"integer"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeInboundConnections operation.

func (DescribeInboundConnectionsInput) GoString

func (s DescribeInboundConnectionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInboundConnectionsInput) SetFilters

func (s *DescribeInboundConnectionsInput) SetFilters(v []*Filter) *DescribeInboundConnectionsInput

SetFilters sets the Filters field's value.

func (*DescribeInboundConnectionsInput) SetMaxResults

func (s *DescribeInboundConnectionsInput) SetMaxResults(v int64) *DescribeInboundConnectionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeInboundConnectionsInput) SetNextToken

func (s *DescribeInboundConnectionsInput) SetNextToken(v string) *DescribeInboundConnectionsInput

SetNextToken sets the NextToken field's value.

func (DescribeInboundConnectionsInput) String

func (s DescribeInboundConnectionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInboundConnectionsInput) Validate

func (s *DescribeInboundConnectionsInput) Validate() error

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

type DescribeInboundConnectionsOutput

type DescribeInboundConnectionsOutput struct {

    // List of inbound connections.
    Connections []*InboundConnection `type:"list"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Contains a list of connections matching the filter criteria.

func (DescribeInboundConnectionsOutput) GoString

func (s DescribeInboundConnectionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInboundConnectionsOutput) SetConnections

func (s *DescribeInboundConnectionsOutput) SetConnections(v []*InboundConnection) *DescribeInboundConnectionsOutput

SetConnections sets the Connections field's value.

func (*DescribeInboundConnectionsOutput) SetNextToken

func (s *DescribeInboundConnectionsOutput) SetNextToken(v string) *DescribeInboundConnectionsOutput

SetNextToken sets the NextToken field's value.

func (DescribeInboundConnectionsOutput) String

func (s DescribeInboundConnectionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeInstanceTypeLimitsInput

type DescribeInstanceTypeLimitsInput struct {

    // The name of the domain. Only specify if you need the limits for an existing
    // domain.
    DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"`

    // Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
    // OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
    //
    // EngineVersion is a required field
    EngineVersion *string `location:"uri" locationName:"EngineVersion" min:"14" type:"string" required:"true"`

    // The OpenSearch Service instance type for which you need limit information.
    //
    // InstanceType is a required field
    InstanceType *string `location:"uri" locationName:"InstanceType" type:"string" required:"true" enum:"OpenSearchPartitionInstanceType"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeInstanceTypeLimits operation.

func (DescribeInstanceTypeLimitsInput) GoString

func (s DescribeInstanceTypeLimitsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceTypeLimitsInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DescribeInstanceTypeLimitsInput) SetEngineVersion

func (s *DescribeInstanceTypeLimitsInput) SetEngineVersion(v string) *DescribeInstanceTypeLimitsInput

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeInstanceTypeLimitsInput) SetInstanceType

func (s *DescribeInstanceTypeLimitsInput) SetInstanceType(v string) *DescribeInstanceTypeLimitsInput

SetInstanceType sets the InstanceType field's value.

func (DescribeInstanceTypeLimitsInput) String

func (s DescribeInstanceTypeLimitsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceTypeLimitsInput) Validate

func (s *DescribeInstanceTypeLimitsInput) Validate() error

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

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]*Limits `type:"map"`
    // contains filtered or unexported fields
}

Container for the parameters received from the DescribeInstanceTypeLimits operation.

func (DescribeInstanceTypeLimitsOutput) GoString

func (s DescribeInstanceTypeLimitsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInstanceTypeLimitsOutput) SetLimitsByRole

func (s *DescribeInstanceTypeLimitsOutput) SetLimitsByRole(v map[string]*Limits) *DescribeInstanceTypeLimitsOutput

SetLimitsByRole sets the LimitsByRole field's value.

func (DescribeInstanceTypeLimitsOutput) String

func (s DescribeInstanceTypeLimitsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOutboundConnectionsInput

type DescribeOutboundConnectionsInput struct {

    // List of filter names and values that you can use for requests.
    Filters []*Filter `type:"list"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `type:"integer"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Container for the parameters to the DescribeOutboundConnections operation.

func (DescribeOutboundConnectionsInput) GoString

func (s DescribeOutboundConnectionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOutboundConnectionsInput) SetFilters

func (s *DescribeOutboundConnectionsInput) SetFilters(v []*Filter) *DescribeOutboundConnectionsInput

SetFilters sets the Filters field's value.

func (*DescribeOutboundConnectionsInput) SetMaxResults

func (s *DescribeOutboundConnectionsInput) SetMaxResults(v int64) *DescribeOutboundConnectionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeOutboundConnectionsInput) SetNextToken

func (s *DescribeOutboundConnectionsInput) SetNextToken(v string) *DescribeOutboundConnectionsInput

SetNextToken sets the NextToken field's value.

func (DescribeOutboundConnectionsInput) String

func (s DescribeOutboundConnectionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOutboundConnectionsInput) Validate

func (s *DescribeOutboundConnectionsInput) Validate() error

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

type DescribeOutboundConnectionsOutput

type DescribeOutboundConnectionsOutput struct {

    // List of outbound connections that match the filter criteria.
    Connections []*OutboundConnection `type:"list"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Contains a list of connections matching the filter criteria.

func (DescribeOutboundConnectionsOutput) GoString

func (s DescribeOutboundConnectionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOutboundConnectionsOutput) SetConnections

func (s *DescribeOutboundConnectionsOutput) SetConnections(v []*OutboundConnection) *DescribeOutboundConnectionsOutput

SetConnections sets the Connections field's value.

func (*DescribeOutboundConnectionsOutput) SetNextToken

func (s *DescribeOutboundConnectionsOutput) SetNextToken(v string) *DescribeOutboundConnectionsOutput

SetNextToken sets the NextToken field's value.

func (DescribeOutboundConnectionsOutput) String

func (s DescribeOutboundConnectionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePackagesFilter

type DescribePackagesFilter struct {

    // Any field from PackageDetails.
    Name *string `type:"string" enum:"DescribePackagesFilterName"`

    // A non-empty list of values for the specified filter field.
    Value []*string `min:"1" type:"list"`
    // contains filtered or unexported fields
}

A filter to apply to the DescribePackage response.

func (DescribePackagesFilter) GoString

func (s DescribePackagesFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesFilter) SetName

func (s *DescribePackagesFilter) SetName(v string) *DescribePackagesFilter

SetName sets the Name field's value.

func (*DescribePackagesFilter) SetValue

func (s *DescribePackagesFilter) SetValue(v []*string) *DescribePackagesFilter

SetValue sets the Value field's value.

func (DescribePackagesFilter) String

func (s DescribePackagesFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesFilter) Validate

func (s *DescribePackagesFilter) Validate() error

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

type DescribePackagesInput

type DescribePackagesInput struct {

    // Only returns packages that match the DescribePackagesFilterList values.
    Filters []*DescribePackagesFilter `type:"list"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `type:"integer"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Container for the request parameters to the DescribePackage operation.

func (DescribePackagesInput) GoString

func (s DescribePackagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesInput) SetFilters

func (s *DescribePackagesInput) SetFilters(v []*DescribePackagesFilter) *DescribePackagesInput

SetFilters sets the Filters field's value.

func (*DescribePackagesInput) SetMaxResults

func (s *DescribePackagesInput) SetMaxResults(v int64) *DescribePackagesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribePackagesInput) SetNextToken

func (s *DescribePackagesInput) SetNextToken(v string) *DescribePackagesInput

SetNextToken sets the NextToken field's value.

func (DescribePackagesInput) String

func (s DescribePackagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesInput) Validate

func (s *DescribePackagesInput) Validate() error

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

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

    // Basic information about a package.
    PackageDetailsList []*PackageDetails `type:"list"`
    // contains filtered or unexported fields
}

Container for the response returned by the DescribePackages operation.

func (DescribePackagesOutput) GoString

func (s DescribePackagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePackagesOutput) SetNextToken

func (s *DescribePackagesOutput) SetNextToken(v string) *DescribePackagesOutput

SetNextToken sets the NextToken field's value.

func (*DescribePackagesOutput) SetPackageDetailsList

func (s *DescribePackagesOutput) SetPackageDetailsList(v []*PackageDetails) *DescribePackagesOutput

SetPackageDetailsList sets the PackageDetailsList field's value.

func (DescribePackagesOutput) String

func (s DescribePackagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"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 `location:"querystring" locationName:"offeringId" min:"36" type:"string"`
    // contains filtered or unexported fields
}

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

func (DescribeReservedInstanceOfferingsInput) GoString

func (s DescribeReservedInstanceOfferingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstanceOfferingsInput) SetMaxResults

func (s *DescribeReservedInstanceOfferingsInput) SetMaxResults(v int64) *DescribeReservedInstanceOfferingsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeReservedInstanceOfferingsInput) SetNextToken

func (s *DescribeReservedInstanceOfferingsInput) SetNextToken(v string) *DescribeReservedInstanceOfferingsInput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstanceOfferingsInput) SetReservedInstanceOfferingId

func (s *DescribeReservedInstanceOfferingsInput) SetReservedInstanceOfferingId(v string) *DescribeReservedInstanceOfferingsInput

SetReservedInstanceOfferingId sets the ReservedInstanceOfferingId field's value.

func (DescribeReservedInstanceOfferingsInput) String

func (s DescribeReservedInstanceOfferingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstanceOfferingsInput) Validate

func (s *DescribeReservedInstanceOfferingsInput) Validate() error

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

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

    // List of Reserved Instance offerings.
    ReservedInstanceOfferings []*ReservedInstanceOffering `type:"list"`
    // contains filtered or unexported fields
}

Container for results of a DescribeReservedInstanceOfferings request.

func (DescribeReservedInstanceOfferingsOutput) GoString

func (s DescribeReservedInstanceOfferingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstanceOfferingsOutput) SetNextToken

func (s *DescribeReservedInstanceOfferingsOutput) SetNextToken(v string) *DescribeReservedInstanceOfferingsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstanceOfferingsOutput) SetReservedInstanceOfferings

func (s *DescribeReservedInstanceOfferingsOutput) SetReservedInstanceOfferings(v []*ReservedInstanceOffering) *DescribeReservedInstanceOfferingsOutput

SetReservedInstanceOfferings sets the ReservedInstanceOfferings field's value.

func (DescribeReservedInstanceOfferingsOutput) String

func (s DescribeReservedInstanceOfferingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"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 `location:"querystring" locationName:"reservationId" min:"36" type:"string"`
    // contains filtered or unexported fields
}

Container for the request parameters to the DescribeReservedInstances operation.

func (DescribeReservedInstancesInput) GoString

func (s DescribeReservedInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstancesInput) SetMaxResults

func (s *DescribeReservedInstancesInput) SetMaxResults(v int64) *DescribeReservedInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeReservedInstancesInput) SetNextToken

func (s *DescribeReservedInstancesInput) SetNextToken(v string) *DescribeReservedInstancesInput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstancesInput) SetReservedInstanceId

func (s *DescribeReservedInstancesInput) SetReservedInstanceId(v string) *DescribeReservedInstancesInput

SetReservedInstanceId sets the ReservedInstanceId field's value.

func (DescribeReservedInstancesInput) String

func (s DescribeReservedInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstancesInput) Validate

func (s *DescribeReservedInstancesInput) Validate() error

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

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

    // List of Reserved Instances in the current Region.
    ReservedInstances []*ReservedInstance `type:"list"`
    // contains filtered or unexported fields
}

Container for results from DescribeReservedInstances

func (DescribeReservedInstancesOutput) GoString

func (s DescribeReservedInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedInstancesOutput) SetNextToken

func (s *DescribeReservedInstancesOutput) SetNextToken(v string) *DescribeReservedInstancesOutput

SetNextToken sets the NextToken field's value.

func (*DescribeReservedInstancesOutput) SetReservedInstances

func (s *DescribeReservedInstancesOutput) SetReservedInstances(v []*ReservedInstance) *DescribeReservedInstancesOutput

SetReservedInstances sets the ReservedInstances field's value.

func (DescribeReservedInstancesOutput) String

func (s DescribeReservedInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeVpcEndpointsInput

type DescribeVpcEndpointsInput struct {

    // The unique identifiers of the endpoints to get information about.
    //
    // VpcEndpointIds is a required field
    VpcEndpointIds []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeVpcEndpointsInput) GoString

func (s DescribeVpcEndpointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVpcEndpointsInput) SetVpcEndpointIds

func (s *DescribeVpcEndpointsInput) SetVpcEndpointIds(v []*string) *DescribeVpcEndpointsInput

SetVpcEndpointIds sets the VpcEndpointIds field's value.

func (DescribeVpcEndpointsInput) String

func (s DescribeVpcEndpointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVpcEndpointsInput) Validate

func (s *DescribeVpcEndpointsInput) Validate() error

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

type DescribeVpcEndpointsOutput

type DescribeVpcEndpointsOutput struct {

    // Any errors associated with the request.
    //
    // VpcEndpointErrors is a required field
    VpcEndpointErrors []*VpcEndpointError `type:"list" required:"true"`

    // Information about each requested VPC endpoint.
    //
    // VpcEndpoints is a required field
    VpcEndpoints []*VpcEndpoint `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeVpcEndpointsOutput) GoString

func (s DescribeVpcEndpointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVpcEndpointsOutput) SetVpcEndpointErrors

func (s *DescribeVpcEndpointsOutput) SetVpcEndpointErrors(v []*VpcEndpointError) *DescribeVpcEndpointsOutput

SetVpcEndpointErrors sets the VpcEndpointErrors field's value.

func (*DescribeVpcEndpointsOutput) SetVpcEndpoints

func (s *DescribeVpcEndpointsOutput) SetVpcEndpoints(v []*VpcEndpoint) *DescribeVpcEndpointsOutput

SetVpcEndpoints sets the VpcEndpoints field's value.

func (DescribeVpcEndpointsOutput) String

func (s DescribeVpcEndpointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisabledOperationException

type DisabledOperationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

An error occured because the client wanted to access an unsupported operation.

func (*DisabledOperationException) Code

func (s *DisabledOperationException) Code() string

Code returns the exception type name.

func (*DisabledOperationException) Error

func (s *DisabledOperationException) Error() string

func (DisabledOperationException) GoString

func (s DisabledOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisabledOperationException) Message

func (s *DisabledOperationException) Message() string

Message returns the exception's message.

func (*DisabledOperationException) OrigErr

func (s *DisabledOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DisabledOperationException) RequestID

func (s *DisabledOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DisabledOperationException) StatusCode

func (s *DisabledOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DisabledOperationException) String

func (s DisabledOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DissociatePackageInput

type DissociatePackageInput struct {

    // Name of the domain to dissociate the package from.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain
    // to find this value.
    //
    // PackageID is a required field
    PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the request parameters to the DissociatePackage operation.

func (DissociatePackageInput) GoString

func (s DissociatePackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DissociatePackageInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DissociatePackageInput) SetPackageID

func (s *DissociatePackageInput) SetPackageID(v string) *DissociatePackageInput

SetPackageID sets the PackageID field's value.

func (DissociatePackageInput) String

func (s DissociatePackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DissociatePackageInput) Validate

func (s *DissociatePackageInput) Validate() error

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

type DissociatePackageOutput

type DissociatePackageOutput struct {

    // Information about a package that has been dissociated from the domain.
    DomainPackageDetails *DomainPackageDetails `type:"structure"`
    // contains filtered or unexported fields
}

Container for the response returned by an DissociatePackage operation.

func (DissociatePackageOutput) GoString

func (s DissociatePackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DissociatePackageOutput) SetDomainPackageDetails

func (s *DissociatePackageOutput) SetDomainPackageDetails(v *DomainPackageDetails) *DissociatePackageOutput

SetDomainPackageDetails sets the DomainPackageDetails field's value.

func (DissociatePackageOutput) String

func (s DissociatePackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainConfig

type DomainConfig struct {

    // Container for parameters required to enable all machine learning features.
    AIMLOptions *AIMLOptionsStatus `type:"structure"`

    // Specifies the access policies for the domain.
    AccessPolicies *AccessPoliciesStatus `type:"structure"`

    // Key-value pairs to specify advanced configuration options. For more information,
    // see Advanced options (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).
    AdvancedOptions *AdvancedOptionsStatus `type:"structure"`

    // Container for fine-grained access control settings for the domain.
    AdvancedSecurityOptions *AdvancedSecurityOptionsStatus `type:"structure"`

    // Container for Auto-Tune settings for the domain.
    AutoTuneOptions *AutoTuneOptionsStatus `type:"structure"`

    // Container for information about the progress of an existing configuration
    // change.
    ChangeProgressDetails *ChangeProgressDetails `type:"structure"`

    // Container for the cluster configuration of a the domain.
    ClusterConfig *ClusterConfigStatus `type:"structure"`

    // Container for Amazon Cognito options for the domain.
    CognitoOptions *CognitoOptionsStatus `type:"structure"`

    // Additional options for the domain endpoint, such as whether to require HTTPS
    // for all traffic.
    DomainEndpointOptions *DomainEndpointOptionsStatus `type:"structure"`

    // Container for EBS options configured for the domain.
    EBSOptions *EBSOptionsStatus `type:"structure"`

    // Key-value pairs to enable encryption at rest.
    EncryptionAtRestOptions *EncryptionAtRestOptionsStatus `type:"structure"`

    // The OpenSearch or Elasticsearch version that the domain is running.
    EngineVersion *VersionStatus `type:"structure"`

    // Choose 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 *IPAddressTypeStatus `type:"structure"`

    // Key-value pairs to configure log publishing.
    LogPublishingOptions *LogPublishingOptionsStatus `type:"structure"`

    // Information about the domain properties that are currently being modified.
    ModifyingProperties []*ModifyingProperties `type:"list"`

    // Whether node-to-node encryption is enabled or disabled.
    NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus `type:"structure"`

    // Container for off-peak window options for the domain.
    OffPeakWindowOptions *OffPeakWindowOptionsStatus `type:"structure"`

    // DEPRECATED. Container for parameters required to configure automated snapshots
    // of domain indexes.
    SnapshotOptions *SnapshotOptionsStatus `type:"structure"`

    // Software update options for the domain.
    SoftwareUpdateOptions *SoftwareUpdateOptionsStatus `type:"structure"`

    // The current VPC options for the domain and the status of any updates to their
    // configuration.
    VPCOptions *VPCDerivedInfoStatus `type:"structure"`
    // contains filtered or unexported fields
}

Container for the configuration of an OpenSearch Service domain.

func (DomainConfig) GoString

func (s DomainConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainConfig) SetAIMLOptions

func (s *DomainConfig) SetAIMLOptions(v *AIMLOptionsStatus) *DomainConfig

SetAIMLOptions sets the AIMLOptions field's value.

func (*DomainConfig) SetAccessPolicies

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

SetAccessPolicies sets the AccessPolicies field's value.

func (*DomainConfig) SetAdvancedOptions

func (s *DomainConfig) SetAdvancedOptions(v *AdvancedOptionsStatus) *DomainConfig

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*DomainConfig) SetAdvancedSecurityOptions

func (s *DomainConfig) SetAdvancedSecurityOptions(v *AdvancedSecurityOptionsStatus) *DomainConfig

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*DomainConfig) SetAutoTuneOptions

func (s *DomainConfig) SetAutoTuneOptions(v *AutoTuneOptionsStatus) *DomainConfig

SetAutoTuneOptions sets the AutoTuneOptions field's value.

func (*DomainConfig) SetChangeProgressDetails

func (s *DomainConfig) SetChangeProgressDetails(v *ChangeProgressDetails) *DomainConfig

SetChangeProgressDetails sets the ChangeProgressDetails field's value.

func (*DomainConfig) SetClusterConfig

func (s *DomainConfig) SetClusterConfig(v *ClusterConfigStatus) *DomainConfig

SetClusterConfig sets the ClusterConfig field's value.

func (*DomainConfig) SetCognitoOptions

func (s *DomainConfig) SetCognitoOptions(v *CognitoOptionsStatus) *DomainConfig

SetCognitoOptions sets the CognitoOptions field's value.

func (*DomainConfig) SetDomainEndpointOptions

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

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*DomainConfig) SetEBSOptions

func (s *DomainConfig) SetEBSOptions(v *EBSOptionsStatus) *DomainConfig

SetEBSOptions sets the EBSOptions field's value.

func (*DomainConfig) SetEncryptionAtRestOptions

func (s *DomainConfig) SetEncryptionAtRestOptions(v *EncryptionAtRestOptionsStatus) *DomainConfig

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*DomainConfig) SetEngineVersion

func (s *DomainConfig) SetEngineVersion(v *VersionStatus) *DomainConfig

SetEngineVersion sets the EngineVersion field's value.

func (*DomainConfig) SetIPAddressType

func (s *DomainConfig) SetIPAddressType(v *IPAddressTypeStatus) *DomainConfig

SetIPAddressType sets the IPAddressType field's value.

func (*DomainConfig) SetLogPublishingOptions

func (s *DomainConfig) SetLogPublishingOptions(v *LogPublishingOptionsStatus) *DomainConfig

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*DomainConfig) SetModifyingProperties

func (s *DomainConfig) SetModifyingProperties(v []*ModifyingProperties) *DomainConfig

SetModifyingProperties sets the ModifyingProperties field's value.

func (*DomainConfig) SetNodeToNodeEncryptionOptions

func (s *DomainConfig) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptionsStatus) *DomainConfig

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*DomainConfig) SetOffPeakWindowOptions

func (s *DomainConfig) SetOffPeakWindowOptions(v *OffPeakWindowOptionsStatus) *DomainConfig

SetOffPeakWindowOptions sets the OffPeakWindowOptions field's value.

func (*DomainConfig) SetSnapshotOptions

func (s *DomainConfig) SetSnapshotOptions(v *SnapshotOptionsStatus) *DomainConfig

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*DomainConfig) SetSoftwareUpdateOptions

func (s *DomainConfig) SetSoftwareUpdateOptions(v *SoftwareUpdateOptionsStatus) *DomainConfig

SetSoftwareUpdateOptions sets the SoftwareUpdateOptions field's value.

func (*DomainConfig) SetVPCOptions

func (s *DomainConfig) SetVPCOptions(v *VPCDerivedInfoStatus) *DomainConfig

SetVPCOptions sets the VPCOptions field's value.

func (DomainConfig) String

func (s DomainConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainEndpointOptions

type DomainEndpointOptions struct {

    // The fully qualified URL for the custom endpoint.
    CustomEndpoint *string `min:"1" type:"string"`

    // The ARN for your security certificate, managed in Amazon Web Services Certificate
    // Manager (ACM).
    CustomEndpointCertificateArn *string `min:"20" type:"string"`

    // Whether to enable a custom endpoint for the domain.
    CustomEndpointEnabled *bool `type:"boolean"`

    // True to require that all traffic to the domain arrive over HTTPS.
    EnforceHTTPS *bool `type:"boolean"`

    // Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
    // The policy can be one of the following values:
    //
    //    * Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version
    //    1.0 to TLS version 1.2
    //
    //    * Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS
    //    version 1.2
    //
    //    * Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS
    //    version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
    TLSSecurityPolicy *string `type:"string" enum:"TLSSecurityPolicy"`
    // contains filtered or unexported fields
}

Options to configure a custom endpoint for an OpenSearch Service domain.

func (DomainEndpointOptions) GoString

func (s DomainEndpointOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainEndpointOptions) SetCustomEndpoint

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

SetCustomEndpoint sets the CustomEndpoint field's value.

func (*DomainEndpointOptions) SetCustomEndpointCertificateArn

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

SetCustomEndpointCertificateArn sets the CustomEndpointCertificateArn field's value.

func (*DomainEndpointOptions) SetCustomEndpointEnabled

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

SetCustomEndpointEnabled sets the CustomEndpointEnabled field's value.

func (*DomainEndpointOptions) SetEnforceHTTPS

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

SetEnforceHTTPS sets the EnforceHTTPS field's value.

func (*DomainEndpointOptions) SetTLSSecurityPolicy

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

SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.

func (DomainEndpointOptions) String

func (s DomainEndpointOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainEndpointOptions) Validate

func (s *DomainEndpointOptions) Validate() error

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

type DomainEndpointOptionsStatus

type DomainEndpointOptionsStatus struct {

    // Options to configure the endpoint for a domain.
    //
    // Options is a required field
    Options *DomainEndpointOptions `type:"structure" required:"true"`

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

The configured endpoint options for a domain and their current status.

func (DomainEndpointOptionsStatus) GoString

func (s DomainEndpointOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainEndpointOptionsStatus) SetOptions

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

SetOptions sets the Options field's value.

func (*DomainEndpointOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (DomainEndpointOptionsStatus) String

func (s DomainEndpointOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainInfo

type DomainInfo struct {

    // Name of the domain.
    DomainName *string `min:"3" type:"string"`

    // The type of search engine that the domain is running.OpenSearch for an OpenSearch
    // engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
    EngineType *string `type:"string" enum:"EngineType"`
    // contains filtered or unexported fields
}

Information about an OpenSearch Service domain.

func (DomainInfo) GoString

func (s DomainInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainInfo) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DomainInfo) SetEngineType

func (s *DomainInfo) SetEngineType(v string) *DomainInfo

SetEngineType sets the EngineType field's value.

func (DomainInfo) String

func (s DomainInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainInformationContainer

type DomainInformationContainer struct {

    // Information about an Amazon OpenSearch Service domain.
    AWSDomainInformation *AWSDomainInformation `type:"structure"`
    // contains filtered or unexported fields
}

Container for information about an OpenSearch Service domain.

func (DomainInformationContainer) GoString

func (s DomainInformationContainer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainInformationContainer) SetAWSDomainInformation

func (s *DomainInformationContainer) SetAWSDomainInformation(v *AWSDomainInformation) *DomainInformationContainer

SetAWSDomainInformation sets the AWSDomainInformation field's value.

func (DomainInformationContainer) String

func (s DomainInformationContainer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainInformationContainer) Validate

func (s *DomainInformationContainer) Validate() error

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

type DomainMaintenanceDetails

type DomainMaintenanceDetails struct {

    // The name of the action.
    Action *string `type:"string" enum:"MaintenanceType"`

    // The time at which the action was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The name of the domain.
    DomainName *string `min:"3" type:"string"`

    // The ID of the requested action.
    MaintenanceId *string `min:"1" type:"string"`

    // The ID of the data node.
    NodeId *string `min:"10" type:"string"`

    // The status of the action.
    Status *string `type:"string" enum:"MaintenanceStatus"`

    // The status message for the action.
    StatusMessage *string `type:"string"`

    // The time at which the action was updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Container for the domain maintenance details.

func (DomainMaintenanceDetails) GoString

func (s DomainMaintenanceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainMaintenanceDetails) SetAction

func (s *DomainMaintenanceDetails) SetAction(v string) *DomainMaintenanceDetails

SetAction sets the Action field's value.

func (*DomainMaintenanceDetails) SetCreatedAt

func (s *DomainMaintenanceDetails) SetCreatedAt(v time.Time) *DomainMaintenanceDetails

SetCreatedAt sets the CreatedAt field's value.

func (*DomainMaintenanceDetails) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DomainMaintenanceDetails) SetMaintenanceId

func (s *DomainMaintenanceDetails) SetMaintenanceId(v string) *DomainMaintenanceDetails

SetMaintenanceId sets the MaintenanceId field's value.

func (*DomainMaintenanceDetails) SetNodeId

func (s *DomainMaintenanceDetails) SetNodeId(v string) *DomainMaintenanceDetails

SetNodeId sets the NodeId field's value.

func (*DomainMaintenanceDetails) SetStatus

func (s *DomainMaintenanceDetails) SetStatus(v string) *DomainMaintenanceDetails

SetStatus sets the Status field's value.

func (*DomainMaintenanceDetails) SetStatusMessage

func (s *DomainMaintenanceDetails) SetStatusMessage(v string) *DomainMaintenanceDetails

SetStatusMessage sets the StatusMessage field's value.

func (*DomainMaintenanceDetails) SetUpdatedAt

func (s *DomainMaintenanceDetails) SetUpdatedAt(v time.Time) *DomainMaintenanceDetails

SetUpdatedAt sets the UpdatedAt field's value.

func (DomainMaintenanceDetails) String

func (s DomainMaintenanceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainNodesStatus

type DomainNodesStatus struct {

    // The Availability Zone of the node.
    AvailabilityZone *string `min:"1" type:"string"`

    // The instance type information of the node.
    InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

    // The ID of the node.
    NodeId *string `min:"10" type:"string"`

    // Indicates if the node is active or in standby.
    NodeStatus *string `type:"string" enum:"NodeStatus"`

    // Indicates whether the nodes is a data, master, or ultrawarm node.
    NodeType *string `type:"string" enum:"NodeType"`

    // The storage size of the node, in GiB.
    StorageSize *string `type:"string"`

    // Indicates if the node has EBS or instance storage.
    StorageType *string `type:"string"`

    // If the nodes has EBS storage, indicates if the volume type is GP2 or GP3.
    // Only applicable for data nodes.
    StorageVolumeType *string `type:"string" enum:"VolumeType"`
    // contains filtered or unexported fields
}

Container for information about nodes on the domain.

func (DomainNodesStatus) GoString

func (s DomainNodesStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainNodesStatus) SetAvailabilityZone

func (s *DomainNodesStatus) SetAvailabilityZone(v string) *DomainNodesStatus

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DomainNodesStatus) SetInstanceType

func (s *DomainNodesStatus) SetInstanceType(v string) *DomainNodesStatus

SetInstanceType sets the InstanceType field's value.

func (*DomainNodesStatus) SetNodeId

func (s *DomainNodesStatus) SetNodeId(v string) *DomainNodesStatus

SetNodeId sets the NodeId field's value.

func (*DomainNodesStatus) SetNodeStatus

func (s *DomainNodesStatus) SetNodeStatus(v string) *DomainNodesStatus

SetNodeStatus sets the NodeStatus field's value.

func (*DomainNodesStatus) SetNodeType

func (s *DomainNodesStatus) SetNodeType(v string) *DomainNodesStatus

SetNodeType sets the NodeType field's value.

func (*DomainNodesStatus) SetStorageSize

func (s *DomainNodesStatus) SetStorageSize(v string) *DomainNodesStatus

SetStorageSize sets the StorageSize field's value.

func (*DomainNodesStatus) SetStorageType

func (s *DomainNodesStatus) SetStorageType(v string) *DomainNodesStatus

SetStorageType sets the StorageType field's value.

func (*DomainNodesStatus) SetStorageVolumeType

func (s *DomainNodesStatus) SetStorageVolumeType(v string) *DomainNodesStatus

SetStorageVolumeType sets the StorageVolumeType field's value.

func (DomainNodesStatus) String

func (s DomainNodesStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainPackageDetails

type DomainPackageDetails struct {

    // Name of the domain that the package is associated with.
    DomainName *string `min:"3" type:"string"`

    // State of the association.
    DomainPackageStatus *string `type:"string" enum:"DomainPackageStatus"`

    // Additional information if the package is in an error state. Null otherwise.
    ErrorDetails *ErrorDetails `type:"structure"`

    // Timestamp of the most recent update to the package association status.
    LastUpdated *time.Time `type:"timestamp"`

    // Internal ID of the package.
    PackageID *string `type:"string"`

    // User-specified name of the package.
    PackageName *string `min:"3" type:"string"`

    // The type of package.
    PackageType *string `type:"string" enum:"PackageType"`

    // The current version of the package.
    PackageVersion *string `type:"string"`

    // The relative path of the package on the OpenSearch Service cluster nodes.
    // This is synonym_path when the package is for synonym files.
    ReferencePath *string `type:"string"`
    // contains filtered or unexported fields
}

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).

func (DomainPackageDetails) GoString

func (s DomainPackageDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainPackageDetails) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DomainPackageDetails) SetDomainPackageStatus

func (s *DomainPackageDetails) SetDomainPackageStatus(v string) *DomainPackageDetails

SetDomainPackageStatus sets the DomainPackageStatus field's value.

func (*DomainPackageDetails) SetErrorDetails

func (s *DomainPackageDetails) SetErrorDetails(v *ErrorDetails) *DomainPackageDetails

SetErrorDetails sets the ErrorDetails field's value.

func (*DomainPackageDetails) SetLastUpdated

func (s *DomainPackageDetails) SetLastUpdated(v time.Time) *DomainPackageDetails

SetLastUpdated sets the LastUpdated field's value.

func (*DomainPackageDetails) SetPackageID

func (s *DomainPackageDetails) SetPackageID(v string) *DomainPackageDetails

SetPackageID sets the PackageID field's value.

func (*DomainPackageDetails) SetPackageName

func (s *DomainPackageDetails) SetPackageName(v string) *DomainPackageDetails

SetPackageName sets the PackageName field's value.

func (*DomainPackageDetails) SetPackageType

func (s *DomainPackageDetails) SetPackageType(v string) *DomainPackageDetails

SetPackageType sets the PackageType field's value.

func (*DomainPackageDetails) SetPackageVersion

func (s *DomainPackageDetails) SetPackageVersion(v string) *DomainPackageDetails

SetPackageVersion sets the PackageVersion field's value.

func (*DomainPackageDetails) SetReferencePath

func (s *DomainPackageDetails) SetReferencePath(v string) *DomainPackageDetails

SetReferencePath sets the ReferencePath field's value.

func (DomainPackageDetails) String

func (s DomainPackageDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainStatus

type DomainStatus struct {

    // Container for parameters required to enable all machine learning features.
    AIMLOptions *AIMLOptionsOutput_ `type:"structure"`

    // The Amazon Resource Name (ARN) of the domain. For more information, see IAM
    // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
    // in the AWS Identity and Access Management User Guide.
    //
    // ARN is a required field
    ARN *string `min:"20" type:"string" required:"true"`

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

    // Key-value pairs that specify advanced configuration options.
    AdvancedOptions map[string]*string `type:"map"`

    // Settings for fine-grained access control.
    AdvancedSecurityOptions *AdvancedSecurityOptions `type:"structure"`

    // Auto-Tune settings for the domain.
    AutoTuneOptions *AutoTuneOptionsOutput_ `type:"structure"`

    // Information about a configuration change happening on the domain.
    ChangeProgressDetails *ChangeProgressDetails `type:"structure"`

    // Container for the cluster configuration of the domain.
    //
    // ClusterConfig is a required field
    ClusterConfig *ClusterConfig `type:"structure" required:"true"`

    // Key-value pairs to configure Amazon Cognito authentication for OpenSearch
    // Dashboards.
    CognitoOptions *CognitoOptions `type:"structure"`

    // Creation status of an OpenSearch Service domain. True if domain creation
    // is complete. False if domain creation is still in progress.
    Created *bool `type:"boolean"`

    // Deletion status of an OpenSearch Service domain. True if domain deletion
    // is complete. False if domain deletion is still in progress. Once deletion
    // is complete, the status of the domain is no longer returned.
    Deleted *bool `type:"boolean"`

    // Additional options for the domain endpoint, such as whether to require HTTPS
    // for all traffic.
    DomainEndpointOptions *DomainEndpointOptions `type:"structure"`

    // The dual stack hosted zone ID for the domain.
    DomainEndpointV2HostedZoneId *string `type:"string"`

    // Unique identifier for the domain.
    //
    // DomainId is a required field
    DomainId *string `min:"1" type:"string" required:"true"`

    // Name of the domain. Domain names are unique across all domains owned by the
    // same account within an Amazon Web Services Region.
    //
    // DomainName is a required field
    DomainName *string `min:"3" type:"string" required:"true"`

    // The status of any changes that are currently in progress for the domain.
    DomainProcessingStatus *string `type:"string" enum:"DomainProcessingStatusType"`

    // Container for EBS-based storage settings for the domain.
    EBSOptions *EBSOptions `type:"structure"`

    // Encryption at rest settings for the domain.
    EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"`

    // Domain-specific endpoint used to submit index, search, and data upload requests
    // to the domain.
    Endpoint *string `type:"string"`

    // If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned.
    // This endpoint functions like a normal endpoint, except that it works with
    // both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP
    // addresses.
    EndpointV2 *string `type:"string"`

    // The key-value pair that exists if the OpenSearch Service domain uses VPC
    // endpoints. For example:
    //
    //    * IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
    //
    //    * Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
    Endpoints map[string]*string `type:"map"`

    // Version of OpenSearch or Elasticsearch that the domain is running, in the
    // format Elasticsearch_X.Y or OpenSearch_X.Y.
    EngineVersion *string `min:"14" type:"string"`

    // The type of IP addresses supported by the endpoint for the domain.
    IPAddressType *string `type:"string" enum:"IPAddressType"`

    // Log publishing options for the domain.
    LogPublishingOptions map[string]*LogPublishingOption `type:"map"`

    // Information about the domain properties that are currently being modified.
    ModifyingProperties []*ModifyingProperties `type:"list"`

    // Whether node-to-node encryption is enabled or disabled.
    NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions `type:"structure"`

    // Options that specify a custom 10-hour window during which OpenSearch Service
    // can perform configuration changes on the domain.
    OffPeakWindowOptions *OffPeakWindowOptions `type:"structure"`

    // The status of the domain configuration. True if OpenSearch Service is processing
    // configuration changes. False if the configuration is active.
    Processing *bool `type:"boolean"`

    // The current status of the domain's service software.
    ServiceSoftwareOptions *ServiceSoftwareOptions `type:"structure"`

    // DEPRECATED. Container for parameters required to configure automated snapshots
    // of domain indexes.
    SnapshotOptions *SnapshotOptions `type:"structure"`

    // Service software update options for the domain.
    SoftwareUpdateOptions *SoftwareUpdateOptions `type:"structure"`

    // The status of a domain version upgrade to a new version of OpenSearch or
    // Elasticsearch. True if OpenSearch Service is in the process of a version
    // upgrade. False if the configuration is active.
    UpgradeProcessing *bool `type:"boolean"`

    // The VPC configuration for the domain.
    VPCOptions *VPCDerivedInfo `type:"structure"`
    // contains filtered or unexported fields
}

The current status of an OpenSearch Service domain.

func (DomainStatus) GoString

func (s DomainStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainStatus) SetAIMLOptions

func (s *DomainStatus) SetAIMLOptions(v *AIMLOptionsOutput_) *DomainStatus

SetAIMLOptions sets the AIMLOptions field's value.

func (*DomainStatus) SetARN

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

SetARN sets the ARN field's value.

func (*DomainStatus) SetAccessPolicies

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

SetAccessPolicies sets the AccessPolicies field's value.

func (*DomainStatus) SetAdvancedOptions

func (s *DomainStatus) SetAdvancedOptions(v map[string]*string) *DomainStatus

SetAdvancedOptions sets the AdvancedOptions field's value.

func (*DomainStatus) SetAdvancedSecurityOptions

func (s *DomainStatus) SetAdvancedSecurityOptions(v *AdvancedSecurityOptions) *DomainStatus

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*DomainStatus) SetAutoTuneOptions

func (s *DomainStatus) SetAutoTuneOptions(v *AutoTuneOptionsOutput_) *DomainStatus

SetAutoTuneOptions sets the AutoTuneOptions field's value.

func (*DomainStatus) SetChangeProgressDetails

func (s *DomainStatus) SetChangeProgressDetails(v *ChangeProgressDetails) *DomainStatus

SetChangeProgressDetails sets the ChangeProgressDetails field's value.

func (*DomainStatus) SetClusterConfig

func (s *DomainStatus) SetClusterConfig(v *ClusterConfig) *DomainStatus

SetClusterConfig sets the ClusterConfig field's value.

func (*DomainStatus) SetCognitoOptions

func (s *DomainStatus) SetCognitoOptions(v *CognitoOptions) *DomainStatus

SetCognitoOptions sets the CognitoOptions field's value.

func (*DomainStatus) SetCreated

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

SetCreated sets the Created field's value.

func (*DomainStatus) SetDeleted

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

SetDeleted sets the Deleted field's value.

func (*DomainStatus) SetDomainEndpointOptions

func (s *DomainStatus) SetDomainEndpointOptions(v *DomainEndpointOptions) *DomainStatus

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*DomainStatus) SetDomainEndpointV2HostedZoneId

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

SetDomainEndpointV2HostedZoneId sets the DomainEndpointV2HostedZoneId field's value.

func (*DomainStatus) SetDomainId

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

SetDomainId sets the DomainId field's value.

func (*DomainStatus) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*DomainStatus) SetDomainProcessingStatus

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

SetDomainProcessingStatus sets the DomainProcessingStatus field's value.

func (*DomainStatus) SetEBSOptions

func (s *DomainStatus) SetEBSOptions(v *EBSOptions) *DomainStatus

SetEBSOptions sets the EBSOptions field's value.

func (*DomainStatus) SetEncryptionAtRestOptions

func (s *DomainStatus) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *DomainStatus

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*DomainStatus) SetEndpoint

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

SetEndpoint sets the Endpoint field's value.

func (*DomainStatus) SetEndpointV2

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

SetEndpointV2 sets the EndpointV2 field's value.

func (*DomainStatus) SetEndpoints

func (s *DomainStatus) SetEndpoints(v map[string]*string) *DomainStatus

SetEndpoints sets the Endpoints field's value.

func (*DomainStatus) SetEngineVersion

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

SetEngineVersion sets the EngineVersion field's value.

func (*DomainStatus) SetIPAddressType

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

SetIPAddressType sets the IPAddressType field's value.

func (*DomainStatus) SetLogPublishingOptions

func (s *DomainStatus) SetLogPublishingOptions(v map[string]*LogPublishingOption) *DomainStatus

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*DomainStatus) SetModifyingProperties

func (s *DomainStatus) SetModifyingProperties(v []*ModifyingProperties) *DomainStatus

SetModifyingProperties sets the ModifyingProperties field's value.

func (*DomainStatus) SetNodeToNodeEncryptionOptions

func (s *DomainStatus) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptions) *DomainStatus

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*DomainStatus) SetOffPeakWindowOptions

func (s *DomainStatus) SetOffPeakWindowOptions(v *OffPeakWindowOptions) *DomainStatus

SetOffPeakWindowOptions sets the OffPeakWindowOptions field's value.

func (*DomainStatus) SetProcessing

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

SetProcessing sets the Processing field's value.

func (*DomainStatus) SetServiceSoftwareOptions

func (s *DomainStatus) SetServiceSoftwareOptions(v *ServiceSoftwareOptions) *DomainStatus

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (*DomainStatus) SetSnapshotOptions

func (s *DomainStatus) SetSnapshotOptions(v *SnapshotOptions) *DomainStatus

SetSnapshotOptions sets the SnapshotOptions field's value.

func (*DomainStatus) SetSoftwareUpdateOptions

func (s *DomainStatus) SetSoftwareUpdateOptions(v *SoftwareUpdateOptions) *DomainStatus

SetSoftwareUpdateOptions sets the SoftwareUpdateOptions field's value.

func (*DomainStatus) SetUpgradeProcessing

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

SetUpgradeProcessing sets the UpgradeProcessing field's value.

func (*DomainStatus) SetVPCOptions

func (s *DomainStatus) SetVPCOptions(v *VPCDerivedInfo) *DomainStatus

SetVPCOptions sets the VPCOptions field's value.

func (DomainStatus) String

func (s DomainStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DryRunProgressStatus

type DryRunProgressStatus struct {

    // The timestamp when the dry run was initiated.
    //
    // CreationDate is a required field
    CreationDate *string `type:"string" required:"true"`

    // The unique identifier of the dry run.
    //
    // DryRunId is a required field
    DryRunId *string `min:"36" type:"string" required:"true"`

    // The current status of the dry run.
    //
    // DryRunStatus is a required field
    DryRunStatus *string `type:"string" required:"true"`

    // The timestamp when the dry run was last updated.
    //
    // UpdateDate is a required field
    UpdateDate *string `type:"string" required:"true"`

    // Any validation failures that occurred as a result of the dry run.
    ValidationFailures []*ValidationFailure `type:"list"`
    // contains filtered or unexported fields
}

Information about the progress of a pre-upgrade dry run analysis.

func (DryRunProgressStatus) GoString

func (s DryRunProgressStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DryRunProgressStatus) SetCreationDate

func (s *DryRunProgressStatus) SetCreationDate(v string) *DryRunProgressStatus

SetCreationDate sets the CreationDate field's value.

func (*DryRunProgressStatus) SetDryRunId

func (s *DryRunProgressStatus) SetDryRunId(v string) *DryRunProgressStatus

SetDryRunId sets the DryRunId field's value.

func (*DryRunProgressStatus) SetDryRunStatus

func (s *DryRunProgressStatus) SetDryRunStatus(v string) *DryRunProgressStatus

SetDryRunStatus sets the DryRunStatus field's value.

func (*DryRunProgressStatus) SetUpdateDate

func (s *DryRunProgressStatus) SetUpdateDate(v string) *DryRunProgressStatus

SetUpdateDate sets the UpdateDate field's value.

func (*DryRunProgressStatus) SetValidationFailures

func (s *DryRunProgressStatus) SetValidationFailures(v []*ValidationFailure) *DryRunProgressStatus

SetValidationFailures sets the ValidationFailures field's value.

func (DryRunProgressStatus) String

func (s DryRunProgressStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DryRunResults

type DryRunResults struct {

    // Specifies the way in which OpenSearch Service will apply an update. Possible
    // values are:
    //
    //    * Blue/Green - The update requires a blue/green deployment.
    //
    //    * DynamicUpdate - No blue/green deployment required
    //
    //    * Undetermined - The domain is in the middle of an update and can't predict
    //    the deployment type. Try again after the update is complete.
    //
    //    * None - The request doesn't include any configuration changes.
    DeploymentType *string `min:"2" type:"string"`

    // A message corresponding to the deployment type.
    Message *string `type:"string"`
    // contains filtered or unexported fields
}

Results of a dry run performed in an update domain request.

func (DryRunResults) GoString

func (s DryRunResults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DryRunResults) SetDeploymentType

func (s *DryRunResults) SetDeploymentType(v string) *DryRunResults

SetDeploymentType sets the DeploymentType field's value.

func (*DryRunResults) SetMessage

func (s *DryRunResults) SetMessage(v string) *DryRunResults

SetMessage sets the Message field's value.

func (DryRunResults) String

func (s DryRunResults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Duration

type Duration struct {

    // The unit of measurement for the duration of a maintenance schedule.
    Unit *string `type:"string" enum:"TimeUnit"`

    // Integer to specify the value of a maintenance schedule duration.
    Value *int64 `min:"1" type:"long"`
    // contains filtered or unexported fields
}

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

func (Duration) GoString

func (s Duration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Duration) SetUnit

func (s *Duration) SetUnit(v string) *Duration

SetUnit sets the Unit field's value.

func (*Duration) SetValue

func (s *Duration) SetValue(v int64) *Duration

SetValue sets the Value field's value.

func (Duration) String

func (s Duration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Duration) Validate

func (s *Duration) Validate() error

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

type EBSOptions

type EBSOptions struct {

    // Indicates whether EBS volumes are attached to data nodes in an OpenSearch
    // Service domain.
    EBSEnabled *bool `type:"boolean"`

    // Specifies the baseline input/output (I/O) performance of EBS volumes attached
    // to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume
    // types.
    Iops *int64 `type:"integer"`

    // Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
    // Applicable only for the gp3 volume type.
    Throughput *int64 `type:"integer"`

    // Specifies the size (in GiB) of EBS volumes attached to data nodes.
    VolumeSize *int64 `type:"integer"`

    // Specifies the type of EBS volumes attached to data nodes.
    VolumeType *string `type:"string" enum:"VolumeType"`
    // contains filtered or unexported fields
}

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

func (EBSOptions) GoString

func (s EBSOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EBSOptions) SetEBSEnabled

func (s *EBSOptions) SetEBSEnabled(v bool) *EBSOptions

SetEBSEnabled sets the EBSEnabled field's value.

func (*EBSOptions) SetIops

func (s *EBSOptions) SetIops(v int64) *EBSOptions

SetIops sets the Iops field's value.

func (*EBSOptions) SetThroughput

func (s *EBSOptions) SetThroughput(v int64) *EBSOptions

SetThroughput sets the Throughput field's value.

func (*EBSOptions) SetVolumeSize

func (s *EBSOptions) SetVolumeSize(v int64) *EBSOptions

SetVolumeSize sets the VolumeSize field's value.

func (*EBSOptions) SetVolumeType

func (s *EBSOptions) SetVolumeType(v string) *EBSOptions

SetVolumeType sets the VolumeType field's value.

func (EBSOptions) String

func (s EBSOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EBSOptionsStatus

type EBSOptionsStatus struct {

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

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

The status of the EBS options for the specified OpenSearch Service domain.

func (EBSOptionsStatus) GoString

func (s EBSOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EBSOptionsStatus) SetOptions

func (s *EBSOptionsStatus) SetOptions(v *EBSOptions) *EBSOptionsStatus

SetOptions sets the Options field's value.

func (*EBSOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (EBSOptionsStatus) String

func (s EBSOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncryptionAtRestOptions

type EncryptionAtRestOptions struct {

    // True to enable encryption at rest.
    Enabled *bool `type:"boolean"`

    // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
    KmsKeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.

func (EncryptionAtRestOptions) GoString

func (s EncryptionAtRestOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionAtRestOptions) SetEnabled

func (s *EncryptionAtRestOptions) SetEnabled(v bool) *EncryptionAtRestOptions

SetEnabled sets the Enabled field's value.

func (*EncryptionAtRestOptions) SetKmsKeyId

func (s *EncryptionAtRestOptions) SetKmsKeyId(v string) *EncryptionAtRestOptions

SetKmsKeyId sets the KmsKeyId field's value.

func (EncryptionAtRestOptions) String

func (s EncryptionAtRestOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionAtRestOptions) Validate

func (s *EncryptionAtRestOptions) Validate() error

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

type EncryptionAtRestOptionsStatus

type EncryptionAtRestOptionsStatus struct {

    // Encryption at rest options for the specified domain.
    //
    // Options is a required field
    Options *EncryptionAtRestOptions `type:"structure" required:"true"`

    // The status of the encryption at rest options for the specified domain.
    //
    // Status is a required field
    Status *OptionStatus `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Status of the encryption at rest options for the specified OpenSearch Service domain.

func (EncryptionAtRestOptionsStatus) GoString

func (s EncryptionAtRestOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionAtRestOptionsStatus) SetOptions

func (s *EncryptionAtRestOptionsStatus) SetOptions(v *EncryptionAtRestOptions) *EncryptionAtRestOptionsStatus

SetOptions sets the Options field's value.

func (*EncryptionAtRestOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (EncryptionAtRestOptionsStatus) String

func (s EncryptionAtRestOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnvironmentInfo

type EnvironmentInfo struct {

    // A list of AvailabilityZoneInfo for the domain.
    AvailabilityZoneInformation []*AvailabilityZoneInfo `type:"list"`
    // contains filtered or unexported fields
}

Information about the active domain environment.

func (EnvironmentInfo) GoString

func (s EnvironmentInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnvironmentInfo) SetAvailabilityZoneInformation

func (s *EnvironmentInfo) SetAvailabilityZoneInformation(v []*AvailabilityZoneInfo) *EnvironmentInfo

SetAvailabilityZoneInformation sets the AvailabilityZoneInformation field's value.

func (EnvironmentInfo) String

func (s EnvironmentInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ErrorDetails

type ErrorDetails struct {

    // A message describing the error.
    ErrorMessage *string `type:"string"`

    // The type of error that occurred.
    ErrorType *string `type:"string"`
    // contains filtered or unexported fields
}

Additional information if the package is in an error state. Null otherwise.

func (ErrorDetails) GoString

func (s ErrorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorDetails) SetErrorMessage

func (s *ErrorDetails) SetErrorMessage(v string) *ErrorDetails

SetErrorMessage sets the ErrorMessage field's value.

func (*ErrorDetails) SetErrorType

func (s *ErrorDetails) SetErrorType(v string) *ErrorDetails

SetErrorType sets the ErrorType field's value.

func (ErrorDetails) String

func (s ErrorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filter

type Filter struct {

    // The name of the filter.
    Name *string `min:"1" type:"string"`

    // One or more values for the filter.
    Values []*string `min:"1" type:"list"`
    // contains filtered or unexported fields
}

A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

func (Filter) GoString

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetValues

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate

func (s *Filter) Validate() error

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

type GetCompatibleVersionsInput

type GetCompatibleVersionsInput struct {

    // The name of an existing domain. Provide this parameter to limit the results
    // to a single domain.
    DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"`
    // contains filtered or unexported fields
}

Container for the request parameters to GetCompatibleVersions operation.

func (GetCompatibleVersionsInput) GoString

func (s GetCompatibleVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompatibleVersionsInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (GetCompatibleVersionsInput) String

func (s GetCompatibleVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompatibleVersionsInput) Validate

func (s *GetCompatibleVersionsInput) Validate() error

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

type GetCompatibleVersionsOutput

type GetCompatibleVersionsOutput struct {

    // A map of OpenSearch or Elasticsearch versions and the versions you can upgrade
    // them to.
    CompatibleVersions []*CompatibleVersionsMap `type:"list"`
    // contains filtered or unexported fields
}

Container for the response returned by the GetCompatibleVersions operation.

func (GetCompatibleVersionsOutput) GoString

func (s GetCompatibleVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCompatibleVersionsOutput) SetCompatibleVersions

func (s *GetCompatibleVersionsOutput) SetCompatibleVersions(v []*CompatibleVersionsMap) *GetCompatibleVersionsOutput

SetCompatibleVersions sets the CompatibleVersions field's value.

func (GetCompatibleVersionsOutput) String

func (s GetCompatibleVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDataSourceInput

type GetDataSourceInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // The name of the data source to get information about.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"DataSourceName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the GetDataSource operation.

func (GetDataSourceInput) GoString

func (s GetDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataSourceInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*GetDataSourceInput) SetName

func (s *GetDataSourceInput) SetName(v string) *GetDataSourceInput

SetName sets the Name field's value.

func (GetDataSourceInput) String

func (s GetDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataSourceInput) Validate

func (s *GetDataSourceInput) Validate() error

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

type GetDataSourceOutput

type GetDataSourceOutput struct {

    // The type of data source.
    DataSourceType *DataSourceType `type:"structure"`

    // A description of the data source.
    Description *string `type:"string"`

    // The name of the data source.
    Name *string `min:"3" type:"string"`

    // The status of the data source.
    Status *string `type:"string" enum:"DataSourceStatus"`
    // contains filtered or unexported fields
}

The result of a GetDataSource operation.

func (GetDataSourceOutput) GoString

func (s GetDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataSourceOutput) SetDataSourceType

func (s *GetDataSourceOutput) SetDataSourceType(v *DataSourceType) *GetDataSourceOutput

SetDataSourceType sets the DataSourceType field's value.

func (*GetDataSourceOutput) SetDescription

func (s *GetDataSourceOutput) SetDescription(v string) *GetDataSourceOutput

SetDescription sets the Description field's value.

func (*GetDataSourceOutput) SetName

func (s *GetDataSourceOutput) SetName(v string) *GetDataSourceOutput

SetName sets the Name field's value.

func (*GetDataSourceOutput) SetStatus

func (s *GetDataSourceOutput) SetStatus(v string) *GetDataSourceOutput

SetStatus sets the Status field's value.

func (GetDataSourceOutput) String

func (s GetDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDomainMaintenanceStatusInput

type GetDomainMaintenanceStatusInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // The request ID of the maintenance action.
    //
    // MaintenanceId is a required field
    MaintenanceId *string `location:"querystring" locationName:"maintenanceId" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the GetDomainMaintenanceStatus operation.

func (GetDomainMaintenanceStatusInput) GoString

func (s GetDomainMaintenanceStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainMaintenanceStatusInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*GetDomainMaintenanceStatusInput) SetMaintenanceId

func (s *GetDomainMaintenanceStatusInput) SetMaintenanceId(v string) *GetDomainMaintenanceStatusInput

SetMaintenanceId sets the MaintenanceId field's value.

func (GetDomainMaintenanceStatusInput) String

func (s GetDomainMaintenanceStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainMaintenanceStatusInput) Validate

func (s *GetDomainMaintenanceStatusInput) Validate() error

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

type GetDomainMaintenanceStatusOutput

type GetDomainMaintenanceStatusOutput struct {

    // The action name.
    Action *string `type:"string" enum:"MaintenanceType"`

    // The time at which the action was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The node ID of the maintenance action.
    NodeId *string `min:"10" type:"string"`

    // The status of the maintenance action.
    Status *string `type:"string" enum:"MaintenanceStatus"`

    // The status message of the maintenance action.
    StatusMessage *string `type:"string"`

    // The time at which the action was updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

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

func (GetDomainMaintenanceStatusOutput) GoString

func (s GetDomainMaintenanceStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainMaintenanceStatusOutput) SetAction

func (s *GetDomainMaintenanceStatusOutput) SetAction(v string) *GetDomainMaintenanceStatusOutput

SetAction sets the Action field's value.

func (*GetDomainMaintenanceStatusOutput) SetCreatedAt

func (s *GetDomainMaintenanceStatusOutput) SetCreatedAt(v time.Time) *GetDomainMaintenanceStatusOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetDomainMaintenanceStatusOutput) SetNodeId

func (s *GetDomainMaintenanceStatusOutput) SetNodeId(v string) *GetDomainMaintenanceStatusOutput

SetNodeId sets the NodeId field's value.

func (*GetDomainMaintenanceStatusOutput) SetStatus

func (s *GetDomainMaintenanceStatusOutput) SetStatus(v string) *GetDomainMaintenanceStatusOutput

SetStatus sets the Status field's value.

func (*GetDomainMaintenanceStatusOutput) SetStatusMessage

func (s *GetDomainMaintenanceStatusOutput) SetStatusMessage(v string) *GetDomainMaintenanceStatusOutput

SetStatusMessage sets the StatusMessage field's value.

func (*GetDomainMaintenanceStatusOutput) SetUpdatedAt

func (s *GetDomainMaintenanceStatusOutput) SetUpdatedAt(v time.Time) *GetDomainMaintenanceStatusOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetDomainMaintenanceStatusOutput) String

func (s GetDomainMaintenanceStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPackageVersionHistoryInput

type GetPackageVersionHistoryInput 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 *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`

    // The unique identifier of the package.
    //
    // PackageID is a required field
    PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the request parameters to the GetPackageVersionHistory operation.

func (GetPackageVersionHistoryInput) GoString

func (s GetPackageVersionHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPackageVersionHistoryInput) SetMaxResults

func (s *GetPackageVersionHistoryInput) SetMaxResults(v int64) *GetPackageVersionHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetPackageVersionHistoryInput) SetNextToken

func (s *GetPackageVersionHistoryInput) SetNextToken(v string) *GetPackageVersionHistoryInput

SetNextToken sets the NextToken field's value.

func (*GetPackageVersionHistoryInput) SetPackageID

func (s *GetPackageVersionHistoryInput) SetPackageID(v string) *GetPackageVersionHistoryInput

SetPackageID sets the PackageID field's value.

func (GetPackageVersionHistoryInput) String

func (s GetPackageVersionHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPackageVersionHistoryInput) Validate

func (s *GetPackageVersionHistoryInput) Validate() error

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

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

    // The unique identifier of the package.
    PackageID *string `type:"string"`

    // A list of package versions, along with their creation time and commit message.
    PackageVersionHistoryList []*PackageVersionHistory `type:"list"`
    // contains filtered or unexported fields
}

Container for response returned by GetPackageVersionHistory operation.

func (GetPackageVersionHistoryOutput) GoString

func (s GetPackageVersionHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPackageVersionHistoryOutput) SetNextToken

func (s *GetPackageVersionHistoryOutput) SetNextToken(v string) *GetPackageVersionHistoryOutput

SetNextToken sets the NextToken field's value.

func (*GetPackageVersionHistoryOutput) SetPackageID

func (s *GetPackageVersionHistoryOutput) SetPackageID(v string) *GetPackageVersionHistoryOutput

SetPackageID sets the PackageID field's value.

func (*GetPackageVersionHistoryOutput) SetPackageVersionHistoryList

func (s *GetPackageVersionHistoryOutput) SetPackageVersionHistoryList(v []*PackageVersionHistory) *GetPackageVersionHistoryOutput

SetPackageVersionHistoryList sets the PackageVersionHistoryList field's value.

func (GetPackageVersionHistoryOutput) String

func (s GetPackageVersionHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetUpgradeHistoryInput

type GetUpgradeHistoryInput struct {

    // The name of an existing domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

Container for the request parameters to the GetUpgradeHistory operation.

func (GetUpgradeHistoryInput) GoString

func (s GetUpgradeHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeHistoryInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*GetUpgradeHistoryInput) SetMaxResults

func (s *GetUpgradeHistoryInput) SetMaxResults(v int64) *GetUpgradeHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetUpgradeHistoryInput) SetNextToken

func (s *GetUpgradeHistoryInput) SetNextToken(v string) *GetUpgradeHistoryInput

SetNextToken sets the NextToken field's value.

func (GetUpgradeHistoryInput) String

func (s GetUpgradeHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeHistoryInput) Validate

func (s *GetUpgradeHistoryInput) Validate() error

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

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

    // A list of objects corresponding to each upgrade or upgrade eligibility check
    // performed on a domain.
    UpgradeHistories []*UpgradeHistory `type:"list"`
    // contains filtered or unexported fields
}

Container for the response returned by the GetUpgradeHistory operation.

func (GetUpgradeHistoryOutput) GoString

func (s GetUpgradeHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeHistoryOutput) SetNextToken

func (s *GetUpgradeHistoryOutput) SetNextToken(v string) *GetUpgradeHistoryOutput

SetNextToken sets the NextToken field's value.

func (*GetUpgradeHistoryOutput) SetUpgradeHistories

func (s *GetUpgradeHistoryOutput) SetUpgradeHistories(v []*UpgradeHistory) *GetUpgradeHistoryOutput

SetUpgradeHistories sets the UpgradeHistories field's value.

func (GetUpgradeHistoryOutput) String

func (s GetUpgradeHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetUpgradeStatusInput

type GetUpgradeStatusInput struct {

    // The domain of the domain to get upgrade status information for.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the request parameters to the GetUpgradeStatus operation.

func (GetUpgradeStatusInput) GoString

func (s GetUpgradeStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeStatusInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (GetUpgradeStatusInput) String

func (s GetUpgradeStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeStatusInput) Validate

func (s *GetUpgradeStatusInput) Validate() error

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

type GetUpgradeStatusOutput

type GetUpgradeStatusOutput struct {

    // The status of the current step that an upgrade is on.
    StepStatus *string `type:"string" enum:"UpgradeStatus"`

    // A string that describes the update.
    UpgradeName *string `type:"string"`

    // One of three steps that an upgrade or upgrade eligibility check goes through.
    UpgradeStep *string `type:"string" enum:"UpgradeStep"`
    // contains filtered or unexported fields
}

Container for the response returned by the GetUpgradeStatus operation.

func (GetUpgradeStatusOutput) GoString

func (s GetUpgradeStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUpgradeStatusOutput) SetStepStatus

func (s *GetUpgradeStatusOutput) SetStepStatus(v string) *GetUpgradeStatusOutput

SetStepStatus sets the StepStatus field's value.

func (*GetUpgradeStatusOutput) SetUpgradeName

func (s *GetUpgradeStatusOutput) SetUpgradeName(v string) *GetUpgradeStatusOutput

SetUpgradeName sets the UpgradeName field's value.

func (*GetUpgradeStatusOutput) SetUpgradeStep

func (s *GetUpgradeStatusOutput) SetUpgradeStep(v string) *GetUpgradeStatusOutput

SetUpgradeStep sets the UpgradeStep field's value.

func (GetUpgradeStatusOutput) String

func (s GetUpgradeStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IPAddressTypeStatus

type IPAddressTypeStatus struct {

    // The IP address options for the domain.
    //
    // Options is a required field
    Options *string `type:"string" required:"true" enum:"IPAddressType"`

    // Provides the current status of an entity.
    //
    // Status is a required field
    Status *OptionStatus `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

The IP address type status for the domain.

func (IPAddressTypeStatus) GoString

func (s IPAddressTypeStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IPAddressTypeStatus) SetOptions

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

SetOptions sets the Options field's value.

func (*IPAddressTypeStatus) SetStatus

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

SetStatus sets the Status field's value.

func (IPAddressTypeStatus) String

func (s IPAddressTypeStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InboundConnection

type InboundConnection struct {

    // The unique identifier of the connection.
    ConnectionId *string `min:"10" type:"string"`

    // The connection mode.
    ConnectionMode *string `type:"string" enum:"ConnectionMode"`

    // The current status of the connection.
    ConnectionStatus *InboundConnectionStatus `type:"structure"`

    // Information about the source (local) domain.
    LocalDomainInfo *DomainInformationContainer `type:"structure"`

    // Information about the destination (remote) domain.
    RemoteDomainInfo *DomainInformationContainer `type:"structure"`
    // contains filtered or unexported fields
}

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).

func (InboundConnection) GoString

func (s InboundConnection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InboundConnection) SetConnectionId

func (s *InboundConnection) SetConnectionId(v string) *InboundConnection

SetConnectionId sets the ConnectionId field's value.

func (*InboundConnection) SetConnectionMode

func (s *InboundConnection) SetConnectionMode(v string) *InboundConnection

SetConnectionMode sets the ConnectionMode field's value.

func (*InboundConnection) SetConnectionStatus

func (s *InboundConnection) SetConnectionStatus(v *InboundConnectionStatus) *InboundConnection

SetConnectionStatus sets the ConnectionStatus field's value.

func (*InboundConnection) SetLocalDomainInfo

func (s *InboundConnection) SetLocalDomainInfo(v *DomainInformationContainer) *InboundConnection

SetLocalDomainInfo sets the LocalDomainInfo field's value.

func (*InboundConnection) SetRemoteDomainInfo

func (s *InboundConnection) SetRemoteDomainInfo(v *DomainInformationContainer) *InboundConnection

SetRemoteDomainInfo sets the RemoteDomainInfo field's value.

func (InboundConnection) String

func (s InboundConnection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InboundConnectionStatus

type InboundConnectionStatus struct {

    // Information about the connection.
    Message *string `type:"string"`

    // The status code for the connection. Can be one of the following:
    //
    //    * PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote
    //    domain owner.
    //
    //    * APPROVED: Inbound connection is pending acceptance by the remote domain
    //    owner.
    //
    //    * PROVISIONING: Inbound connection is being provisioned.
    //
    //    * ACTIVE: Inbound connection is active and ready to use.
    //
    //    * REJECTING: Inbound connection rejection is in process.
    //
    //    * REJECTED: Inbound connection is rejected.
    //
    //    * DELETING: Inbound connection deletion is in progress.
    //
    //    * DELETED: Inbound connection is deleted and can no longer be used.
    StatusCode *string `type:"string" enum:"InboundConnectionStatusCode"`
    // contains filtered or unexported fields
}

The status of an inbound cross-cluster connection for OpenSearch Service.

func (InboundConnectionStatus) GoString

func (s InboundConnectionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InboundConnectionStatus) SetMessage

func (s *InboundConnectionStatus) SetMessage(v string) *InboundConnectionStatus

SetMessage sets the Message field's value.

func (*InboundConnectionStatus) SetStatusCode

func (s *InboundConnectionStatus) SetStatusCode(v string) *InboundConnectionStatus

SetStatusCode sets the StatusCode field's value.

func (InboundConnectionStatus) String

func (s InboundConnectionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceCountLimits

type InstanceCountLimits struct {

    // The minimum allowed number of instances.
    MaximumInstanceCount *int64 `type:"integer"`

    // The maximum allowed number of instances.
    MinimumInstanceCount *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

func (InstanceCountLimits) GoString

func (s InstanceCountLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceCountLimits) SetMaximumInstanceCount

func (s *InstanceCountLimits) SetMaximumInstanceCount(v int64) *InstanceCountLimits

SetMaximumInstanceCount sets the MaximumInstanceCount field's value.

func (*InstanceCountLimits) SetMinimumInstanceCount

func (s *InstanceCountLimits) SetMinimumInstanceCount(v int64) *InstanceCountLimits

SetMinimumInstanceCount sets the MinimumInstanceCount field's value.

func (InstanceCountLimits) String

func (s InstanceCountLimits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceLimits

type InstanceLimits struct {

    // Limits on the number of instances that can be created for a given instance
    // type.
    InstanceCountLimits *InstanceCountLimits `type:"structure"`
    // contains filtered or unexported fields
}

Instance-related attributes that are available for a given instance type.

func (InstanceLimits) GoString

func (s InstanceLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceLimits) SetInstanceCountLimits

func (s *InstanceLimits) SetInstanceCountLimits(v *InstanceCountLimits) *InstanceLimits

SetInstanceCountLimits sets the InstanceCountLimits field's value.

func (InstanceLimits) String

func (s InstanceLimits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceTypeDetails

type InstanceTypeDetails struct {

    // Whether fine-grained access control is supported for the instance type.
    AdvancedSecurityEnabled *bool `type:"boolean"`

    // Whether logging is supported for the instance type.
    AppLogsEnabled *bool `type:"boolean"`

    // The supported Availability Zones for the instance type.
    AvailabilityZones []*string `type:"list"`

    // Whether Amazon Cognito access is supported for the instance type.
    CognitoEnabled *bool `type:"boolean"`

    // Whether encryption at rest and node-to-node encryption are supported for
    // the instance type.
    EncryptionEnabled *bool `type:"boolean"`

    // Whether the instance acts as a data node, a dedicated master node, or an
    // UltraWarm node.
    InstanceRole []*string `type:"list"`

    // The instance type.
    InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"`

    // Whether UltraWarm is supported for the instance type.
    WarmEnabled *bool `type:"boolean"`
    // contains filtered or unexported fields
}

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

func (InstanceTypeDetails) GoString

func (s InstanceTypeDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceTypeDetails) SetAdvancedSecurityEnabled

func (s *InstanceTypeDetails) SetAdvancedSecurityEnabled(v bool) *InstanceTypeDetails

SetAdvancedSecurityEnabled sets the AdvancedSecurityEnabled field's value.

func (*InstanceTypeDetails) SetAppLogsEnabled

func (s *InstanceTypeDetails) SetAppLogsEnabled(v bool) *InstanceTypeDetails

SetAppLogsEnabled sets the AppLogsEnabled field's value.

func (*InstanceTypeDetails) SetAvailabilityZones

func (s *InstanceTypeDetails) SetAvailabilityZones(v []*string) *InstanceTypeDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*InstanceTypeDetails) SetCognitoEnabled

func (s *InstanceTypeDetails) SetCognitoEnabled(v bool) *InstanceTypeDetails

SetCognitoEnabled sets the CognitoEnabled field's value.

func (*InstanceTypeDetails) SetEncryptionEnabled

func (s *InstanceTypeDetails) SetEncryptionEnabled(v bool) *InstanceTypeDetails

SetEncryptionEnabled sets the EncryptionEnabled field's value.

func (*InstanceTypeDetails) SetInstanceRole

func (s *InstanceTypeDetails) SetInstanceRole(v []*string) *InstanceTypeDetails

SetInstanceRole sets the InstanceRole field's value.

func (*InstanceTypeDetails) SetInstanceType

func (s *InstanceTypeDetails) SetInstanceType(v string) *InstanceTypeDetails

SetInstanceType sets the InstanceType field's value.

func (*InstanceTypeDetails) SetWarmEnabled

func (s *InstanceTypeDetails) SetWarmEnabled(v bool) *InstanceTypeDetails

SetWarmEnabled sets the WarmEnabled field's value.

func (InstanceTypeDetails) String

func (s InstanceTypeDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalException

type InternalException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Request processing failed because of an unknown error, exception, or internal failure.

func (*InternalException) Code

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error

func (s *InternalException) Error() string

func (InternalException) GoString

func (s InternalException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalException) Message

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String

func (s InternalException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidPaginationTokenException

type InvalidPaginationTokenException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Request processing failed because you provided an invalid pagination token.

func (*InvalidPaginationTokenException) Code

func (s *InvalidPaginationTokenException) Code() string

Code returns the exception type name.

func (*InvalidPaginationTokenException) Error

func (s *InvalidPaginationTokenException) Error() string

func (InvalidPaginationTokenException) GoString

func (s InvalidPaginationTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidPaginationTokenException) Message

func (s *InvalidPaginationTokenException) Message() string

Message returns the exception's message.

func (*InvalidPaginationTokenException) OrigErr

func (s *InvalidPaginationTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPaginationTokenException) RequestID

func (s *InvalidPaginationTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPaginationTokenException) StatusCode

func (s *InvalidPaginationTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPaginationTokenException) String

func (s InvalidPaginationTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidTypeException

type InvalidTypeException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

An exception for trying to create or access a sub-resource that's either invalid or not supported.

func (*InvalidTypeException) Code

func (s *InvalidTypeException) Code() string

Code returns the exception type name.

func (*InvalidTypeException) Error

func (s *InvalidTypeException) Error() string

func (InvalidTypeException) GoString

func (s InvalidTypeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidTypeException) Message

func (s *InvalidTypeException) Message() string

Message returns the exception's message.

func (*InvalidTypeException) OrigErr

func (s *InvalidTypeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTypeException) RequestID

func (s *InvalidTypeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTypeException) StatusCode

func (s *InvalidTypeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidTypeException) String

func (s InvalidTypeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JWTOptionsInput_

type JWTOptionsInput_ struct {

    // True to enable JWT authentication and authorization for a domain.
    Enabled *bool `type:"boolean"`

    // Element of the JWT assertion used by the cluster to verify JWT signatures.
    PublicKey *string `type:"string"`

    // Element of the JWT assertion to use for roles.
    RolesKey *string `min:"1" type:"string"`

    // Element of the JWT assertion to use for the user name.
    SubjectKey *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.

func (JWTOptionsInput_) GoString

func (s JWTOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JWTOptionsInput_) SetEnabled

func (s *JWTOptionsInput_) SetEnabled(v bool) *JWTOptionsInput_

SetEnabled sets the Enabled field's value.

func (*JWTOptionsInput_) SetPublicKey

func (s *JWTOptionsInput_) SetPublicKey(v string) *JWTOptionsInput_

SetPublicKey sets the PublicKey field's value.

func (*JWTOptionsInput_) SetRolesKey

func (s *JWTOptionsInput_) SetRolesKey(v string) *JWTOptionsInput_

SetRolesKey sets the RolesKey field's value.

func (*JWTOptionsInput_) SetSubjectKey

func (s *JWTOptionsInput_) SetSubjectKey(v string) *JWTOptionsInput_

SetSubjectKey sets the SubjectKey field's value.

func (JWTOptionsInput_) String

func (s JWTOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JWTOptionsInput_) Validate

func (s *JWTOptionsInput_) Validate() error

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

type JWTOptionsOutput_

type JWTOptionsOutput_ struct {

    // True if JWT use is enabled.
    Enabled *bool `type:"boolean"`

    // The key used to verify the signature of incoming JWT requests.
    PublicKey *string `type:"string"`

    // The key used for matching the JWT roles attribute.
    RolesKey *string `type:"string"`

    // The key used for matching the JWT subject attribute.
    SubjectKey *string `type:"string"`
    // contains filtered or unexported fields
}

Describes the JWT options configured for the domain.

func (JWTOptionsOutput_) GoString

func (s JWTOptionsOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JWTOptionsOutput_) SetEnabled

func (s *JWTOptionsOutput_) SetEnabled(v bool) *JWTOptionsOutput_

SetEnabled sets the Enabled field's value.

func (*JWTOptionsOutput_) SetPublicKey

func (s *JWTOptionsOutput_) SetPublicKey(v string) *JWTOptionsOutput_

SetPublicKey sets the PublicKey field's value.

func (*JWTOptionsOutput_) SetRolesKey

func (s *JWTOptionsOutput_) SetRolesKey(v string) *JWTOptionsOutput_

SetRolesKey sets the RolesKey field's value.

func (*JWTOptionsOutput_) SetSubjectKey

func (s *JWTOptionsOutput_) SetSubjectKey(v string) *JWTOptionsOutput_

SetSubjectKey sets the SubjectKey field's value.

func (JWTOptionsOutput_) String

func (s JWTOptionsOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException

type LimitExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

An exception for trying to create more than the allowed number of resources or sub-resources.

func (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Limits

type Limits struct {

    // List of additional limits that are specific to a given instance type for
    // each of its instance roles.
    AdditionalLimits []*AdditionalLimit `type:"list"`

    // The limits for a given instance type.
    InstanceLimits *InstanceLimits `type:"structure"`

    // Storage-related attributes that are available for a given instance type.
    StorageTypes []*StorageType `type:"list"`
    // contains filtered or unexported fields
}

Limits for a given instance type and for each of its roles.

func (Limits) GoString

func (s Limits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Limits) SetAdditionalLimits

func (s *Limits) SetAdditionalLimits(v []*AdditionalLimit) *Limits

SetAdditionalLimits sets the AdditionalLimits field's value.

func (*Limits) SetInstanceLimits

func (s *Limits) SetInstanceLimits(v *InstanceLimits) *Limits

SetInstanceLimits sets the InstanceLimits field's value.

func (*Limits) SetStorageTypes

func (s *Limits) SetStorageTypes(v []*StorageType) *Limits

SetStorageTypes sets the StorageTypes field's value.

func (Limits) String

func (s Limits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDataSourcesInput

type ListDataSourcesInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the ListDataSources operation.

func (ListDataSourcesInput) GoString

func (s ListDataSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (ListDataSourcesInput) String

func (s ListDataSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) Validate

func (s *ListDataSourcesInput) Validate() error

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

type ListDataSourcesOutput

type ListDataSourcesOutput struct {

    // A list of data sources associated with specified domain.
    DataSources []*DataSourceDetails `type:"list"`
    // contains filtered or unexported fields
}

The result of a ListDataSources operation.

func (ListDataSourcesOutput) GoString

func (s ListDataSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesOutput) SetDataSources

func (s *ListDataSourcesOutput) SetDataSources(v []*DataSourceDetails) *ListDataSourcesOutput

SetDataSources sets the DataSources field's value.

func (ListDataSourcesOutput) String

func (s ListDataSourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainMaintenancesInput

type ListDomainMaintenancesInput struct {

    // The name of the action.
    Action *string `location:"querystring" locationName:"action" type:"string" enum:"MaintenanceType"`

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`

    // The status of the action.
    Status *string `location:"querystring" locationName:"status" type:"string" enum:"MaintenanceStatus"`
    // contains filtered or unexported fields
}

Container for the parameters to the ListDomainMaintenances operation.

func (ListDomainMaintenancesInput) GoString

func (s ListDomainMaintenancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainMaintenancesInput) SetAction

func (s *ListDomainMaintenancesInput) SetAction(v string) *ListDomainMaintenancesInput

SetAction sets the Action field's value.

func (*ListDomainMaintenancesInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*ListDomainMaintenancesInput) SetMaxResults

func (s *ListDomainMaintenancesInput) SetMaxResults(v int64) *ListDomainMaintenancesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDomainMaintenancesInput) SetNextToken

func (s *ListDomainMaintenancesInput) SetNextToken(v string) *ListDomainMaintenancesInput

SetNextToken sets the NextToken field's value.

func (*ListDomainMaintenancesInput) SetStatus

func (s *ListDomainMaintenancesInput) SetStatus(v string) *ListDomainMaintenancesInput

SetStatus sets the Status field's value.

func (ListDomainMaintenancesInput) String

func (s ListDomainMaintenancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainMaintenancesInput) Validate

func (s *ListDomainMaintenancesInput) Validate() error

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

type ListDomainMaintenancesOutput

type ListDomainMaintenancesOutput struct {

    // A list of the submitted maintenance actions.
    DomainMaintenances []*DomainMaintenanceDetails `type:"list"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

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

func (ListDomainMaintenancesOutput) GoString

func (s ListDomainMaintenancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainMaintenancesOutput) SetDomainMaintenances

func (s *ListDomainMaintenancesOutput) SetDomainMaintenances(v []*DomainMaintenanceDetails) *ListDomainMaintenancesOutput

SetDomainMaintenances sets the DomainMaintenances field's value.

func (*ListDomainMaintenancesOutput) SetNextToken

func (s *ListDomainMaintenancesOutput) SetNextToken(v string) *ListDomainMaintenancesOutput

SetNextToken sets the NextToken field's value.

func (ListDomainMaintenancesOutput) String

func (s ListDomainMaintenancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainNamesInput

type ListDomainNamesInput struct {

    // Filters the output by domain engine type.
    EngineType *string `location:"querystring" locationName:"engineType" type:"string" enum:"EngineType"`
    // contains filtered or unexported fields
}

Container for the parameters to the ListDomainNames operation.

func (ListDomainNamesInput) GoString

func (s ListDomainNamesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainNamesInput) SetEngineType

func (s *ListDomainNamesInput) SetEngineType(v string) *ListDomainNamesInput

SetEngineType sets the EngineType field's value.

func (ListDomainNamesInput) String

func (s ListDomainNamesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainNamesOutput

type ListDomainNamesOutput struct {

    // The names of all OpenSearch Service domains owned by the current user and
    // their respective engine types.
    DomainNames []*DomainInfo `type:"list"`
    // 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.

func (ListDomainNamesOutput) GoString

func (s ListDomainNamesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainNamesOutput) SetDomainNames

func (s *ListDomainNamesOutput) SetDomainNames(v []*DomainInfo) *ListDomainNamesOutput

SetDomainNames sets the DomainNames field's value.

func (ListDomainNamesOutput) String

func (s ListDomainNamesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainsForPackageInput

type ListDomainsForPackageInput 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 *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`

    // The unique identifier of the package for which to list associated domains.
    //
    // PackageID is a required field
    PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the request parameters to the ListDomainsForPackage operation.

func (ListDomainsForPackageInput) GoString

func (s ListDomainsForPackageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsForPackageInput) SetMaxResults

func (s *ListDomainsForPackageInput) SetMaxResults(v int64) *ListDomainsForPackageInput

SetMaxResults sets the MaxResults field's value.

func (*ListDomainsForPackageInput) SetNextToken

func (s *ListDomainsForPackageInput) SetNextToken(v string) *ListDomainsForPackageInput

SetNextToken sets the NextToken field's value.

func (*ListDomainsForPackageInput) SetPackageID

func (s *ListDomainsForPackageInput) SetPackageID(v string) *ListDomainsForPackageInput

SetPackageID sets the PackageID field's value.

func (ListDomainsForPackageInput) String

func (s ListDomainsForPackageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsForPackageInput) Validate

func (s *ListDomainsForPackageInput) Validate() error

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

type ListDomainsForPackageOutput

type ListDomainsForPackageOutput struct {

    // Information about all domains associated with a package.
    DomainPackageDetailsList []*DomainPackageDetails `type:"list"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Container for the response parameters to the ListDomainsForPackage operation.

func (ListDomainsForPackageOutput) GoString

func (s ListDomainsForPackageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsForPackageOutput) SetDomainPackageDetailsList

func (s *ListDomainsForPackageOutput) SetDomainPackageDetailsList(v []*DomainPackageDetails) *ListDomainsForPackageOutput

SetDomainPackageDetailsList sets the DomainPackageDetailsList field's value.

func (*ListDomainsForPackageOutput) SetNextToken

func (s *ListDomainsForPackageOutput) SetNextToken(v string) *ListDomainsForPackageOutput

SetNextToken sets the NextToken field's value.

func (ListDomainsForPackageOutput) String

func (s ListDomainsForPackageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListInstanceTypeDetailsInput

type ListInstanceTypeDetailsInput struct {

    // The name of the domain.
    DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"`

    // The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y
    // or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
    //
    // EngineVersion is a required field
    EngineVersion *string `location:"uri" locationName:"EngineVersion" min:"14" type:"string" required:"true"`

    // An optional parameter that lists information for a given instance type.
    InstanceType *string `location:"querystring" locationName:"instanceType" min:"10" type:"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 *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`

    // An optional parameter that specifies the Availability Zones for the domain.
    RetrieveAZs *bool `location:"querystring" locationName:"retrieveAZs" type:"boolean"`
    // contains filtered or unexported fields
}

func (ListInstanceTypeDetailsInput) GoString

func (s ListInstanceTypeDetailsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstanceTypeDetailsInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*ListInstanceTypeDetailsInput) SetEngineVersion

func (s *ListInstanceTypeDetailsInput) SetEngineVersion(v string) *ListInstanceTypeDetailsInput

SetEngineVersion sets the EngineVersion field's value.

func (*ListInstanceTypeDetailsInput) SetInstanceType

func (s *ListInstanceTypeDetailsInput) SetInstanceType(v string) *ListInstanceTypeDetailsInput

SetInstanceType sets the InstanceType field's value.

func (*ListInstanceTypeDetailsInput) SetMaxResults

func (s *ListInstanceTypeDetailsInput) SetMaxResults(v int64) *ListInstanceTypeDetailsInput

SetMaxResults sets the MaxResults field's value.

func (*ListInstanceTypeDetailsInput) SetNextToken

func (s *ListInstanceTypeDetailsInput) SetNextToken(v string) *ListInstanceTypeDetailsInput

SetNextToken sets the NextToken field's value.

func (*ListInstanceTypeDetailsInput) SetRetrieveAZs

func (s *ListInstanceTypeDetailsInput) SetRetrieveAZs(v bool) *ListInstanceTypeDetailsInput

SetRetrieveAZs sets the RetrieveAZs field's value.

func (ListInstanceTypeDetailsInput) String

func (s ListInstanceTypeDetailsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstanceTypeDetailsInput) Validate

func (s *ListInstanceTypeDetailsInput) Validate() error

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

type ListInstanceTypeDetailsOutput

type ListInstanceTypeDetailsOutput struct {

    // Lists all supported instance types and features for the given OpenSearch
    // or Elasticsearch version.
    InstanceTypeDetails []*InstanceTypeDetails `type:"list"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

func (ListInstanceTypeDetailsOutput) GoString

func (s ListInstanceTypeDetailsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstanceTypeDetailsOutput) SetInstanceTypeDetails

func (s *ListInstanceTypeDetailsOutput) SetInstanceTypeDetails(v []*InstanceTypeDetails) *ListInstanceTypeDetailsOutput

SetInstanceTypeDetails sets the InstanceTypeDetails field's value.

func (*ListInstanceTypeDetailsOutput) SetNextToken

func (s *ListInstanceTypeDetailsOutput) SetNextToken(v string) *ListInstanceTypeDetailsOutput

SetNextToken sets the NextToken field's value.

func (ListInstanceTypeDetailsOutput) String

func (s ListInstanceTypeDetailsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPackagesForDomainInput

type ListPackagesForDomainInput struct {

    // The name of the domain for which you want to list associated packages.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

Container for the request parameters to the ListPackagesForDomain operation.

func (ListPackagesForDomainInput) GoString

func (s ListPackagesForDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPackagesForDomainInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*ListPackagesForDomainInput) SetMaxResults

func (s *ListPackagesForDomainInput) SetMaxResults(v int64) *ListPackagesForDomainInput

SetMaxResults sets the MaxResults field's value.

func (*ListPackagesForDomainInput) SetNextToken

func (s *ListPackagesForDomainInput) SetNextToken(v string) *ListPackagesForDomainInput

SetNextToken sets the NextToken field's value.

func (ListPackagesForDomainInput) String

func (s ListPackagesForDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPackagesForDomainInput) Validate

func (s *ListPackagesForDomainInput) Validate() error

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

type ListPackagesForDomainOutput

type ListPackagesForDomainOutput struct {

    // List of all packages associated with a domain.
    DomainPackageDetailsList []*DomainPackageDetails `type:"list"`

    // 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 `type:"string"`
    // contains filtered or unexported fields
}

Container for the response parameters to the ListPackagesForDomain operation.

func (ListPackagesForDomainOutput) GoString

func (s ListPackagesForDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPackagesForDomainOutput) SetDomainPackageDetailsList

func (s *ListPackagesForDomainOutput) SetDomainPackageDetailsList(v []*DomainPackageDetails) *ListPackagesForDomainOutput

SetDomainPackageDetailsList sets the DomainPackageDetailsList field's value.

func (*ListPackagesForDomainOutput) SetNextToken

func (s *ListPackagesForDomainOutput) SetNextToken(v string) *ListPackagesForDomainOutput

SetNextToken sets the NextToken field's value.

func (ListPackagesForDomainOutput) String

func (s ListPackagesForDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListScheduledActionsInput

type ListScheduledActionsInput struct {

    // The name of the domain.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // An optional parameter that specifies the maximum number of results to return.
    // You can use nextToken to get the next page of results.
    MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

func (ListScheduledActionsInput) GoString

func (s ListScheduledActionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScheduledActionsInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*ListScheduledActionsInput) SetMaxResults

func (s *ListScheduledActionsInput) SetMaxResults(v int64) *ListScheduledActionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListScheduledActionsInput) SetNextToken

func (s *ListScheduledActionsInput) SetNextToken(v string) *ListScheduledActionsInput

SetNextToken sets the NextToken field's value.

func (ListScheduledActionsInput) String

func (s ListScheduledActionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScheduledActionsInput) Validate

func (s *ListScheduledActionsInput) Validate() error

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

type ListScheduledActionsOutput

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

    // A list of actions that are scheduled for the domain.
    ScheduledActions []*ScheduledAction `type:"list"`
    // contains filtered or unexported fields
}

func (ListScheduledActionsOutput) GoString

func (s ListScheduledActionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScheduledActionsOutput) SetNextToken

func (s *ListScheduledActionsOutput) SetNextToken(v string) *ListScheduledActionsOutput

SetNextToken sets the NextToken field's value.

func (*ListScheduledActionsOutput) SetScheduledActions

func (s *ListScheduledActionsOutput) SetScheduledActions(v []*ScheduledAction) *ListScheduledActionsOutput

SetScheduledActions sets the ScheduledActions field's value.

func (ListScheduledActionsOutput) String

func (s ListScheduledActionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsInput

type ListTagsInput struct {

    // Amazon Resource Name (ARN) for the domain to view tags for.
    //
    // ARN is a required field
    ARN *string `location:"querystring" locationName:"arn" min:"20" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Container for the parameters to the ListTags operation.

func (ListTagsInput) GoString

func (s ListTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsInput) SetARN

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

SetARN sets the ARN field's value.

func (ListTagsInput) String

func (s ListTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsInput) Validate

func (s *ListTagsInput) Validate() error

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

type ListTagsOutput

type ListTagsOutput struct {

    // List of resource tags associated with the specified domain.
    TagList []*Tag `type:"list"`
    // contains filtered or unexported fields
}

The results of a ListTags operation.

func (ListTagsOutput) GoString

func (s ListTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsOutput) SetTagList

func (s *ListTagsOutput) SetTagList(v []*Tag) *ListTagsOutput

SetTagList sets the TagList field's value.

func (ListTagsOutput) String

func (s ListTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

Container for the request parameters to the ListVersions operation.

func (ListVersionsInput) GoString

func (s ListVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVersionsInput) SetMaxResults

func (s *ListVersionsInput) SetMaxResults(v int64) *ListVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListVersionsInput) SetNextToken

func (s *ListVersionsInput) SetNextToken(v string) *ListVersionsInput

SetNextToken sets the NextToken field's value.

func (ListVersionsInput) String

func (s ListVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

    // A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch
    // Service supports.
    Versions []*string `type:"list"`
    // contains filtered or unexported fields
}

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

func (ListVersionsOutput) GoString

func (s ListVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVersionsOutput) SetNextToken

func (s *ListVersionsOutput) SetNextToken(v string) *ListVersionsOutput

SetNextToken sets the NextToken field's value.

func (*ListVersionsOutput) SetVersions

func (s *ListVersionsOutput) SetVersions(v []*string) *ListVersionsOutput

SetVersions sets the Versions field's value.

func (ListVersionsOutput) String

func (s ListVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListVpcEndpointAccessInput

type ListVpcEndpointAccessInput struct {

    // The name of the OpenSearch Service domain to retrieve access information
    // for.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

func (ListVpcEndpointAccessInput) GoString

func (s ListVpcEndpointAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointAccessInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*ListVpcEndpointAccessInput) SetNextToken

func (s *ListVpcEndpointAccessInput) SetNextToken(v string) *ListVpcEndpointAccessInput

SetNextToken sets the NextToken field's value.

func (ListVpcEndpointAccessInput) String

func (s ListVpcEndpointAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointAccessInput) Validate

func (s *ListVpcEndpointAccessInput) Validate() error

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

type ListVpcEndpointAccessOutput

type ListVpcEndpointAccessOutput struct {

    // A list of IAM principals (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html)
    // that can currently access the domain.
    //
    // AuthorizedPrincipalList is a required field
    AuthorizedPrincipalList []*AuthorizedPrincipal `type:"list" required:"true"`

    // 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 is a required field
    NextToken *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListVpcEndpointAccessOutput) GoString

func (s ListVpcEndpointAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointAccessOutput) SetAuthorizedPrincipalList

func (s *ListVpcEndpointAccessOutput) SetAuthorizedPrincipalList(v []*AuthorizedPrincipal) *ListVpcEndpointAccessOutput

SetAuthorizedPrincipalList sets the AuthorizedPrincipalList field's value.

func (*ListVpcEndpointAccessOutput) SetNextToken

func (s *ListVpcEndpointAccessOutput) SetNextToken(v string) *ListVpcEndpointAccessOutput

SetNextToken sets the NextToken field's value.

func (ListVpcEndpointAccessOutput) String

func (s ListVpcEndpointAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListVpcEndpointsForDomainInput

type ListVpcEndpointsForDomainInput struct {

    // The name of the domain to list associated VPC endpoints for.
    //
    // DomainName is a required field
    DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"`

    // 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 `location:"querystring" locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

func (ListVpcEndpointsForDomainInput) GoString

func (s ListVpcEndpointsForDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointsForDomainInput) SetDomainName

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

SetDomainName sets the DomainName field's value.

func (*ListVpcEndpointsForDomainInput) SetNextToken

func (s *ListVpcEndpointsForDomainInput) SetNextToken(v string) *ListVpcEndpointsForDomainInput

SetNextToken sets the NextToken field's value.

func (ListVpcEndpointsForDomainInput) String

func (s ListVpcEndpointsForDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointsForDomainInput) Validate

func (s *ListVpcEndpointsForDomainInput) Validate() error

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

type ListVpcEndpointsForDomainOutput

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.
    //
    // NextToken is a required field
    NextToken *string `type:"string" required:"true"`

    // Information about each endpoint associated with the domain.
    //
    // VpcEndpointSummaryList is a required field
    VpcEndpointSummaryList []*VpcEndpointSummary `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListVpcEndpointsForDomainOutput) GoString

func (s ListVpcEndpointsForDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointsForDomainOutput) SetNextToken

func (s *ListVpcEndpointsForDomainOutput) SetNextToken(v string) *ListVpcEndpointsForDomainOutput

SetNextToken sets the NextToken field's value.

func (*ListVpcEndpointsForDomainOutput) SetVpcEndpointSummaryList

func (s *ListVpcEndpointsForDomainOutput) SetVpcEndpointSummaryList(v []*VpcEndpointSummary) *ListVpcEndpointsForDomainOutput

SetVpcEndpointSummaryList sets the VpcEndpointSummaryList field's value.

func (ListVpcEndpointsForDomainOutput) String

func (s ListVpcEndpointsForDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListVpcEndpointsInput

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 `location:"querystring" locationName:"nextToken" type:"string"`
    // contains filtered or unexported fields
}

func (ListVpcEndpointsInput) GoString

func (s ListVpcEndpointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointsInput) SetNextToken

func (s *ListVpcEndpointsInput) SetNextToken(v string) *ListVpcEndpointsInput

SetNextToken sets the NextToken field's value.

func (ListVpcEndpointsInput) String

func (s ListVpcEndpointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListVpcEndpointsOutput

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.
    //
    // NextToken is a required field
    NextToken *string `type:"string" required:"true"`

    // Information about each endpoint.
    //
    // VpcEndpointSummaryList is a required field
    VpcEndpointSummaryList []*VpcEndpointSummary `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListVpcEndpointsOutput) GoString

func (s ListVpcEndpointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVpcEndpointsOutput) SetNextToken

func (s *ListVpcEndpointsOutput) SetNextToken(v string) *ListVpcEndpointsOutput

SetNextToken sets the NextToken field's value.

func (*ListVpcEndpointsOutput) SetVpcEndpointSummaryList

func (s *ListVpcEndpointsOutput) SetVpcEndpointSummaryList(v []*VpcEndpointSummary) *ListVpcEndpointsOutput

SetVpcEndpointSummaryList sets the VpcEndpointSummaryList field's value.

func (ListVpcEndpointsOutput) String

func (s ListVpcEndpointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogPublishingOption

type LogPublishingOption struct {

    // The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs
    // to.
    CloudWatchLogsLogGroupArn *string `min:"20" type:"string"`

    // Whether the log should be published.
    Enabled *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html).

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

func (LogPublishingOption) GoString

func (s LogPublishingOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogPublishingOption) SetCloudWatchLogsLogGroupArn

func (s *LogPublishingOption) SetCloudWatchLogsLogGroupArn(v string) *LogPublishingOption

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*LogPublishingOption) SetEnabled

func (s *LogPublishingOption) SetEnabled(v bool) *LogPublishingOption

SetEnabled sets the Enabled field's value.

func (LogPublishingOption) String

func (s LogPublishingOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogPublishingOption) Validate

func (s *LogPublishingOption) Validate() error

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

type LogPublishingOptionsStatus

type LogPublishingOptionsStatus struct {

    // The log publishing options configured for the domain.
    Options map[string]*LogPublishingOption `type:"map"`

    // The status of the log publishing options for the domain.
    Status *OptionStatus `type:"structure"`
    // contains filtered or unexported fields
}

The configured log publishing options for the domain and their current status.

func (LogPublishingOptionsStatus) GoString

func (s LogPublishingOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogPublishingOptionsStatus) SetOptions

func (s *LogPublishingOptionsStatus) SetOptions(v map[string]*LogPublishingOption) *LogPublishingOptionsStatus

SetOptions sets the Options field's value.

func (*LogPublishingOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (LogPublishingOptionsStatus) String

func (s LogPublishingOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MasterUserOptions

type MasterUserOptions struct {

    // Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled
    // is false.
    MasterUserARN *string `min:"20" type:"string"`

    // User name for the master user. Only specify if InternalUserDatabaseEnabled
    // is true.
    //
    // MasterUserName is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by MasterUserOptions's
    // String and GoString methods.
    MasterUserName *string `min:"1" type:"string" sensitive:"true"`

    // Password for the master user. Only specify if InternalUserDatabaseEnabled
    // is true.
    //
    // MasterUserPassword is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by MasterUserOptions's
    // String and GoString methods.
    MasterUserPassword *string `min:"8" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

Credentials for the master user for a domain.

func (MasterUserOptions) GoString

func (s MasterUserOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MasterUserOptions) SetMasterUserARN

func (s *MasterUserOptions) SetMasterUserARN(v string) *MasterUserOptions

SetMasterUserARN sets the MasterUserARN field's value.

func (*MasterUserOptions) SetMasterUserName

func (s *MasterUserOptions) SetMasterUserName(v string) *MasterUserOptions

SetMasterUserName sets the MasterUserName field's value.

func (*MasterUserOptions) SetMasterUserPassword

func (s *MasterUserOptions) SetMasterUserPassword(v string) *MasterUserOptions

SetMasterUserPassword sets the MasterUserPassword field's value.

func (MasterUserOptions) String

func (s MasterUserOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MasterUserOptions) Validate

func (s *MasterUserOptions) Validate() error

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

type ModifyingProperties

type ModifyingProperties struct {

    // The current value of the domain property that is being modified.
    ActiveValue *string `type:"string"`

    // The name of the property that is currently being modified.
    Name *string `type:"string"`

    // The value that the property that is currently being modified will eventually
    // have.
    PendingValue *string `type:"string"`

    // The type of value that is currently being modified. Properties can have two
    // types:
    //
    //    * PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
    //
    //    * STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
    ValueType *string `type:"string" enum:"PropertyValueType"`
    // contains filtered or unexported fields
}

Information about the domain properties that are currently being modified.

func (ModifyingProperties) GoString

func (s ModifyingProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyingProperties) SetActiveValue

func (s *ModifyingProperties) SetActiveValue(v string) *ModifyingProperties

SetActiveValue sets the ActiveValue field's value.

func (*ModifyingProperties) SetName

func (s *ModifyingProperties) SetName(v string) *ModifyingProperties

SetName sets the Name field's value.

func (*ModifyingProperties) SetPendingValue

func (s *ModifyingProperties) SetPendingValue(v string) *ModifyingProperties

SetPendingValue sets the PendingValue field's value.

func (*ModifyingProperties) SetValueType

func (s *ModifyingProperties) SetValueType(v string) *ModifyingProperties

SetValueType sets the ValueType field's value.

func (ModifyingProperties) String

func (s ModifyingProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NaturalLanguageQueryGenerationOptionsInput_

type NaturalLanguageQueryGenerationOptionsInput_ struct {

    // The desired state of the natural language query generation feature. Valid
    // values are ENABLED and DISABLED.
    DesiredState *string `type:"string" enum:"NaturalLanguageQueryGenerationDesiredState"`
    // contains filtered or unexported fields
}

Container for parameters required to enable the natural language query generation feature.

func (NaturalLanguageQueryGenerationOptionsInput_) GoString

func (s NaturalLanguageQueryGenerationOptionsInput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NaturalLanguageQueryGenerationOptionsInput_) SetDesiredState

func (s *NaturalLanguageQueryGenerationOptionsInput_) SetDesiredState(v string) *NaturalLanguageQueryGenerationOptionsInput_

SetDesiredState sets the DesiredState field's value.

func (NaturalLanguageQueryGenerationOptionsInput_) String

func (s NaturalLanguageQueryGenerationOptionsInput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NaturalLanguageQueryGenerationOptionsOutput_

type NaturalLanguageQueryGenerationOptionsOutput_ struct {

    // The current state of the natural language query generation feature, indicating
    // completion, in progress, or failure.
    CurrentState *string `type:"string" enum:"NaturalLanguageQueryGenerationCurrentState"`

    // The desired state of the natural language query generation feature. Valid
    // values are ENABLED and DISABLED.
    DesiredState *string `type:"string" enum:"NaturalLanguageQueryGenerationDesiredState"`
    // contains filtered or unexported fields
}

Container for parameters representing the state of the natural language query generation feature on the specified domain.

func (NaturalLanguageQueryGenerationOptionsOutput_) GoString

func (s NaturalLanguageQueryGenerationOptionsOutput_) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NaturalLanguageQueryGenerationOptionsOutput_) SetCurrentState

func (s *NaturalLanguageQueryGenerationOptionsOutput_) SetCurrentState(v string) *NaturalLanguageQueryGenerationOptionsOutput_

SetCurrentState sets the CurrentState field's value.

func (*NaturalLanguageQueryGenerationOptionsOutput_) SetDesiredState

func (s *NaturalLanguageQueryGenerationOptionsOutput_) SetDesiredState(v string) *NaturalLanguageQueryGenerationOptionsOutput_

SetDesiredState sets the DesiredState field's value.

func (NaturalLanguageQueryGenerationOptionsOutput_) String

func (s NaturalLanguageQueryGenerationOptionsOutput_) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NodeToNodeEncryptionOptions

type NodeToNodeEncryptionOptions struct {

    // True to enable node-to-node encryption.
    Enabled *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html).

func (NodeToNodeEncryptionOptions) GoString

func (s NodeToNodeEncryptionOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeToNodeEncryptionOptions) SetEnabled

func (s *NodeToNodeEncryptionOptions) SetEnabled(v bool) *NodeToNodeEncryptionOptions

SetEnabled sets the Enabled field's value.

func (NodeToNodeEncryptionOptions) String

func (s NodeToNodeEncryptionOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NodeToNodeEncryptionOptionsStatus

type NodeToNodeEncryptionOptionsStatus struct {

    // The node-to-node encryption options for the specified domain.
    //
    // Options is a required field
    Options *NodeToNodeEncryptionOptions `type:"structure" required:"true"`

    // The status of the node-to-node encryption options for the specified domain.
    //
    // Status is a required field
    Status *OptionStatus `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Status of the node-to-node encryption options for the specified domain.

func (NodeToNodeEncryptionOptionsStatus) GoString

func (s NodeToNodeEncryptionOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeToNodeEncryptionOptionsStatus) SetOptions

func (s *NodeToNodeEncryptionOptionsStatus) SetOptions(v *NodeToNodeEncryptionOptions) *NodeToNodeEncryptionOptionsStatus

SetOptions sets the Options field's value.

func (*NodeToNodeEncryptionOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (NodeToNodeEncryptionOptionsStatus) String

func (s NodeToNodeEncryptionOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OffPeakWindow

type OffPeakWindow struct {

    // A custom start time for the off-peak window, in Coordinated Universal Time
    // (UTC). The window length will always be 10 hours, so you can't specify an
    // end time. For example, if you specify 11:00 P.M. UTC as a start time, the
    // end time will automatically be set to 9:00 A.M.
    WindowStartTime *WindowStartTime `type:"structure"`
    // contains filtered or unexported fields
}

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.

If you don't specify a window start time, it defaults to 10:00 P.M. local time.

For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html).

func (OffPeakWindow) GoString

func (s OffPeakWindow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OffPeakWindow) SetWindowStartTime

func (s *OffPeakWindow) SetWindowStartTime(v *WindowStartTime) *OffPeakWindow

SetWindowStartTime sets the WindowStartTime field's value.

func (OffPeakWindow) String

func (s OffPeakWindow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OffPeakWindow) Validate

func (s *OffPeakWindow) Validate() error

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

type OffPeakWindowOptions

type OffPeakWindowOptions struct {

    // Whether to enable an off-peak window.
    //
    // This option is only available when modifying a domain created prior to February
    // 16, 2023, not when creating a new domain. All domains created after this
    // date have the off-peak window enabled by default. You can't disable the off-peak
    // window after it's enabled for a domain.
    Enabled *bool `type:"boolean"`

    // Off-peak window settings for the domain.
    OffPeakWindow *OffPeakWindow `type:"structure"`
    // contains filtered or unexported fields
}

Options for a domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html), during which OpenSearch Service can perform mandatory configuration changes on the domain.

func (OffPeakWindowOptions) GoString

func (s OffPeakWindowOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OffPeakWindowOptions) SetEnabled

func (s *OffPeakWindowOptions) SetEnabled(v bool) *OffPeakWindowOptions

SetEnabled sets the Enabled field's value.

func (*OffPeakWindowOptions) SetOffPeakWindow

func (s *OffPeakWindowOptions) SetOffPeakWindow(v *OffPeakWindow) *OffPeakWindowOptions

SetOffPeakWindow sets the OffPeakWindow field's value.

func (OffPeakWindowOptions) String

func (s OffPeakWindowOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OffPeakWindowOptions) Validate

func (s *OffPeakWindowOptions) Validate() error

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

type OffPeakWindowOptionsStatus

type OffPeakWindowOptionsStatus struct {

    // The domain's off-peak window configuration.
    Options *OffPeakWindowOptions `type:"structure"`

    // The current status of off-peak window options.
    Status *OptionStatus `type:"structure"`
    // contains filtered or unexported fields
}

The status of off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) options for a domain.

func (OffPeakWindowOptionsStatus) GoString

func (s OffPeakWindowOptionsStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OffPeakWindowOptionsStatus) SetOptions

func (s *OffPeakWindowOptionsStatus) SetOptions(v *OffPeakWindowOptions) *OffPeakWindowOptionsStatus

SetOptions sets the Options field's value.

func (*OffPeakWindowOptionsStatus) SetStatus

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

SetStatus sets the Status field's value.

func (OffPeakWindowOptionsStatus) String

func (s OffPeakWindowOptionsStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OpenSearchService

type OpenSearchService struct {
    *client.Client
}

OpenSearchService provides the API operation methods for making requests to Amazon OpenSearch Service. See this package's package overview docs for details on the service.

OpenSearchService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *OpenSearchService

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

Example:

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

// Create a OpenSearchService client from just a session.
svc := opensearchservice.New(mySession)

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

func (*OpenSearchService) AcceptInboundConnection

func (c *OpenSearchService) AcceptInboundConnection(input *AcceptInboundConnectionInput) (*AcceptInboundConnectionOutput, error)

AcceptInboundConnection API operation for Amazon OpenSearch Service.

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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation AcceptInboundConnection for usage and error information.

Returned Error Types:

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnection

func (*OpenSearchService) AcceptInboundConnectionRequest

func (c *OpenSearchService) AcceptInboundConnectionRequest(input *AcceptInboundConnectionInput) (req *request.Request, output *AcceptInboundConnectionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnection

func (*OpenSearchService) AcceptInboundConnectionWithContext

func (c *OpenSearchService) AcceptInboundConnectionWithContext(ctx aws.Context, input *AcceptInboundConnectionInput, opts ...request.Option) (*AcceptInboundConnectionOutput, error)

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

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

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

func (*OpenSearchService) AddDataSource

func (c *OpenSearchService) AddDataSource(input *AddDataSourceInput) (*AddDataSourceOutput, error)

AddDataSource API operation for Amazon OpenSearch Service.

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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation AddDataSource for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

  • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDataSource

func (*OpenSearchService) AddDataSourceRequest

func (c *OpenSearchService) AddDataSourceRequest(input *AddDataSourceInput) (req *request.Request, output *AddDataSourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDataSource

func (*OpenSearchService) AddDataSourceWithContext

func (c *OpenSearchService) AddDataSourceWithContext(ctx aws.Context, input *AddDataSourceInput, opts ...request.Option) (*AddDataSourceOutput, error)

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

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

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

func (*OpenSearchService) AddTags

func (c *OpenSearchService) AddTags(input *AddTagsInput) (*AddTagsOutput, error)

AddTags API operation for Amazon OpenSearch Service.

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation AddTags for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTags

func (*OpenSearchService) AddTagsRequest

func (c *OpenSearchService) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTags

func (*OpenSearchService) AddTagsWithContext

func (c *OpenSearchService) AddTagsWithContext(ctx aws.Context, input *AddTagsInput, opts ...request.Option) (*AddTagsOutput, error)

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

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

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

func (*OpenSearchService) AssociatePackage

func (c *OpenSearchService) AssociatePackage(input *AssociatePackageInput) (*AssociatePackageOutput, error)

AssociatePackage API operation for Amazon OpenSearch Service.

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation AssociatePackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • AccessDeniedException An error occurred because you don't have permissions to access the resource.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

  • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage

func (*OpenSearchService) AssociatePackageRequest

func (c *OpenSearchService) AssociatePackageRequest(input *AssociatePackageInput) (req *request.Request, output *AssociatePackageOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage

func (*OpenSearchService) AssociatePackageWithContext

func (c *OpenSearchService) AssociatePackageWithContext(ctx aws.Context, input *AssociatePackageInput, opts ...request.Option) (*AssociatePackageOutput, error)

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

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

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

func (*OpenSearchService) AuthorizeVpcEndpointAccess

func (c *OpenSearchService) AuthorizeVpcEndpointAccess(input *AuthorizeVpcEndpointAccessInput) (*AuthorizeVpcEndpointAccessOutput, error)

AuthorizeVpcEndpointAccess API operation for Amazon OpenSearch Service.

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

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation AuthorizeVpcEndpointAccess for usage and error information.

Returned Error Types:

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • BaseException An error occurred while processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccess

func (*OpenSearchService) AuthorizeVpcEndpointAccessRequest

func (c *OpenSearchService) AuthorizeVpcEndpointAccessRequest(input *AuthorizeVpcEndpointAccessInput) (req *request.Request, output *AuthorizeVpcEndpointAccessOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccess

func (*OpenSearchService) AuthorizeVpcEndpointAccessWithContext

func (c *OpenSearchService) AuthorizeVpcEndpointAccessWithContext(ctx aws.Context, input *AuthorizeVpcEndpointAccessInput, opts ...request.Option) (*AuthorizeVpcEndpointAccessOutput, error)

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

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

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

func (*OpenSearchService) CancelDomainConfigChange

func (c *OpenSearchService) CancelDomainConfigChange(input *CancelDomainConfigChangeInput) (*CancelDomainConfigChangeOutput, error)

CancelDomainConfigChange API operation for Amazon OpenSearch Service.

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

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation CancelDomainConfigChange for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelDomainConfigChange

func (*OpenSearchService) CancelDomainConfigChangeRequest

func (c *OpenSearchService) CancelDomainConfigChangeRequest(input *CancelDomainConfigChangeInput) (req *request.Request, output *CancelDomainConfigChangeOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelDomainConfigChange

func (*OpenSearchService) CancelDomainConfigChangeWithContext

func (c *OpenSearchService) CancelDomainConfigChangeWithContext(ctx aws.Context, input *CancelDomainConfigChangeInput, opts ...request.Option) (*CancelDomainConfigChangeOutput, error)

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

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

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

func (*OpenSearchService) CancelServiceSoftwareUpdate

func (c *OpenSearchService) CancelServiceSoftwareUpdate(input *CancelServiceSoftwareUpdateInput) (*CancelServiceSoftwareUpdateOutput, error)

CancelServiceSoftwareUpdate API operation for Amazon OpenSearch Service.

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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation CancelServiceSoftwareUpdate for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdate

func (*OpenSearchService) CancelServiceSoftwareUpdateRequest

func (c *OpenSearchService) CancelServiceSoftwareUpdateRequest(input *CancelServiceSoftwareUpdateInput) (req *request.Request, output *CancelServiceSoftwareUpdateOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdate

func (*OpenSearchService) CancelServiceSoftwareUpdateWithContext

func (c *OpenSearchService) CancelServiceSoftwareUpdateWithContext(ctx aws.Context, input *CancelServiceSoftwareUpdateInput, opts ...request.Option) (*CancelServiceSoftwareUpdateOutput, error)

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

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

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

func (*OpenSearchService) CreateDomain

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

CreateDomain API operation for Amazon OpenSearch Service.

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html).

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

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

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

  • ResourceAlreadyExistsException An exception for creating a resource that already exists.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain

func (*OpenSearchService) CreateDomainRequest

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain

func (*OpenSearchService) CreateDomainWithContext

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

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

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

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

func (*OpenSearchService) CreateOutboundConnection

func (c *OpenSearchService) CreateOutboundConnection(input *CreateOutboundConnectionInput) (*CreateOutboundConnectionOutput, error)

CreateOutboundConnection API operation for Amazon OpenSearch Service.

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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation CreateOutboundConnection for usage and error information.

Returned Error Types:

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceAlreadyExistsException An exception for creating a resource that already exists.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnection

func (*OpenSearchService) CreateOutboundConnectionRequest

func (c *OpenSearchService) CreateOutboundConnectionRequest(input *CreateOutboundConnectionInput) (req *request.Request, output *CreateOutboundConnectionOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnection

func (*OpenSearchService) CreateOutboundConnectionWithContext

func (c *OpenSearchService) CreateOutboundConnectionWithContext(ctx aws.Context, input *CreateOutboundConnectionInput, opts ...request.Option) (*CreateOutboundConnectionOutput, error)

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

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

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

func (*OpenSearchService) CreatePackage

func (c *OpenSearchService) CreatePackage(input *CreatePackageInput) (*CreatePackageOutput, error)

CreatePackage API operation for Amazon OpenSearch Service.

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation CreatePackage for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

  • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.

  • ResourceAlreadyExistsException An exception for creating a resource that already exists.

  • AccessDeniedException An error occurred because you don't have permissions to access the resource.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage

func (*OpenSearchService) CreatePackageRequest

func (c *OpenSearchService) CreatePackageRequest(input *CreatePackageInput) (req *request.Request, output *CreatePackageOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage

func (*OpenSearchService) CreatePackageWithContext

func (c *OpenSearchService) CreatePackageWithContext(ctx aws.Context, input *CreatePackageInput, opts ...request.Option) (*CreatePackageOutput, error)

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

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

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

func (*OpenSearchService) CreateVpcEndpoint

func (c *OpenSearchService) CreateVpcEndpoint(input *CreateVpcEndpointInput) (*CreateVpcEndpointOutput, error)

CreateVpcEndpoint API operation for Amazon OpenSearch Service.

Creates an Amazon OpenSearch Service-managed VPC endpoint.

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation CreateVpcEndpoint for usage and error information.

Returned Error Types:

  • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

  • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

  • BaseException An error occurred while processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateVpcEndpoint

func (*OpenSearchService) CreateVpcEndpointRequest

func (c *OpenSearchService) CreateVpcEndpointRequest(input *CreateVpcEndpointInput) (req *request.Request, output *CreateVpcEndpointOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateVpcEndpoint

func (*OpenSearchService) CreateVpcEndpointWithContext

func (c *OpenSearchService) CreateVpcEndpointWithContext(ctx aws.Context, input *CreateVpcEndpointInput, opts ...request.Option) (*CreateVpcEndpointOutput, error)

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

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

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

func (*OpenSearchService) DeleteDataSource

func (c *OpenSearchService) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)

DeleteDataSource API operation for Amazon OpenSearch Service.

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html).

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

See the AWS API reference guide for Amazon OpenSearch Service's API operation DeleteDataSource for usage and error information.

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

  • DisabledOperationException An error occured because the client wanted to access an unsupported operation.

  • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSource

func (*OpenSearchService) DeleteDataSourceRequest

func (c *OpenSearchService) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSource

func (*OpenSearchService) DeleteDataSourceWithContext

func (c *OpenSearchService) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)

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

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

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

func (*OpenSearchService) DeleteDomain

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

DeleteDomain API operation for Amazon OpenSearch Service.

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

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

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

Returned Error Types:

  • BaseException An error occurred while processing the request.

  • InternalException Request processing failed because of an unknown error, exception, or internal failure.

  • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.

  • ValidationException An exception for accessing or deleting a resource that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain

func (*OpenSearchService) DeleteDomainRequest

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

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

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

See DeleteDomain for more information on using