{ "version":"2.0", "metadata":{ "apiVersion":"2021-01-01", "endpointPrefix":"es", "protocol":"rest-json", "serviceFullName":"Amazon OpenSearch Service", "serviceId":"OpenSearch", "signatureVersion":"v4", "uid":"opensearch-2021-01-01" }, "operations":{ "AcceptInboundConnection":{ "name":"AcceptInboundConnection", "http":{ "method":"PUT", "requestUri":"/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/accept" }, "input":{"shape":"AcceptInboundConnectionRequest"}, "output":{"shape":"AcceptInboundConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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.

" }, "AddDataSource":{ "name":"AddDataSource", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource" }, "input":{"shape":"AddDataSourceRequest"}, "output":{"shape":"AddDataSourceResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"DependencyFailureException"}, {"shape":"LimitExceededException"} ], "documentation":"

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.

" }, "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/2021-01-01/tags" }, "input":{"shape":"AddTagsRequest"}, "errors":[ {"shape":"BaseException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "AssociatePackage":{ "name":"AssociatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/associate/{PackageID}/{DomainName}" }, "input":{"shape":"AssociatePackageRequest"}, "output":{"shape":"AssociatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"} ], "documentation":"

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

" }, "AuthorizeVpcEndpointAccess":{ "name":"AuthorizeVpcEndpointAccess", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess" }, "input":{"shape":"AuthorizeVpcEndpointAccessRequest"}, "output":{"shape":"AuthorizeVpcEndpointAccessResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"BaseException"} ], "documentation":"

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

" }, "CancelServiceSoftwareUpdate":{ "name":"CancelServiceSoftwareUpdate", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/serviceSoftwareUpdate/cancel" }, "input":{"shape":"CancelServiceSoftwareUpdateRequest"}, "output":{"shape":"CancelServiceSoftwareUpdateResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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.

" }, "CreateDomain":{ "name":"CreateDomain", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain" }, "input":{"shape":"CreateDomainRequest"}, "output":{"shape":"CreateDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "CreateOutboundConnection":{ "name":"CreateOutboundConnection", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/cc/outboundConnection" }, "input":{"shape":"CreateOutboundConnectionRequest"}, "output":{"shape":"CreateOutboundConnectionResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InternalException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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.

" }, "CreatePackage":{ "name":"CreatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages" }, "input":{"shape":"CreatePackageRequest"}, "output":{"shape":"CreatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidTypeException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/vpcEndpoints" }, "input":{"shape":"CreateVpcEndpointRequest"}, "output":{"shape":"CreateVpcEndpointResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"InternalException"}, {"shape":"DisabledOperationException"}, {"shape":"BaseException"} ], "documentation":"

Creates an Amazon OpenSearch Service-managed VPC endpoint.

" }, "DeleteDataSource":{ "name":"DeleteDataSource", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}" }, "input":{"shape":"DeleteDataSourceRequest"}, "output":{"shape":"DeleteDataSourceResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"DependencyFailureException"} ], "documentation":"

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

" }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}" }, "input":{"shape":"DeleteDomainRequest"}, "output":{"shape":"DeleteDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DeleteInboundConnection":{ "name":"DeleteInboundConnection", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}" }, "input":{"shape":"DeleteInboundConnectionRequest"}, "output":{"shape":"DeleteInboundConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DeleteOutboundConnection":{ "name":"DeleteOutboundConnection", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}" }, "input":{"shape":"DeleteOutboundConnectionRequest"}, "output":{"shape":"DeleteOutboundConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DeletePackage":{ "name":"DeletePackage", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/packages/{PackageID}" }, "input":{"shape":"DeletePackageRequest"}, "output":{"shape":"DeletePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"} ], "documentation":"

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

" }, "DeleteVpcEndpoint":{ "name":"DeleteVpcEndpoint", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}" }, "input":{"shape":"DeleteVpcEndpointRequest"}, "output":{"shape":"DeleteVpcEndpointResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"}, {"shape":"BaseException"} ], "documentation":"

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

" }, "DescribeDomain":{ "name":"DescribeDomain", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}" }, "input":{"shape":"DescribeDomainRequest"}, "output":{"shape":"DescribeDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeDomainAutoTunes":{ "name":"DescribeDomainAutoTunes", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/autoTunes" }, "input":{"shape":"DescribeDomainAutoTunesRequest"}, "output":{"shape":"DescribeDomainAutoTunesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeDomainChangeProgress":{ "name":"DescribeDomainChangeProgress", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/progress" }, "input":{"shape":"DescribeDomainChangeProgressRequest"}, "output":{"shape":"DescribeDomainChangeProgressResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

" }, "DescribeDomainConfig":{ "name":"DescribeDomainConfig", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/config" }, "input":{"shape":"DescribeDomainConfigRequest"}, "output":{"shape":"DescribeDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Returns the configuration of an Amazon OpenSearch Service domain.

" }, "DescribeDomainHealth":{ "name":"DescribeDomainHealth", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/health" }, "input":{"shape":"DescribeDomainHealthRequest"}, "output":{"shape":"DescribeDomainHealthResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DescribeDomainNodes":{ "name":"DescribeDomainNodes", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/nodes" }, "input":{"shape":"DescribeDomainNodesRequest"}, "output":{"shape":"DescribeDomainNodesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"DependencyFailureException"} ], "documentation":"

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

" }, "DescribeDomains":{ "name":"DescribeDomains", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain-info" }, "input":{"shape":"DescribeDomainsRequest"}, "output":{"shape":"DescribeDomainsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeDryRunProgress":{ "name":"DescribeDryRunProgress", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dryRun" }, "input":{"shape":"DescribeDryRunProgressRequest"}, "output":{"shape":"DescribeDryRunProgressResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DescribeInboundConnections":{ "name":"DescribeInboundConnections", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/cc/inboundConnection/search" }, "input":{"shape":"DescribeInboundConnectionsRequest"}, "output":{"shape":"DescribeInboundConnectionsResponse"}, "errors":[ {"shape":"InvalidPaginationTokenException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DescribeInstanceTypeLimits":{ "name":"DescribeInstanceTypeLimits", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}" }, "input":{"shape":"DescribeInstanceTypeLimitsRequest"}, "output":{"shape":"DescribeInstanceTypeLimitsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeOutboundConnections":{ "name":"DescribeOutboundConnections", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/cc/outboundConnection/search" }, "input":{"shape":"DescribeOutboundConnectionsRequest"}, "output":{"shape":"DescribeOutboundConnectionsResponse"}, "errors":[ {"shape":"InvalidPaginationTokenException"}, {"shape":"DisabledOperationException"} ], "documentation":"

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

" }, "DescribePackages":{ "name":"DescribePackages", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/describe" }, "input":{"shape":"DescribePackagesRequest"}, "output":{"shape":"DescribePackagesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeReservedInstanceOfferings":{ "name":"DescribeReservedInstanceOfferings", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/reservedInstanceOfferings" }, "input":{"shape":"DescribeReservedInstanceOfferingsRequest"}, "output":{"shape":"DescribeReservedInstanceOfferingsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"} ], "documentation":"

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

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/reservedInstances" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DescribeVpcEndpoints":{ "name":"DescribeVpcEndpoints", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/vpcEndpoints/describe" }, "input":{"shape":"DescribeVpcEndpointsRequest"}, "output":{"shape":"DescribeVpcEndpointsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalException"}, {"shape":"DisabledOperationException"}, {"shape":"BaseException"} ], "documentation":"

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

" }, "DissociatePackage":{ "name":"DissociatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/dissociate/{PackageID}/{DomainName}" }, "input":{"shape":"DissociatePackageRequest"}, "output":{"shape":"DissociatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"} ], "documentation":"

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

" }, "GetCompatibleVersions":{ "name":"GetCompatibleVersions", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/compatibleVersions" }, "input":{"shape":"GetCompatibleVersionsRequest"}, "output":{"shape":"GetCompatibleVersionsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

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

" }, "GetDataSource":{ "name":"GetDataSource", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}" }, "input":{"shape":"GetDataSourceRequest"}, "output":{"shape":"GetDataSourceResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"DependencyFailureException"} ], "documentation":"

Retrieves information about a direct query data source.

" }, "GetDomainMaintenanceStatus":{ "name":"GetDomainMaintenanceStatus", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance" }, "input":{"shape":"GetDomainMaintenanceStatusRequest"}, "output":{"shape":"GetDomainMaintenanceStatusResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"

The status of the maintenance action.

" }, "GetPackageVersionHistory":{ "name":"GetPackageVersionHistory", "http":{ "method":"GET", "requestUri":"/2021-01-01/packages/{PackageID}/history" }, "input":{"shape":"GetPackageVersionHistoryRequest"}, "output":{"shape":"GetPackageVersionHistoryResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "GetUpgradeHistory":{ "name":"GetUpgradeHistory", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/upgradeDomain/{DomainName}/history" }, "input":{"shape":"GetUpgradeHistoryRequest"}, "output":{"shape":"GetUpgradeHistoryResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

" }, "GetUpgradeStatus":{ "name":"GetUpgradeStatus", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/upgradeDomain/{DomainName}/status" }, "input":{"shape":"GetUpgradeStatusRequest"}, "output":{"shape":"GetUpgradeStatusResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

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

" }, "ListDataSources":{ "name":"ListDataSources", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource" }, "input":{"shape":"ListDataSourcesRequest"}, "output":{"shape":"ListDataSourcesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"DependencyFailureException"} ], "documentation":"

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

" }, "ListDomainMaintenances":{ "name":"ListDomainMaintenances", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/domainMaintenances" }, "input":{"shape":"ListDomainMaintenancesRequest"}, "output":{"shape":"ListDomainMaintenancesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"

A list of maintenance actions for the domain.

" }, "ListDomainNames":{ "name":"ListDomainNames", "http":{ "method":"GET", "requestUri":"/2021-01-01/domain" }, "input":{"shape":"ListDomainNamesRequest"}, "output":{"shape":"ListDomainNamesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "ListDomainsForPackage":{ "name":"ListDomainsForPackage", "http":{ "method":"GET", "requestUri":"/2021-01-01/packages/{PackageID}/domains" }, "input":{"shape":"ListDomainsForPackageRequest"}, "output":{"shape":"ListDomainsForPackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

" }, "ListInstanceTypeDetails":{ "name":"ListInstanceTypeDetails", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}" }, "input":{"shape":"ListInstanceTypeDetailsRequest"}, "output":{"shape":"ListInstanceTypeDetailsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "ListPackagesForDomain":{ "name":"ListPackagesForDomain", "http":{ "method":"GET", "requestUri":"/2021-01-01/domain/{DomainName}/packages" }, "input":{"shape":"ListPackagesForDomainRequest"}, "output":{"shape":"ListPackagesForDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "ListScheduledActions":{ "name":"ListScheduledActions", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/scheduledActions" }, "input":{"shape":"ListScheduledActionsRequest"}, "output":{"shape":"ListScheduledActionsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidPaginationTokenException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "ListTags":{ "name":"ListTags", "http":{ "method":"GET", "requestUri":"/2021-01-01/tags/" }, "input":{"shape":"ListTagsRequest"}, "output":{"shape":"ListTagsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

" }, "ListVersions":{ "name":"ListVersions", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/versions" }, "input":{"shape":"ListVersionsRequest"}, "output":{"shape":"ListVersionsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "ListVpcEndpointAccess":{ "name":"ListVpcEndpointAccess", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess" }, "input":{"shape":"ListVpcEndpointAccessRequest"}, "output":{"shape":"ListVpcEndpointAccessResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"}, {"shape":"BaseException"} ], "documentation":"

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

" }, "ListVpcEndpoints":{ "name":"ListVpcEndpoints", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/vpcEndpoints" }, "input":{"shape":"ListVpcEndpointsRequest"}, "output":{"shape":"ListVpcEndpointsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"DisabledOperationException"}, {"shape":"BaseException"} ], "documentation":"

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

" }, "ListVpcEndpointsForDomain":{ "name":"ListVpcEndpointsForDomain", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints" }, "input":{"shape":"ListVpcEndpointsForDomainRequest"}, "output":{"shape":"ListVpcEndpointsForDomainResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"DisabledOperationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"BaseException"} ], "documentation":"

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

" }, "PurchaseReservedInstanceOffering":{ "name":"PurchaseReservedInstanceOffering", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/purchaseReservedInstanceOffering" }, "input":{"shape":"PurchaseReservedInstanceOfferingRequest"}, "output":{"shape":"PurchaseReservedInstanceOfferingResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

" }, "RejectInboundConnection":{ "name":"RejectInboundConnection", "http":{ "method":"PUT", "requestUri":"/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject" }, "input":{"shape":"RejectInboundConnectionRequest"}, "output":{"shape":"RejectInboundConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

" }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/2021-01-01/tags-removal" }, "input":{"shape":"RemoveTagsRequest"}, "errors":[ {"shape":"BaseException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

" }, "RevokeVpcEndpointAccess":{ "name":"RevokeVpcEndpointAccess", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess" }, "input":{"shape":"RevokeVpcEndpointAccessRequest"}, "output":{"shape":"RevokeVpcEndpointAccessResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"}, {"shape":"BaseException"} ], "documentation":"

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

" }, "StartDomainMaintenance":{ "name":"StartDomainMaintenance", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance" }, "input":{"shape":"StartDomainMaintenanceRequest"}, "output":{"shape":"StartDomainMaintenanceResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "StartServiceSoftwareUpdate":{ "name":"StartServiceSoftwareUpdate", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/serviceSoftwareUpdate/start" }, "input":{"shape":"StartServiceSoftwareUpdateRequest"}, "output":{"shape":"StartServiceSoftwareUpdateResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

" }, "UpdateDataSource":{ "name":"UpdateDataSource", "http":{ "method":"PUT", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}" }, "input":{"shape":"UpdateDataSourceRequest"}, "output":{"shape":"UpdateDataSourceResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"DependencyFailureException"} ], "documentation":"

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

" }, "UpdateDomainConfig":{ "name":"UpdateDomainConfig", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/config" }, "input":{"shape":"UpdateDomainConfigRequest"}, "output":{"shape":"UpdateDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "UpdatePackage":{ "name":"UpdatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/update" }, "input":{"shape":"UpdatePackageRequest"}, "output":{"shape":"UpdatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "UpdateScheduledAction":{ "name":"UpdateScheduledAction", "http":{ "method":"PUT", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update" }, "input":{"shape":"UpdateScheduledActionRequest"}, "output":{"shape":"UpdateScheduledActionResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"SlotNotAvailableException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "UpdateVpcEndpoint":{ "name":"UpdateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/vpcEndpoints/update" }, "input":{"shape":"UpdateVpcEndpointRequest"}, "output":{"shape":"UpdateVpcEndpointResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"BaseException"} ], "documentation":"

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

" }, "UpgradeDomain":{ "name":"UpgradeDomain", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/upgradeDomain" }, "input":{"shape":"UpgradeDomainRequest"}, "output":{"shape":"UpgradeDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

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

" } }, "shapes":{ "ARN":{ "type":"string", "documentation":"

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

", "max":2048, "min":20, "pattern":".*" }, "AWSAccount":{ "type":"string", "pattern":"^[0-9]+$" }, "AWSDomainInformation":{ "type":"structure", "required":["DomainName"], "members":{ "OwnerId":{ "shape":"OwnerId", "documentation":"

The Amazon Web Services account ID of the domain owner.

" }, "DomainName":{ "shape":"DomainName", "documentation":"

Name of the domain.

" }, "Region":{ "shape":"Region", "documentation":"

The Amazon Web Services Region in which the domain is located.

" } }, "documentation":"

Information about an Amazon OpenSearch Service domain.

" }, "AcceptInboundConnectionRequest":{ "type":"structure", "required":["ConnectionId"], "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"

The ID of the inbound connection to accept.

", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"

Container for the parameters to the `AcceptInboundConnection` operation.

" }, "AcceptInboundConnectionResponse":{ "type":"structure", "members":{ "Connection":{ "shape":"InboundConnection", "documentation":"

Information about the accepted inbound connection.

" } }, "documentation":"

Contains details about the accepted inbound connection.

" }, "AccessDeniedException":{ "type":"structure", "members":{ }, "documentation":"

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

", "error":{"httpStatusCode":403}, "exception":true }, "AccessPoliciesStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"PolicyDocument", "documentation":"

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.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the access policy for the domain.

" } }, "documentation":"

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

" }, "ActionSeverity":{ "type":"string", "enum":[ "HIGH", "MEDIUM", "LOW" ] }, "ActionStatus":{ "type":"string", "enum":[ "PENDING_UPDATE", "IN_PROGRESS", "FAILED", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE" ] }, "ActionType":{ "type":"string", "enum":[ "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING" ] }, "AddDataSourceRequest":{ "type":"structure", "required":[ "DomainName", "Name", "DataSourceType" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain to add the data source to.

", "location":"uri", "locationName":"DomainName" }, "Name":{ "shape":"DataSourceName", "documentation":"

A name for the data source.

" }, "DataSourceType":{ "shape":"DataSourceType", "documentation":"

The type of data source.

" }, "Description":{ "shape":"DataSourceDescription", "documentation":"

A description of the data source.

" } }, "documentation":"

Container for the parameters to the `AddDataSource` operation.

" }, "AddDataSourceResponse":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

A message associated with creation of the data source.

" } }, "documentation":"

The result of an `AddDataSource` operation.

" }, "AddTagsRequest":{ "type":"structure", "required":[ "ARN", "TagList" ], "members":{ "ARN":{ "shape":"ARN", "documentation":"

Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

" }, "TagList":{ "shape":"TagList", "documentation":"

List of resource tags.

" } }, "documentation":"

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

" }, "AdditionalLimit":{ "type":"structure", "members":{ "LimitName":{ "shape":"LimitName", "documentation":"

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

" }, "LimitValues":{ "shape":"LimitValueList", "documentation":"

The values of the additional instance type limits.

" } }, "documentation":"

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

" }, "AdditionalLimitList":{ "type":"list", "member":{"shape":"AdditionalLimit"} }, "AdvancedOptions":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"}, "documentation":"

Exposes native OpenSearch configuration values from `opensearch.yml`. The following advanced options are available:

- Allows references to indexes in an HTTP request body. Must be `false` when configuring access to individual sub-resources. Default is `true`.

- Specifies the percentage of heap space allocated to field data. Default is unbounded.

For more information, see Advanced cluster parameters.

" }, "AdvancedOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"AdvancedOptions", "documentation":"

The status of advanced options for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of advanced options for the specified domain.

" } }, "documentation":"

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.

" }, "AdvancedSecurityOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True if fine-grained access control is enabled.

" }, "InternalUserDatabaseEnabled":{ "shape":"Boolean", "documentation":"

True if the internal user database is enabled.

" }, "SAMLOptions":{ "shape":"SAMLOptionsOutput", "documentation":"

Container for information about the SAML configuration for OpenSearch Dashboards.

" }, "AnonymousAuthDisableDate":{ "shape":"DisableTimestamp", "documentation":"

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

" }, "AnonymousAuthEnabled":{ "shape":"Boolean", "documentation":"

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.

" } }, "documentation":"

Container for fine-grained access control settings.

" }, "AdvancedSecurityOptionsInput":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True to enable fine-grained access control.

" }, "InternalUserDatabaseEnabled":{ "shape":"Boolean", "documentation":"

True to enable the internal user database.

" }, "MasterUserOptions":{ "shape":"MasterUserOptions", "documentation":"

Container for information about the master user.

" }, "SAMLOptions":{ "shape":"SAMLOptionsInput", "documentation":"

Container for information about the SAML configuration for OpenSearch Dashboards.

" }, "AnonymousAuthEnabled":{ "shape":"Boolean", "documentation":"

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.

" } }, "documentation":"

Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.

" }, "AdvancedSecurityOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"AdvancedSecurityOptions", "documentation":"

Container for fine-grained access control settings.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

Status of the fine-grained access control settings for a domain.

" } }, "documentation":"

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

" }, "AssociatePackageRequest":{ "type":"structure", "required":[ "PackageID", "DomainName" ], "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

Internal ID of the package to associate with a domain. Use `DescribePackages` to find this value.

", "location":"uri", "locationName":"PackageID" }, "DomainName":{ "shape":"DomainName", "documentation":"

Name of the domain to associate the package with.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the request parameters to the `AssociatePackage` operation.

" }, "AssociatePackageResponse":{ "type":"structure", "members":{ "DomainPackageDetails":{ "shape":"DomainPackageDetails", "documentation":"

Information about a package that is associated with a domain.

" } }, "documentation":"

Container for the response returned by the `AssociatePackage` operation.

" }, "AuthorizeVpcEndpointAccessRequest":{ "type":"structure", "required":[ "DomainName", "Account" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the OpenSearch Service domain to provide access to.

", "location":"uri", "locationName":"DomainName" }, "Account":{ "shape":"AWSAccount", "documentation":"

The Amazon Web Services account ID to grant access to.

" } } }, "AuthorizeVpcEndpointAccessResponse":{ "type":"structure", "required":["AuthorizedPrincipal"], "members":{ "AuthorizedPrincipal":{ "shape":"AuthorizedPrincipal", "documentation":"

Information about the Amazon Web Services account or service that was provided access to the domain.

" } } }, "AuthorizedPrincipal":{ "type":"structure", "members":{ "PrincipalType":{ "shape":"PrincipalType", "documentation":"

The type of principal.

" }, "Principal":{ "shape":"String", "documentation":"

The IAM principal that is allowed access to the domain.

" } }, "documentation":"

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.

" }, "AuthorizedPrincipalList":{ "type":"list", "member":{"shape":"AuthorizedPrincipal"} }, "AutoTune":{ "type":"structure", "members":{ "AutoTuneType":{ "shape":"AutoTuneType", "documentation":"

The type of Auto-Tune action.

" }, "AutoTuneDetails":{ "shape":"AutoTuneDetails", "documentation":"

Details about an Auto-Tune action.

" } }, "documentation":"

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

" }, "AutoTuneDate":{ "type":"timestamp", "documentation":"

The timestamp of the Auto-Tune action scheduled for the domain.

" }, "AutoTuneDesiredState":{ "type":"string", "documentation":"

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

", "enum":[ "ENABLED", "DISABLED" ] }, "AutoTuneDetails":{ "type":"structure", "members":{ "ScheduledAutoTuneDetails":{ "shape":"ScheduledAutoTuneDetails", "documentation":"

Container for details about a scheduled Auto-Tune action.

" } }, "documentation":"

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

" }, "AutoTuneList":{ "type":"list", "member":{"shape":"AutoTune"} }, "AutoTuneMaintenanceSchedule":{ "type":"structure", "members":{ "StartAt":{ "shape":"StartAt", "documentation":"

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

" }, "Duration":{ "shape":"Duration", "documentation":"

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

" }, "CronExpressionForRecurrence":{ "shape":"String", "documentation":"

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

" } }, "documentation":"

This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

" }, "AutoTuneMaintenanceScheduleList":{ "type":"list", "member":{"shape":"AutoTuneMaintenanceSchedule"}, "max":100 }, "AutoTuneOptions":{ "type":"structure", "members":{ "DesiredState":{ "shape":"AutoTuneDesiredState", "documentation":"

Whether Auto-Tune is enabled or disabled.

" }, "RollbackOnDisable":{ "shape":"RollbackOnDisable", "documentation":"

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.

" }, "MaintenanceSchedules":{ "shape":"AutoTuneMaintenanceScheduleList", "documentation":"

DEPRECATED. Use off-peak window instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

" }, "UseOffPeakWindow":{ "shape":"Boolean", "documentation":"

Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

" } }, "documentation":"

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

" }, "AutoTuneOptionsInput":{ "type":"structure", "members":{ "DesiredState":{ "shape":"AutoTuneDesiredState", "documentation":"

Whether Auto-Tune is enabled or disabled.

" }, "MaintenanceSchedules":{ "shape":"AutoTuneMaintenanceScheduleList", "documentation":"

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

" }, "UseOffPeakWindow":{ "shape":"Boolean", "documentation":"

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

" } }, "documentation":"

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

" }, "AutoTuneOptionsOutput":{ "type":"structure", "members":{ "State":{ "shape":"AutoTuneState", "documentation":"

The current state of Auto-Tune on the domain.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

Any errors that occurred while enabling or disabling Auto-Tune.

" }, "UseOffPeakWindow":{ "shape":"Boolean", "documentation":"

Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

" } }, "documentation":"

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

" }, "AutoTuneOptionsStatus":{ "type":"structure", "members":{ "Options":{ "shape":"AutoTuneOptions", "documentation":"

Auto-Tune settings for updating a domain.

" }, "Status":{ "shape":"AutoTuneStatus", "documentation":"

The current status of Auto-Tune for a domain.

" } }, "documentation":"

The Auto-Tune status for the domain.

" }, "AutoTuneState":{ "type":"string", "documentation":"

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.

", "enum":[ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR" ] }, "AutoTuneStatus":{ "type":"structure", "required":[ "CreationDate", "UpdateDate", "State" ], "members":{ "CreationDate":{ "shape":"UpdateTimestamp", "documentation":"

Date and time when Auto-Tune was enabled for the domain.

" }, "UpdateDate":{ "shape":"UpdateTimestamp", "documentation":"

Date and time when the Auto-Tune options were last updated for the domain.

" }, "UpdateVersion":{ "shape":"UIntValue", "documentation":"

The latest version of the Auto-Tune options.

" }, "State":{ "shape":"AutoTuneState", "documentation":"

The current state of Auto-Tune on the domain.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

Any errors that occurred while enabling or disabling Auto-Tune.

" }, "PendingDeletion":{ "shape":"Boolean", "documentation":"

Indicates whether the domain is being deleted.

" } }, "documentation":"

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

" }, "AutoTuneType":{ "type":"string", "documentation":"

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

", "enum":["SCHEDULED_ACTION"] }, "AvailabilityZone":{ "type":"string", "max":15, "min":1 }, "AvailabilityZoneInfo":{ "type":"structure", "members":{ "AvailabilityZoneName":{ "shape":"AvailabilityZone", "documentation":"

The name of the Availability Zone.

" }, "ZoneStatus":{ "shape":"ZoneStatus", "documentation":"

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.

" }, "ConfiguredDataNodeCount":{ "shape":"NumberOfNodes", "documentation":"

The total number of data nodes configured in the Availability Zone.

" }, "AvailableDataNodeCount":{ "shape":"NumberOfNodes", "documentation":"

The number of data nodes active in the Availability Zone.

" }, "TotalShards":{ "shape":"NumberOfShards", "documentation":"

The total number of primary and replica shards in the Availability Zone.

" }, "TotalUnAssignedShards":{ "shape":"NumberOfShards", "documentation":"

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

" } }, "documentation":"

Information about an Availability Zone on a domain.

" }, "AvailabilityZoneInfoList":{ "type":"list", "member":{"shape":"AvailabilityZoneInfo"} }, "AvailabilityZoneList":{ "type":"list", "member":{"shape":"AvailabilityZone"} }, "BackendRole":{ "type":"string", "max":256, "min":1 }, "BaseException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description of the error.

" } }, "documentation":"

An error occurred while processing the request.

", "exception":true }, "Boolean":{"type":"boolean"}, "CancelServiceSoftwareUpdateRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

Name of the OpenSearch Service domain that you want to cancel the service software update on.

" } }, "documentation":"

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

" }, "CancelServiceSoftwareUpdateResponse":{ "type":"structure", "members":{ "ServiceSoftwareOptions":{ "shape":"ServiceSoftwareOptions", "documentation":"

Container for the state of your domain relative to the latest service software.

" } }, "documentation":"

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

" }, "ChangeProgressDetails":{ "type":"structure", "members":{ "ChangeId":{ "shape":"GUID", "documentation":"

The ID of the configuration change.

" }, "Message":{ "shape":"Message", "documentation":"

A message corresponding to the status of the configuration change.

" } }, "documentation":"

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

" }, "ChangeProgressStage":{ "type":"structure", "members":{ "Name":{ "shape":"ChangeProgressStageName", "documentation":"

The name of the stage.

" }, "Status":{ "shape":"ChangeProgressStageStatus", "documentation":"

The status of the stage.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the stage.

" }, "LastUpdated":{ "shape":"LastUpdated", "documentation":"

The most recent updated timestamp of the stage.

" } }, "documentation":"

Progress details for each stage of a domain update.

" }, "ChangeProgressStageList":{ "type":"list", "member":{"shape":"ChangeProgressStage"}, "documentation":"

The list of progress stages of a specific domain configuration change.

" }, "ChangeProgressStageName":{ "type":"string", "max":64, "min":1 }, "ChangeProgressStageStatus":{ "type":"string", "max":256, "min":1 }, "ChangeProgressStatusDetails":{ "type":"structure", "members":{ "ChangeId":{ "shape":"GUID", "documentation":"

The unique change identifier associated with a specific domain configuration change.

" }, "StartTime":{ "shape":"UpdateTimestamp", "documentation":"

The time at which the configuration change is made on the domain.

" }, "Status":{ "shape":"OverallChangeStatus", "documentation":"

The overall status of the domain configuration change.

" }, "PendingProperties":{ "shape":"StringList", "documentation":"

The list of properties in the domain configuration change that are still pending.

" }, "CompletedProperties":{ "shape":"StringList", "documentation":"

The list of properties in the domain configuration change that have completed.

" }, "TotalNumberOfStages":{ "shape":"TotalNumberOfStages", "documentation":"

The total number of stages required for the configuration change.

" }, "ChangeProgressStages":{ "shape":"ChangeProgressStageList", "documentation":"

The specific stages that the domain is going through to perform the configuration change.

" } }, "documentation":"

The progress details of a specific domain configuration change.

" }, "ClientToken":{ "type":"string", "max":64, "min":1 }, "CloudWatchLogsLogGroupArn":{ "type":"string", "documentation":"

ARN of the Cloudwatch log group to publish logs to.

", "max":2048, "min":20, "pattern":".*" }, "ClusterConfig":{ "type":"structure", "members":{ "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"

Instance type of data nodes in the cluster.

" }, "InstanceCount":{ "shape":"IntegerClass", "documentation":"

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

" }, "DedicatedMasterEnabled":{ "shape":"Boolean", "documentation":"

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.

" }, "ZoneAwarenessEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

" }, "ZoneAwarenessConfig":{ "shape":"ZoneAwarenessConfig", "documentation":"

Container for zone awareness configuration options. Only required if `ZoneAwarenessEnabled` is `true`.

" }, "DedicatedMasterType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"

OpenSearch Service instance type of the dedicated master nodes in the cluster.

" }, "DedicatedMasterCount":{ "shape":"IntegerClass", "documentation":"

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

" }, "WarmEnabled":{ "shape":"Boolean", "documentation":"

Whether to enable warm storage for the cluster.

" }, "WarmType":{ "shape":"OpenSearchWarmPartitionInstanceType", "documentation":"

The instance type for the cluster's warm nodes.

" }, "WarmCount":{ "shape":"IntegerClass", "documentation":"

The number of warm nodes in the cluster.

" }, "ColdStorageOptions":{ "shape":"ColdStorageOptions", "documentation":"

Container for cold storage configuration options.

" }, "MultiAZWithStandbyEnabled":{ "shape":"Boolean", "documentation":"

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.

" } }, "documentation":"

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

" }, "ClusterConfigStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"ClusterConfig", "documentation":"

Cluster configuration options for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of cluster configuration options for the specified domain.

" } }, "documentation":"

The cluster configuration status for a domain.

" }, "CognitoOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

" }, "UserPoolId":{ "shape":"UserPoolId", "documentation":"

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

" }, "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool.

" } }, "documentation":"

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.

" }, "CognitoOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"CognitoOptions", "documentation":"

Cognito options for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the Cognito options for the specified domain.

" } }, "documentation":"

The status of the Cognito options for the specified domain.

" }, "ColdStorageOptions":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Whether to enable or disable cold storage on the domain.

" } }, "documentation":"

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

" }, "CommitMessage":{ "type":"string", "max":160 }, "CompatibleVersionsList":{ "type":"list", "member":{"shape":"CompatibleVersionsMap"} }, "CompatibleVersionsMap":{ "type":"structure", "members":{ "SourceVersion":{ "shape":"VersionString", "documentation":"

The current version that the OpenSearch Service domain is running.

" }, "TargetVersions":{ "shape":"VersionList", "documentation":"

The possible versions that you can upgrade the domain to.

" } }, "documentation":"

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

" }, "ConflictException":{ "type":"structure", "members":{ }, "documentation":"

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

", "error":{"httpStatusCode":409}, "exception":true }, "ConnectionAlias":{ "type":"string", "max":100, "min":2, "pattern":"[a-zA-Z][a-zA-Z0-9\\-\\_]+" }, "ConnectionId":{ "type":"string", "max":256, "min":10, "pattern":"[a-z][a-z0-9\\-]+" }, "ConnectionMode":{ "type":"string", "documentation":"

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.

", "enum":[ "DIRECT", "VPC_ENDPOINT" ] }, "ConnectionProperties":{ "type":"structure", "members":{ "Endpoint":{ "shape":"Endpoint", "documentation":"

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

" }, "CrossClusterSearch":{ "shape":"CrossClusterSearchConnectionProperties", "documentation":"

The connection properties for cross cluster search.

" } }, "documentation":"

The connection properties of an outbound connection.

" }, "ConnectionStatusMessage":{"type":"string"}, "CreateDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

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.

" }, "EngineVersion":{ "shape":"VersionString", "documentation":"

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.

" }, "ClusterConfig":{ "shape":"ClusterConfig", "documentation":"

Container for the cluster configuration of a domain.

" }, "EBSOptions":{ "shape":"EBSOptions", "documentation":"

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

" }, "AccessPolicies":{ "shape":"PolicyDocument", "documentation":"

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

" }, "IPAddressType":{ "shape":"IPAddressType", "documentation":"

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.

" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

" }, "VPCOptions":{ "shape":"VPCOptions", "documentation":"

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.

" }, "CognitoOptions":{ "shape":"CognitoOptions", "documentation":"

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptions", "documentation":"

Key-value pairs to enable encryption at rest.

" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"

Enables node-to-node encryption.

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

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.

" }, "LogPublishingOptions":{ "shape":"LogPublishingOptions", "documentation":"

Key-value pairs to configure log publishing.

" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", "documentation":"

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

" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsInput", "documentation":"

Options for fine-grained access control.

" }, "TagList":{ "shape":"TagList", "documentation":"

List of tags to add to the domain upon creation.

" }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsInput", "documentation":"

Options for Auto-Tune.

" }, "OffPeakWindowOptions":{ "shape":"OffPeakWindowOptions", "documentation":"

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.

" }, "SoftwareUpdateOptions":{ "shape":"SoftwareUpdateOptions", "documentation":"

Software update options for the domain.

" } } }, "CreateDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{ "shape":"DomainStatus", "documentation":"

The status of the newly created domain.

" } }, "documentation":"

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

" }, "CreateOutboundConnectionRequest":{ "type":"structure", "required":[ "LocalDomainInfo", "RemoteDomainInfo", "ConnectionAlias" ], "members":{ "LocalDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Name and Region of the source (local) domain.

" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Name and Region of the destination (remote) domain.

" }, "ConnectionAlias":{ "shape":"ConnectionAlias", "documentation":"

Name of the connection.

" }, "ConnectionMode":{ "shape":"ConnectionMode", "documentation":"

The connection mode.

" }, "ConnectionProperties":{ "shape":"ConnectionProperties", "documentation":"

The `ConnectionProperties` for the outbound connection.

" } }, "documentation":"

Container for the parameters to the `CreateOutboundConnection` operation.

" }, "CreateOutboundConnectionResponse":{ "type":"structure", "members":{ "LocalDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Information about the source (local) domain.

" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Information about the destination (remote) domain.

" }, "ConnectionAlias":{ "shape":"ConnectionAlias", "documentation":"

Name of the connection.

" }, "ConnectionStatus":{ "shape":"OutboundConnectionStatus", "documentation":"

The status of the connection.

" }, "ConnectionId":{ "shape":"ConnectionId", "documentation":"

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

" }, "ConnectionMode":{ "shape":"ConnectionMode", "documentation":"

The connection mode.

" }, "ConnectionProperties":{ "shape":"ConnectionProperties", "documentation":"

The `ConnectionProperties` for the newly created connection.

" } }, "documentation":"

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

" }, "CreatePackageRequest":{ "type":"structure", "required":[ "PackageName", "PackageType", "PackageSource" ], "members":{ "PackageName":{ "shape":"PackageName", "documentation":"

Unique name for the package.

" }, "PackageType":{ "shape":"PackageType", "documentation":"

The type of package.

" }, "PackageDescription":{ "shape":"PackageDescription", "documentation":"

Description of the package.

" }, "PackageSource":{ "shape":"PackageSource", "documentation":"

The Amazon S3 location from which to import the package.

" } }, "documentation":"

Container for request parameters to the `CreatePackage` operation.

" }, "CreatePackageResponse":{ "type":"structure", "members":{ "PackageDetails":{ "shape":"PackageDetails", "documentation":"

Basic information about an OpenSearch Service package.

" } }, "documentation":"

Container for the response returned by the `CreatePackage` operation.

" }, "CreateVpcEndpointRequest":{ "type":"structure", "required":[ "DomainArn", "VpcOptions" ], "members":{ "DomainArn":{ "shape":"DomainArn", "documentation":"

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

" }, "VpcOptions":{ "shape":"VPCOptions", "documentation":"

Options to specify the subnets and security groups for the endpoint.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

Unique, case-sensitive identifier to ensure idempotency of the request.

" } } }, "CreateVpcEndpointResponse":{ "type":"structure", "required":["VpcEndpoint"], "members":{ "VpcEndpoint":{ "shape":"VpcEndpoint", "documentation":"

Information about the newly created VPC endpoint.

" } } }, "CreatedAt":{"type":"timestamp"}, "CrossClusterSearchConnectionProperties":{ "type":"structure", "members":{ "SkipUnavailable":{ "shape":"SkipUnavailableStatus", "documentation":"

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.

" } }, "documentation":"

Cross-cluster search specific connection properties.

" }, "DataSourceDescription":{ "type":"string", "max":1000, "pattern":"^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" }, "DataSourceDetails":{ "type":"structure", "members":{ "DataSourceType":{ "shape":"DataSourceType", "documentation":"

The type of data source.

" }, "Name":{ "shape":"DataSourceName", "documentation":"

The name of the data source.

" }, "Description":{ "shape":"DataSourceDescription", "documentation":"

A description of the data source.

" } }, "documentation":"

Details about a direct-query data source.

" }, "DataSourceList":{ "type":"list", "member":{"shape":"DataSourceDetails"} }, "DataSourceName":{ "type":"string", "max":80, "min":3, "pattern":"[a-z][a-z0-9_]+" }, "DataSourceType":{ "type":"structure", "members":{ "S3GlueDataCatalog":{ "shape":"S3GlueDataCatalog", "documentation":"

An Amazon S3 data source.

" } }, "documentation":"

The type of data source.

", "union":true }, "DeleteDataSourceRequest":{ "type":"structure", "required":[ "DomainName", "Name" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "Name":{ "shape":"DataSourceName", "documentation":"

The name of the data source to delete.

", "location":"uri", "locationName":"DataSourceName" } }, "documentation":"

Container for the parameters to the `DeleteDataSource` operation.

" }, "DeleteDataSourceResponse":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

A message associated with deletion of the data source.

" } }, "documentation":"

The result of a `GetDataSource` operation.

" }, "DeleteDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to permanently delete.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the `DeleteDomain` operation.

" }, "DeleteDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{ "shape":"DomainStatus", "documentation":"

The status of the domain being deleted.

" } }, "documentation":"

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.

" }, "DeleteInboundConnectionRequest":{ "type":"structure", "required":["ConnectionId"], "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"

The ID of the inbound connection to permanently delete.

", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"

Container for the parameters to the `DeleteInboundConnection` operation.

" }, "DeleteInboundConnectionResponse":{ "type":"structure", "members":{ "Connection":{ "shape":"InboundConnection", "documentation":"

The deleted inbound connection.

" } }, "documentation":"

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

" }, "DeleteOutboundConnectionRequest":{ "type":"structure", "required":["ConnectionId"], "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"

The ID of the outbound connection you want to permanently delete.

", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"

Container for the parameters to the `DeleteOutboundConnection` operation.

" }, "DeleteOutboundConnectionResponse":{ "type":"structure", "members":{ "Connection":{ "shape":"OutboundConnection", "documentation":"

The deleted inbound connection.

" } }, "documentation":"

Details about the deleted outbound connection.

" }, "DeletePackageRequest":{ "type":"structure", "required":["PackageID"], "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

The internal ID of the package you want to delete. Use `DescribePackages` to find this value.

", "location":"uri", "locationName":"PackageID" } }, "documentation":"

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

" }, "DeletePackageResponse":{ "type":"structure", "members":{ "PackageDetails":{ "shape":"PackageDetails", "documentation":"

Information about the deleted package.

" } }, "documentation":"

Container for the response parameters to the `DeletePackage` operation.

" }, "DeleteVpcEndpointRequest":{ "type":"structure", "required":["VpcEndpointId"], "members":{ "VpcEndpointId":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

", "location":"uri", "locationName":"VpcEndpointId" } } }, "DeleteVpcEndpointResponse":{ "type":"structure", "required":["VpcEndpointSummary"], "members":{ "VpcEndpointSummary":{ "shape":"VpcEndpointSummary", "documentation":"

Information about the deleted endpoint, including its current status (`DELETING` or `DELETE_FAILED`).

" } } }, "DependencyFailureException":{ "type":"structure", "members":{ }, "documentation":"

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

", "error":{"httpStatusCode":424}, "exception":true }, "DeploymentCloseDateTimeStamp":{"type":"timestamp"}, "DeploymentStatus":{ "type":"string", "enum":[ "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE" ] }, "DeploymentType":{ "type":"string", "max":128, "min":2 }, "DescribeDomainAutoTunesRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

Name of the domain that you want Auto-Tune details about.

", "location":"uri", "locationName":"DomainName" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } }, "documentation":"

Container for the parameters to the `DescribeDomainAutoTunes` operation.

" }, "DescribeDomainAutoTunesResponse":{ "type":"structure", "members":{ "AutoTunes":{ "shape":"AutoTuneList", "documentation":"

The list of setting adjustments that Auto-Tune has made to the domain.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

The result of a `DescribeDomainAutoTunes` request.

" }, "DescribeDomainChangeProgressRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain to get progress information for.

", "location":"uri", "locationName":"DomainName" }, "ChangeId":{ "shape":"GUID", "documentation":"

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

", "location":"querystring", "locationName":"changeid" } }, "documentation":"

Container for the parameters to the `DescribeDomainChangeProgress` operation.

" }, "DescribeDomainChangeProgressResponse":{ "type":"structure", "members":{ "ChangeProgressStatus":{ "shape":"ChangeProgressStatusDetails", "documentation":"

Container for information about the stages of a configuration change happening on a domain.

" } }, "documentation":"

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

" }, "DescribeDomainConfigRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

Name of the OpenSearch Service domain configuration that you want to describe.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the `DescribeDomainConfig` operation.

" }, "DescribeDomainConfigResponse":{ "type":"structure", "required":["DomainConfig"], "members":{ "DomainConfig":{ "shape":"DomainConfig", "documentation":"

Container for the configuration of the OpenSearch Service domain.

" } }, "documentation":"

Contains the configuration information of the requested domain.

" }, "DescribeDomainHealthRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the `DescribeDomainHealth` operation.

" }, "DescribeDomainHealthResponse":{ "type":"structure", "members":{ "DomainState":{ "shape":"DomainState", "documentation":"

The current state of the domain.

- `Processing` - The domain has updates in progress.

- `Active` - Requested changes have been processed and deployed to the domain.

" }, "AvailabilityZoneCount":{ "shape":"NumberOfAZs", "documentation":"

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

" }, "ActiveAvailabilityZoneCount":{ "shape":"NumberOfAZs", "documentation":"

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

" }, "StandByAvailabilityZoneCount":{ "shape":"NumberOfAZs", "documentation":"

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

" }, "DataNodeCount":{ "shape":"NumberOfNodes", "documentation":"

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

" }, "DedicatedMaster":{ "shape":"Boolean", "documentation":"

A boolean that indicates if dedicated master nodes are activated for the domain.

" }, "MasterEligibleNodeCount":{ "shape":"NumberOfNodes", "documentation":"

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

" }, "WarmNodeCount":{ "shape":"NumberOfNodes", "documentation":"

The number of warm nodes configured for the domain.

" }, "MasterNode":{ "shape":"MasterNodeStatus", "documentation":"

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.

" }, "ClusterHealth":{ "shape":"DomainHealth", "documentation":"

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.

" }, "TotalShards":{ "shape":"NumberOfShards", "documentation":"

The total number of primary and replica shards for the domain.

" }, "TotalUnAssignedShards":{ "shape":"NumberOfShards", "documentation":"

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

" }, "EnvironmentInformation":{ "shape":"EnvironmentInfoList", "documentation":"

A list of `EnvironmentInfo` for the domain.

" } }, "documentation":"

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

" }, "DescribeDomainNodesRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the `DescribeDomainNodes` operation.

" }, "DescribeDomainNodesResponse":{ "type":"structure", "members":{ "DomainNodesStatusList":{ "shape":"DomainNodesStatusList", "documentation":"

Contains nodes information list `DomainNodesStatusList` with details about the all nodes on the requested domain.

" } }, "documentation":"

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

" }, "DescribeDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain that you want information about.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the `DescribeDomain` operation.

" }, "DescribeDomainResponse":{ "type":"structure", "required":["DomainStatus"], "members":{ "DomainStatus":{ "shape":"DomainStatus", "documentation":"

List that contains the status of each specified OpenSearch Service domain.

" } }, "documentation":"

Contains the status of the domain specified in the request.

" }, "DescribeDomainsRequest":{ "type":"structure", "required":["DomainNames"], "members":{ "DomainNames":{ "shape":"DomainNameList", "documentation":"

Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

" } }, "documentation":"

Container for the parameters to the `DescribeDomains` operation.

" }, "DescribeDomainsResponse":{ "type":"structure", "required":["DomainStatusList"], "members":{ "DomainStatusList":{ "shape":"DomainStatusList", "documentation":"

The status of the requested domains.

" } }, "documentation":"

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

" }, "DescribeDryRunProgressRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "DryRunId":{ "shape":"GUID", "documentation":"

The unique identifier of the dry run.

", "location":"querystring", "locationName":"dryRunId" }, "LoadDryRunConfig":{ "shape":"Boolean", "documentation":"

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.

", "location":"querystring", "locationName":"loadDryRunConfig" } } }, "DescribeDryRunProgressResponse":{ "type":"structure", "members":{ "DryRunProgressStatus":{ "shape":"DryRunProgressStatus", "documentation":"

The current status of the dry run, including any validation errors.

" }, "DryRunConfig":{ "shape":"DomainStatus", "documentation":"

Details about the changes you're planning to make on the domain.

" }, "DryRunResults":{ "shape":"DryRunResults", "documentation":"

The results of the dry run.

" } } }, "DescribeInboundConnectionsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

A list of filters used to match properties for inbound cross-cluster connections.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } }, "documentation":"

Container for the parameters to the `DescribeInboundConnections` operation.

" }, "DescribeInboundConnectionsResponse":{ "type":"structure", "members":{ "Connections":{ "shape":"InboundConnections", "documentation":"

List of inbound connections.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

Contains a list of connections matching the filter criteria.

" }, "DescribeInstanceTypeLimitsRequest":{ "type":"structure", "required":[ "InstanceType", "EngineVersion" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain. Only specify if you need the limits for an existing domain.

", "location":"querystring", "locationName":"domainName" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"

The OpenSearch Service instance type for which you need limit information.

", "location":"uri", "locationName":"InstanceType" }, "EngineVersion":{ "shape":"VersionString", "documentation":"

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

", "location":"uri", "locationName":"EngineVersion" } }, "documentation":"

Container for the parameters to the `DescribeInstanceTypeLimits` operation.

" }, "DescribeInstanceTypeLimitsResponse":{ "type":"structure", "members":{ "LimitsByRole":{ "shape":"LimitsByRole", "documentation":"

Map that contains all applicable instance type limits.`data` refers to data nodes.`master` refers to dedicated master nodes.

" } }, "documentation":"

Container for the parameters received from the `DescribeInstanceTypeLimits` operation.

" }, "DescribeOutboundConnectionsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

List of filter names and values that you can use for requests.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } }, "documentation":"

Container for the parameters to the `DescribeOutboundConnections` operation.

" }, "DescribeOutboundConnectionsResponse":{ "type":"structure", "members":{ "Connections":{ "shape":"OutboundConnections", "documentation":"

List of outbound connections that match the filter criteria.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

Contains a list of connections matching the filter criteria.

" }, "DescribePackagesFilter":{ "type":"structure", "members":{ "Name":{ "shape":"DescribePackagesFilterName", "documentation":"

Any field from `PackageDetails`.

" }, "Value":{ "shape":"DescribePackagesFilterValues", "documentation":"

A non-empty list of values for the specified filter field.

" } }, "documentation":"

A filter to apply to the `DescribePackage` response.

" }, "DescribePackagesFilterList":{ "type":"list", "member":{"shape":"DescribePackagesFilter"}, "documentation":"

A list of `DescribePackagesFilter` to filter the packages included in a `DescribePackages` response.

" }, "DescribePackagesFilterName":{ "type":"string", "enum":[ "PackageID", "PackageName", "PackageStatus", "PackageType", "EngineVersion" ] }, "DescribePackagesFilterValue":{ "type":"string", "pattern":"^[0-9a-zA-Z\\*\\.\\_\\\\\\/\\?-]+$" }, "DescribePackagesFilterValues":{ "type":"list", "member":{"shape":"DescribePackagesFilterValue"}, "min":1 }, "DescribePackagesRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"DescribePackagesFilterList", "documentation":"

Only returns packages that match the `DescribePackagesFilterList` values.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } }, "documentation":"

Container for the request parameters to the `DescribePackage` operation.

" }, "DescribePackagesResponse":{ "type":"structure", "members":{ "PackageDetailsList":{ "shape":"PackageDetailsList", "documentation":"

Basic information about a package.

" }, "NextToken":{ "shape":"String", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

Container for the response returned by the `DescribePackages` operation.

" }, "DescribeReservedInstanceOfferingsRequest":{ "type":"structure", "members":{ "ReservedInstanceOfferingId":{ "shape":"GUID", "documentation":"

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

", "location":"querystring", "locationName":"offeringId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the request parameters to a `DescribeReservedInstanceOfferings` operation.

" }, "DescribeReservedInstanceOfferingsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" }, "ReservedInstanceOfferings":{ "shape":"ReservedInstanceOfferingList", "documentation":"

List of Reserved Instance offerings.

" } }, "documentation":"

Container for results of a `DescribeReservedInstanceOfferings` request.

" }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "ReservedInstanceId":{ "shape":"GUID", "documentation":"

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

", "location":"querystring", "locationName":"reservationId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the request parameters to the `DescribeReservedInstances` operation.

" }, "DescribeReservedInstancesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" }, "ReservedInstances":{ "shape":"ReservedInstanceList", "documentation":"

List of Reserved Instances in the current Region.

" } }, "documentation":"

Container for results from `DescribeReservedInstances`

" }, "DescribeVpcEndpointsRequest":{ "type":"structure", "required":["VpcEndpointIds"], "members":{ "VpcEndpointIds":{ "shape":"VpcEndpointIdList", "documentation":"

The unique identifiers of the endpoints to get information about.

" } } }, "DescribeVpcEndpointsResponse":{ "type":"structure", "required":[ "VpcEndpoints", "VpcEndpointErrors" ], "members":{ "VpcEndpoints":{ "shape":"VpcEndpoints", "documentation":"

Information about each requested VPC endpoint.

" }, "VpcEndpointErrors":{ "shape":"VpcEndpointErrorList", "documentation":"

Any errors associated with the request.

" } } }, "Description":{"type":"string"}, "DisableTimestamp":{"type":"timestamp"}, "DisabledOperationException":{ "type":"structure", "members":{ }, "documentation":"

An error occured because the client wanted to access an unsupported operation.

", "error":{"httpStatusCode":409}, "exception":true }, "DissociatePackageRequest":{ "type":"structure", "required":[ "PackageID", "DomainName" ], "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

Internal ID of the package to dissociate from the domain. Use `ListPackagesForDomain` to find this value.

", "location":"uri", "locationName":"PackageID" }, "DomainName":{ "shape":"DomainName", "documentation":"

Name of the domain to dissociate the package from.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the request parameters to the `DissociatePackage` operation.

" }, "DissociatePackageResponse":{ "type":"structure", "members":{ "DomainPackageDetails":{ "shape":"DomainPackageDetails", "documentation":"

Information about a package that has been dissociated from the domain.

" } }, "documentation":"

Container for the response returned by an `DissociatePackage` operation.

" }, "DomainArn":{ "type":"string", "max":512, "min":1, "pattern":"arn:aws[a-z\\-]*:[a-z]+:[a-z0-9\\-]+:[0-9]+:domain\\/[a-z0-9\\-]+" }, "DomainConfig":{ "type":"structure", "members":{ "EngineVersion":{ "shape":"VersionStatus", "documentation":"

The OpenSearch or Elasticsearch version that the domain is running.

" }, "ClusterConfig":{ "shape":"ClusterConfigStatus", "documentation":"

Container for the cluster configuration of a the domain.

" }, "EBSOptions":{ "shape":"EBSOptionsStatus", "documentation":"

Container for EBS options configured for the domain.

" }, "AccessPolicies":{ "shape":"AccessPoliciesStatus", "documentation":"

Specifies the access policies for the domain.

" }, "IPAddressType":{ "shape":"IPAddressTypeStatus", "documentation":"

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.

" }, "SnapshotOptions":{ "shape":"SnapshotOptionsStatus", "documentation":"

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

" }, "VPCOptions":{ "shape":"VPCDerivedInfoStatus", "documentation":"

The current VPC options for the domain and the status of any updates to their configuration.

" }, "CognitoOptions":{ "shape":"CognitoOptionsStatus", "documentation":"

Container for Amazon Cognito options for the domain.

" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptionsStatus", "documentation":"

Key-value pairs to enable encryption at rest.

" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptionsStatus", "documentation":"

Whether node-to-node encryption is enabled or disabled.

" }, "AdvancedOptions":{ "shape":"AdvancedOptionsStatus", "documentation":"

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

" }, "LogPublishingOptions":{ "shape":"LogPublishingOptionsStatus", "documentation":"

Key-value pairs to configure log publishing.

" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptionsStatus", "documentation":"

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

" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsStatus", "documentation":"

Container for fine-grained access control settings for the domain.

" }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsStatus", "documentation":"

Container for Auto-Tune settings for the domain.

" }, "ChangeProgressDetails":{ "shape":"ChangeProgressDetails", "documentation":"

Container for information about the progress of an existing configuration change.

" }, "OffPeakWindowOptions":{ "shape":"OffPeakWindowOptionsStatus", "documentation":"

Container for off-peak window options for the domain.

" }, "SoftwareUpdateOptions":{ "shape":"SoftwareUpdateOptionsStatus", "documentation":"

Software update options for the domain.

" } }, "documentation":"

Container for the configuration of an OpenSearch Service domain.

" }, "DomainEndpointOptions":{ "type":"structure", "members":{ "EnforceHTTPS":{ "shape":"Boolean", "documentation":"

True to require that all traffic to the domain arrive over HTTPS.

" }, "TLSSecurityPolicy":{ "shape":"TLSSecurityPolicy", "documentation":"

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

" }, "CustomEndpointEnabled":{ "shape":"Boolean", "documentation":"

Whether to enable a custom endpoint for the domain.

" }, "CustomEndpoint":{ "shape":"DomainNameFqdn", "documentation":"

The fully qualified URL for the custom endpoint.

" }, "CustomEndpointCertificateArn":{ "shape":"ARN", "documentation":"

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

" } }, "documentation":"

Options to configure a custom endpoint for an OpenSearch Service domain.

" }, "DomainEndpointOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"DomainEndpointOptions", "documentation":"

Options to configure the endpoint for a domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the endpoint options for a domain.

" } }, "documentation":"

The configured endpoint options for a domain and their current status.

" }, "DomainHealth":{ "type":"string", "enum":[ "Red", "Yellow", "Green", "NotAvailable" ] }, "DomainId":{ "type":"string", "documentation":"

Unique identifier for an OpenSearch Service domain.

", "max":64, "min":1 }, "DomainInfo":{ "type":"structure", "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

Name of the domain.

" }, "EngineType":{ "shape":"EngineType", "documentation":"

The type of search engine that the domain is running.`OpenSearch` for an OpenSearch engine, or `Elasticsearch` for a legacy Elasticsearch OSS engine.

" } }, "documentation":"

Information about an OpenSearch Service domain.

" }, "DomainInfoList":{ "type":"list", "member":{"shape":"DomainInfo"}, "documentation":"

Contains a list of information about a domain.

" }, "DomainInformationContainer":{ "type":"structure", "members":{ "AWSDomainInformation":{ "shape":"AWSDomainInformation", "documentation":"

Information about an Amazon OpenSearch Service domain.

" } }, "documentation":"

Container for information about an OpenSearch Service domain.

" }, "DomainMaintenanceDetails":{ "type":"structure", "members":{ "MaintenanceId":{ "shape":"RequestId", "documentation":"

The ID of the requested action.

" }, "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

" }, "Action":{ "shape":"MaintenanceType", "documentation":"

The name of the action.

" }, "NodeId":{ "shape":"NodeId", "documentation":"

The ID of the data node.

" }, "Status":{ "shape":"MaintenanceStatus", "documentation":"

The status of the action.

" }, "StatusMessage":{ "shape":"MaintenanceStatusMessage", "documentation":"

The status message for the action.

" }, "CreatedAt":{ "shape":"UpdateTimestamp", "documentation":"

The time at which the action was created.

" }, "UpdatedAt":{ "shape":"UpdateTimestamp", "documentation":"

The time at which the action was updated.

" } }, "documentation":"

Container for the domain maintenance details.

" }, "DomainMaintenanceList":{ "type":"list", "member":{"shape":"DomainMaintenanceDetails"} }, "DomainName":{ "type":"string", "documentation":"

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

", "max":28, "min":3, "pattern":"[a-z][a-z0-9\\-]+" }, "DomainNameFqdn":{ "type":"string", "max":255, "min":1, "pattern":"^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" }, "DomainNameList":{ "type":"list", "member":{"shape":"DomainName"}, "documentation":"

A list of OpenSearch Service domain names.

" }, "DomainNodesStatus":{ "type":"structure", "members":{ "NodeId":{ "shape":"NodeId", "documentation":"

The ID of the node.

" }, "NodeType":{ "shape":"NodeType", "documentation":"

Indicates whether the nodes is a data, master, or ultrawarm node.

" }, "AvailabilityZone":{ "shape":"AvailabilityZone", "documentation":"

The Availability Zone of the node.

" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"

The instance type information of the node.

" }, "NodeStatus":{ "shape":"NodeStatus", "documentation":"

Indicates if the node is active or in standby.

" }, "StorageType":{ "shape":"StorageTypeName", "documentation":"

Indicates if the node has EBS or instance storage.

" }, "StorageVolumeType":{ "shape":"VolumeType", "documentation":"

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.

" }, "StorageSize":{ "shape":"VolumeSize", "documentation":"

The storage size of the node, in GiB.

" } }, "documentation":"

Container for information about nodes on the domain.

" }, "DomainNodesStatusList":{ "type":"list", "member":{"shape":"DomainNodesStatus"}, "documentation":"

List of `DomainNodesStatus` with details about nodes on the requested domain.

" }, "DomainPackageDetails":{ "type":"structure", "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

Internal ID of the package.

" }, "PackageName":{ "shape":"PackageName", "documentation":"

User-specified name of the package.

" }, "PackageType":{ "shape":"PackageType", "documentation":"

The type of package.

" }, "LastUpdated":{ "shape":"LastUpdated", "documentation":"

Timestamp of the most recent update to the package association status.

" }, "DomainName":{ "shape":"DomainName", "documentation":"

Name of the domain that the package is associated with.

" }, "DomainPackageStatus":{ "shape":"DomainPackageStatus", "documentation":"

State of the association.

" }, "PackageVersion":{ "shape":"PackageVersion", "documentation":"

The current version of the package.

" }, "ReferencePath":{ "shape":"ReferencePath", "documentation":"

The relative path of the package on the OpenSearch Service cluster nodes. This is `synonym_path` when the package is for synonym files.

" }, "ErrorDetails":{ "shape":"ErrorDetails", "documentation":"

Additional information if the package is in an error state. Null otherwise.

" } }, "documentation":"

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

" }, "DomainPackageDetailsList":{ "type":"list", "member":{"shape":"DomainPackageDetails"} }, "DomainPackageStatus":{ "type":"string", "enum":[ "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED" ] }, "DomainState":{ "type":"string", "enum":[ "Active", "Processing", "NotAvailable" ] }, "DomainStatus":{ "type":"structure", "required":[ "DomainId", "DomainName", "ARN", "ClusterConfig" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"

Unique identifier for the domain.

" }, "DomainName":{ "shape":"DomainName", "documentation":"

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

" }, "ARN":{ "shape":"ARN", "documentation":"

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

" }, "Created":{ "shape":"Boolean", "documentation":"

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

" }, "Deleted":{ "shape":"Boolean", "documentation":"

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.

" }, "Endpoint":{ "shape":"ServiceUrl", "documentation":"

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

" }, "EndpointV2":{ "shape":"ServiceUrl", "documentation":"

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.

" }, "Endpoints":{ "shape":"EndpointsMap", "documentation":"

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example `key, value`: `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`.

" }, "Processing":{ "shape":"Boolean", "documentation":"

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

" }, "UpgradeProcessing":{ "shape":"Boolean", "documentation":"

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.

" }, "EngineVersion":{ "shape":"VersionString", "documentation":"

Version of OpenSearch or Elasticsearch that the domain is running, in the format `Elasticsearch_X.Y` or `OpenSearch_X.Y`.

" }, "ClusterConfig":{ "shape":"ClusterConfig", "documentation":"

Container for the cluster configuration of the domain.

" }, "EBSOptions":{ "shape":"EBSOptions", "documentation":"

Container for EBS-based storage settings for the domain.

" }, "AccessPolicies":{ "shape":"PolicyDocument", "documentation":"

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

" }, "IPAddressType":{ "shape":"IPAddressType", "documentation":"

The type of IP addresses supported by the endpoint for the domain.

" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

" }, "VPCOptions":{ "shape":"VPCDerivedInfo", "documentation":"

The VPC configuration for the domain.

" }, "CognitoOptions":{ "shape":"CognitoOptions", "documentation":"

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptions", "documentation":"

Encryption at rest settings for the domain.

" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"

Whether node-to-node encryption is enabled or disabled.

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

Key-value pairs that specify advanced configuration options.

" }, "LogPublishingOptions":{ "shape":"LogPublishingOptions", "documentation":"

Log publishing options for the domain.

" }, "ServiceSoftwareOptions":{ "shape":"ServiceSoftwareOptions", "documentation":"

The current status of the domain's service software.

" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", "documentation":"

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

" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptions", "documentation":"

Settings for fine-grained access control.

" }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsOutput", "documentation":"

Auto-Tune settings for the domain.

" }, "ChangeProgressDetails":{ "shape":"ChangeProgressDetails", "documentation":"

Information about a configuration change happening on the domain.

" }, "OffPeakWindowOptions":{ "shape":"OffPeakWindowOptions", "documentation":"

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

" }, "SoftwareUpdateOptions":{ "shape":"SoftwareUpdateOptions", "documentation":"

Service software update options for the domain.

" } }, "documentation":"

The current status of an OpenSearch Service domain.

" }, "DomainStatusList":{ "type":"list", "member":{"shape":"DomainStatus"}, "documentation":"

List that contains the status of each specified OpenSearch Service domain.

" }, "Double":{"type":"double"}, "DryRun":{"type":"boolean"}, "DryRunMode":{ "type":"string", "enum":[ "Basic", "Verbose" ] }, "DryRunProgressStatus":{ "type":"structure", "required":[ "DryRunId", "DryRunStatus", "CreationDate", "UpdateDate" ], "members":{ "DryRunId":{ "shape":"GUID", "documentation":"

The unique identifier of the dry run.

" }, "DryRunStatus":{ "shape":"String", "documentation":"

The current status of the dry run.

" }, "CreationDate":{ "shape":"String", "documentation":"

The timestamp when the dry run was initiated.

" }, "UpdateDate":{ "shape":"String", "documentation":"

The timestamp when the dry run was last updated.

" }, "ValidationFailures":{ "shape":"ValidationFailures", "documentation":"

Any validation failures that occurred as a result of the dry run.

" } }, "documentation":"

Information about the progress of a pre-upgrade dry run analysis.

" }, "DryRunResults":{ "type":"structure", "members":{ "DeploymentType":{ "shape":"DeploymentType", "documentation":"

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.

" }, "Message":{ "shape":"Message", "documentation":"

A message corresponding to the deployment type.

" } }, "documentation":"

Results of a dry run performed in an update domain request.

" }, "Duration":{ "type":"structure", "members":{ "Value":{ "shape":"DurationValue", "documentation":"

Integer to specify the value of a maintenance schedule duration.

" }, "Unit":{ "shape":"TimeUnit", "documentation":"

The unit of measurement for the duration of a maintenance schedule.

" } }, "documentation":"

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

" }, "DurationValue":{ "type":"long", "documentation":"

Integer that specifies the value of a maintenance schedule duration.

", "max":24, "min":1 }, "EBSOptions":{ "type":"structure", "members":{ "EBSEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

Specifies the type of EBS volumes attached to data nodes.

" }, "VolumeSize":{ "shape":"IntegerClass", "documentation":"

Specifies the size (in GiB) of EBS volumes attached to data nodes.

" }, "Iops":{ "shape":"IntegerClass", "documentation":"

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.

" }, "Throughput":{ "shape":"IntegerClass", "documentation":"

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the `gp3` volume type.

" } }, "documentation":"

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

" }, "EBSOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"EBSOptions", "documentation":"

The configured EBS options for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the EBS options for the specified domain.

" } }, "documentation":"

The status of the EBS options for the specified OpenSearch Service domain.

" }, "EncryptionAtRestOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True to enable encryption at rest.

" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`.

" } }, "documentation":"

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.

" }, "EncryptionAtRestOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"EncryptionAtRestOptions", "documentation":"

Encryption at rest options for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the encryption at rest options for the specified domain.

" } }, "documentation":"

Status of the encryption at rest options for the specified OpenSearch Service domain.

" }, "Endpoint":{ "type":"string", "pattern":"^[A-Za-z0-9\\-\\.]+$" }, "EndpointsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"ServiceUrl"} }, "EngineType":{ "type":"string", "enum":[ "OpenSearch", "Elasticsearch" ] }, "EngineVersion":{ "type":"string", "pattern":"^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$" }, "EnvironmentInfo":{ "type":"structure", "members":{ "AvailabilityZoneInformation":{ "shape":"AvailabilityZoneInfoList", "documentation":"

A list of `AvailabilityZoneInfo` for the domain.

" } }, "documentation":"

Information about the active domain environment.

" }, "EnvironmentInfoList":{ "type":"list", "member":{"shape":"EnvironmentInfo"} }, "ErrorDetails":{ "type":"structure", "members":{ "ErrorType":{ "shape":"ErrorType", "documentation":"

The type of error that occurred.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

A message describing the error.

" } }, "documentation":"

Additional information if the package is in an error state. Null otherwise.

" }, "ErrorMessage":{"type":"string"}, "ErrorType":{"type":"string"}, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"NonEmptyString", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more values for the filter.

" } }, "documentation":"

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.

" }, "FilterList":{ "type":"list", "member":{"shape":"Filter"} }, "GUID":{ "type":"string", "max":36, "min":36, "pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}" }, "GetCompatibleVersionsRequest":{ "type":"structure", "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of an existing domain. Provide this parameter to limit the results to a single domain.

", "location":"querystring", "locationName":"domainName" } }, "documentation":"

Container for the request parameters to `GetCompatibleVersions` operation.

" }, "GetCompatibleVersionsResponse":{ "type":"structure", "members":{ "CompatibleVersions":{ "shape":"CompatibleVersionsList", "documentation":"

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

" } }, "documentation":"

Container for the response returned by the `GetCompatibleVersions` operation.

" }, "GetDataSourceRequest":{ "type":"structure", "required":[ "DomainName", "Name" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "Name":{ "shape":"DataSourceName", "documentation":"

The name of the data source to get information about.

", "location":"uri", "locationName":"DataSourceName" } }, "documentation":"

Container for the parameters to the `GetDataSource` operation.

" }, "GetDataSourceResponse":{ "type":"structure", "members":{ "DataSourceType":{ "shape":"DataSourceType", "documentation":"

The type of data source.

" }, "Name":{ "shape":"DataSourceName", "documentation":"

The name of the data source.

" }, "Description":{ "shape":"DataSourceDescription", "documentation":"

A description of the data source.

" } }, "documentation":"

The result of a `GetDataSource` operation.

" }, "GetDomainMaintenanceStatusRequest":{ "type":"structure", "required":[ "DomainName", "MaintenanceId" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "MaintenanceId":{ "shape":"RequestId", "documentation":"

The request ID of the maintenance action.

", "location":"querystring", "locationName":"maintenanceId" } }, "documentation":"

Container for the parameters to the `GetDomainMaintenanceStatus` operation.

" }, "GetDomainMaintenanceStatusResponse":{ "type":"structure", "members":{ "Status":{ "shape":"MaintenanceStatus", "documentation":"

The status of the maintenance action.

" }, "StatusMessage":{ "shape":"MaintenanceStatusMessage", "documentation":"

The status message of the maintenance action.

" }, "NodeId":{ "shape":"NodeId", "documentation":"

The node ID of the maintenance action.

" }, "Action":{ "shape":"MaintenanceType", "documentation":"

The action name.

" }, "CreatedAt":{ "shape":"UpdateTimestamp", "documentation":"

The time at which the action was created.

" }, "UpdatedAt":{ "shape":"UpdateTimestamp", "documentation":"

The time at which the action was updated.

" } }, "documentation":"

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

" }, "GetPackageVersionHistoryRequest":{ "type":"structure", "required":["PackageID"], "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

The unique identifier of the package.

", "location":"uri", "locationName":"PackageID" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the request parameters to the `GetPackageVersionHistory` operation.

" }, "GetPackageVersionHistoryResponse":{ "type":"structure", "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

The unique identifier of the package.

" }, "PackageVersionHistoryList":{ "shape":"PackageVersionHistoryList", "documentation":"

A list of package versions, along with their creation time and commit message.

" }, "NextToken":{ "shape":"String", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

Container for response returned by `GetPackageVersionHistory` operation.

" }, "GetUpgradeHistoryRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of an existing domain.

", "location":"uri", "locationName":"DomainName" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the request parameters to the `GetUpgradeHistory` operation.

" }, "GetUpgradeHistoryResponse":{ "type":"structure", "members":{ "UpgradeHistories":{ "shape":"UpgradeHistoryList", "documentation":"

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

" }, "NextToken":{ "shape":"String", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

Container for the response returned by the `GetUpgradeHistory` operation.

" }, "GetUpgradeStatusRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The domain of the domain to get upgrade status information for.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the request parameters to the `GetUpgradeStatus` operation.

" }, "GetUpgradeStatusResponse":{ "type":"structure", "members":{ "UpgradeStep":{ "shape":"UpgradeStep", "documentation":"

One of three steps that an upgrade or upgrade eligibility check goes through.

" }, "StepStatus":{ "shape":"UpgradeStatus", "documentation":"

The status of the current step that an upgrade is on.

" }, "UpgradeName":{ "shape":"UpgradeName", "documentation":"

A string that describes the update.

" } }, "documentation":"

Container for the response returned by the `GetUpgradeStatus` operation.

" }, "IPAddressType":{ "type":"string", "enum":[ "ipv4", "dualstack" ] }, "IPAddressTypeStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"IPAddressType", "documentation":"

The IP address options for the domain.

" }, "Status":{"shape":"OptionStatus"} }, "documentation":"

The IP address type status for the domain.

" }, "IdentityPoolId":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+:[0-9a-f-]+" }, "InboundConnection":{ "type":"structure", "members":{ "LocalDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Information about the source (local) domain.

" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Information about the destination (remote) domain.

" }, "ConnectionId":{ "shape":"ConnectionId", "documentation":"

The unique identifier of the connection.

" }, "ConnectionStatus":{ "shape":"InboundConnectionStatus", "documentation":"

The current status of the connection.

" }, "ConnectionMode":{ "shape":"ConnectionMode", "documentation":"

The connection mode.

" } }, "documentation":"

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

" }, "InboundConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"InboundConnectionStatusCode", "documentation":"

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.

" }, "Message":{ "shape":"ConnectionStatusMessage", "documentation":"

Information about the connection.

" } }, "documentation":"

The status of an inbound cross-cluster connection for OpenSearch Service.

" }, "InboundConnectionStatusCode":{ "type":"string", "enum":[ "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED" ] }, "InboundConnections":{ "type":"list", "member":{"shape":"InboundConnection"} }, "InstanceCount":{ "type":"integer", "documentation":"

Number of instances in an OpenSearch Service cluster.

", "min":1 }, "InstanceCountLimits":{ "type":"structure", "members":{ "MinimumInstanceCount":{ "shape":"MinimumInstanceCount", "documentation":"

The maximum allowed number of instances.

" }, "MaximumInstanceCount":{ "shape":"MaximumInstanceCount", "documentation":"

The minimum allowed number of instances.

" } }, "documentation":"

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

" }, "InstanceLimits":{ "type":"structure", "members":{ "InstanceCountLimits":{ "shape":"InstanceCountLimits", "documentation":"

Limits on the number of instances that can be created for a given instance type.

" } }, "documentation":"

Instance-related attributes that are available for a given instance type.

" }, "InstanceRole":{"type":"string"}, "InstanceRoleList":{ "type":"list", "member":{"shape":"InstanceRole"} }, "InstanceTypeDetails":{ "type":"structure", "members":{ "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"

The instance type.

" }, "EncryptionEnabled":{ "shape":"Boolean", "documentation":"

Whether encryption at rest and node-to-node encryption are supported for the instance type.

" }, "CognitoEnabled":{ "shape":"Boolean", "documentation":"

Whether Amazon Cognito access is supported for the instance type.

" }, "AppLogsEnabled":{ "shape":"Boolean", "documentation":"

Whether logging is supported for the instance type.

" }, "AdvancedSecurityEnabled":{ "shape":"Boolean", "documentation":"

Whether fine-grained access control is supported for the instance type.

" }, "WarmEnabled":{ "shape":"Boolean", "documentation":"

Whether UltraWarm is supported for the instance type.

" }, "InstanceRole":{ "shape":"InstanceRoleList", "documentation":"

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

" }, "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

The supported Availability Zones for the instance type.

" } }, "documentation":"

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

" }, "InstanceTypeDetailsList":{ "type":"list", "member":{"shape":"InstanceTypeDetails"} }, "InstanceTypeString":{ "type":"string", "max":40, "min":10, "pattern":"^.*\\..*\\.search$" }, "Integer":{"type":"integer"}, "IntegerClass":{"type":"integer"}, "InternalException":{ "type":"structure", "members":{ }, "documentation":"

Request processing failed because of an unknown error, exception, or internal failure.

", "error":{"httpStatusCode":500}, "exception":true }, "InvalidPaginationTokenException":{ "type":"structure", "members":{ }, "documentation":"

Request processing failed because you provided an invalid pagination token.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidTypeException":{ "type":"structure", "members":{ }, "documentation":"

An exception for trying to create or access a sub-resource that's either invalid or not supported.

", "error":{"httpStatusCode":409}, "exception":true }, "Issue":{"type":"string"}, "Issues":{ "type":"list", "member":{"shape":"Issue"} }, "KmsKeyId":{ "type":"string", "max":500, "min":1, "pattern":".*" }, "LastUpdated":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

An exception for trying to create more than the allowed number of resources or sub-resources.

", "error":{"httpStatusCode":409}, "exception":true }, "LimitName":{"type":"string"}, "LimitValue":{"type":"string"}, "LimitValueList":{ "type":"list", "member":{"shape":"LimitValue"} }, "Limits":{ "type":"structure", "members":{ "StorageTypes":{ "shape":"StorageTypeList", "documentation":"

Storage-related attributes that are available for a given instance type.

" }, "InstanceLimits":{ "shape":"InstanceLimits", "documentation":"

The limits for a given instance type.

" }, "AdditionalLimits":{ "shape":"AdditionalLimitList", "documentation":"

List of additional limits that are specific to a given instance type for each of its instance roles.

" } }, "documentation":"

Limits for a given instance type and for each of its roles.

" }, "LimitsByRole":{ "type":"map", "key":{"shape":"InstanceRole"}, "value":{"shape":"Limits"}, "documentation":"

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

- data - A data node.

- master - A dedicated master node.

- ultra_warm - An UltraWarm node.

" }, "ListDataSourcesRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the `ListDataSources` operation.

" }, "ListDataSourcesResponse":{ "type":"structure", "members":{ "DataSources":{ "shape":"DataSourceList", "documentation":"

A list of data sources associated with specified domain.

" } }, "documentation":"

The result of a `ListDataSources` operation.

" }, "ListDomainMaintenancesRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "Action":{ "shape":"MaintenanceType", "documentation":"

The name of the action.

", "location":"querystring", "locationName":"action" }, "Status":{ "shape":"MaintenanceStatus", "documentation":"

The status of the action.

", "location":"querystring", "locationName":"status" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the parameters to the `ListDomainMaintenances` operation.

" }, "ListDomainMaintenancesResponse":{ "type":"structure", "members":{ "DomainMaintenances":{ "shape":"DomainMaintenanceList", "documentation":"

A list of the submitted maintenance actions.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

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

" }, "ListDomainNamesRequest":{ "type":"structure", "members":{ "EngineType":{ "shape":"EngineType", "documentation":"

Filters the output by domain engine type.

", "location":"querystring", "locationName":"engineType" } }, "documentation":"

Container for the parameters to the `ListDomainNames` operation.

" }, "ListDomainNamesResponse":{ "type":"structure", "members":{ "DomainNames":{ "shape":"DomainInfoList", "documentation":"

The names of all OpenSearch Service domains owned by the current user and their respective engine types.

" } }, "documentation":"

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

" }, "ListDomainsForPackageRequest":{ "type":"structure", "required":["PackageID"], "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

The unique identifier of the package for which to list associated domains.

", "location":"uri", "locationName":"PackageID" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the request parameters to the `ListDomainsForPackage` operation.

" }, "ListDomainsForPackageResponse":{ "type":"structure", "members":{ "DomainPackageDetailsList":{ "shape":"DomainPackageDetailsList", "documentation":"

Information about all domains associated with a package.

" }, "NextToken":{ "shape":"String", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

Container for the response parameters to the `ListDomainsForPackage` operation.

" }, "ListInstanceTypeDetailsRequest":{ "type":"structure", "required":["EngineVersion"], "members":{ "EngineVersion":{ "shape":"VersionString", "documentation":"

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

", "location":"uri", "locationName":"EngineVersion" }, "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"querystring", "locationName":"domainName" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "RetrieveAZs":{ "shape":"Boolean", "documentation":"

An optional parameter that specifies the Availability Zones for the domain.

", "location":"querystring", "locationName":"retrieveAZs" }, "InstanceType":{ "shape":"InstanceTypeString", "documentation":"

An optional parameter that lists information for a given instance type.

", "location":"querystring", "locationName":"instanceType" } } }, "ListInstanceTypeDetailsResponse":{ "type":"structure", "members":{ "InstanceTypeDetails":{ "shape":"InstanceTypeDetailsList", "documentation":"

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } } }, "ListPackagesForDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain for which you want to list associated packages.

", "location":"uri", "locationName":"DomainName" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the request parameters to the `ListPackagesForDomain` operation.

" }, "ListPackagesForDomainResponse":{ "type":"structure", "members":{ "DomainPackageDetailsList":{ "shape":"DomainPackageDetailsList", "documentation":"

List of all packages associated with a domain.

" }, "NextToken":{ "shape":"String", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

Container for the response parameters to the `ListPackagesForDomain` operation.

" }, "ListScheduledActionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListScheduledActionsResponse":{ "type":"structure", "members":{ "ScheduledActions":{ "shape":"ScheduledActionsList", "documentation":"

A list of actions that are scheduled for the domain.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } } }, "ListTagsRequest":{ "type":"structure", "required":["ARN"], "members":{ "ARN":{ "shape":"ARN", "documentation":"

Amazon Resource Name (ARN) for the domain to view tags for.

", "location":"querystring", "locationName":"arn" } }, "documentation":"

Container for the parameters to the `ListTags` operation.

" }, "ListTagsResponse":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

List of resource tags associated with the specified domain.

" } }, "documentation":"

The results of a `ListTags` operation.

" }, "ListVersionsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for the request parameters to the `ListVersions` operation.

" }, "ListVersionsResponse":{ "type":"structure", "members":{ "Versions":{ "shape":"VersionList", "documentation":"

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } }, "documentation":"

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

" }, "ListVpcEndpointAccessRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the OpenSearch Service domain to retrieve access information for.

", "location":"uri", "locationName":"DomainName" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListVpcEndpointAccessResponse":{ "type":"structure", "required":[ "AuthorizedPrincipalList", "NextToken" ], "members":{ "AuthorizedPrincipalList":{ "shape":"AuthorizedPrincipalList", "documentation":"

A list of IAM principals that can currently access the domain.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } } }, "ListVpcEndpointsForDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain to list associated VPC endpoints for.

", "location":"uri", "locationName":"DomainName" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListVpcEndpointsForDomainResponse":{ "type":"structure", "required":[ "VpcEndpointSummaryList", "NextToken" ], "members":{ "VpcEndpointSummaryList":{ "shape":"VpcEndpointSummaryList", "documentation":"

Information about each endpoint associated with the domain.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } } }, "ListVpcEndpointsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListVpcEndpointsResponse":{ "type":"structure", "required":[ "VpcEndpointSummaryList", "NextToken" ], "members":{ "VpcEndpointSummaryList":{ "shape":"VpcEndpointSummaryList", "documentation":"

Information about each endpoint.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" } } }, "LogPublishingOption":{ "type":"structure", "members":{ "CloudWatchLogsLogGroupArn":{ "shape":"CloudWatchLogsLogGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

" }, "Enabled":{ "shape":"Boolean", "documentation":"

Whether the log should be published.

" } }, "documentation":"

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.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

" }, "LogPublishingOptions":{ "type":"map", "key":{"shape":"LogType"}, "value":{"shape":"LogPublishingOption"} }, "LogPublishingOptionsStatus":{ "type":"structure", "members":{ "Options":{ "shape":"LogPublishingOptions", "documentation":"

The log publishing options configured for the domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the log publishing options for the domain.

" } }, "documentation":"

The configured log publishing options for the domain and their current status.

" }, "LogType":{ "type":"string", "documentation":"

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.

", "enum":[ "INDEX_SLOW_LOGS", "SEARCH_SLOW_LOGS", "ES_APPLICATION_LOGS", "AUDIT_LOGS" ] }, "Long":{"type":"long"}, "MaintenanceStatus":{ "type":"string", "enum":[ "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED", "TIMED_OUT" ] }, "MaintenanceStatusMessage":{ "type":"string", "max":1000, "min":0, "pattern":"^([\\s\\S]*)$" }, "MaintenanceType":{ "type":"string", "enum":[ "REBOOT_NODE", "RESTART_SEARCH_PROCESS", "RESTART_DASHBOARD" ] }, "MasterNodeStatus":{ "type":"string", "enum":[ "Available", "UnAvailable" ] }, "MasterUserOptions":{ "type":"structure", "members":{ "MasterUserARN":{ "shape":"ARN", "documentation":"

Amazon Resource Name (ARN) for the master user. Only specify if `InternalUserDatabaseEnabled` is `false`.

" }, "MasterUserName":{ "shape":"Username", "documentation":"

User name for the master user. Only specify if `InternalUserDatabaseEnabled` is `true`.

" }, "MasterUserPassword":{ "shape":"Password", "documentation":"

Password for the master user. Only specify if `InternalUserDatabaseEnabled` is `true`.

" } }, "documentation":"

Credentials for the master user for a domain.

" }, "MaxResults":{ "type":"integer", "documentation":"

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

", "max":100 }, "MaximumInstanceCount":{ "type":"integer", "documentation":"

Maximum number of instances that can be instantiated for a given instance type.

" }, "Message":{ "type":"string", "max":1024, "min":0 }, "MinimumInstanceCount":{ "type":"integer", "documentation":"

Minimum number of instances that can be instantiated for a given instance type.

" }, "NextToken":{ "type":"string", "documentation":"

When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" }, "NodeId":{ "type":"string", "max":40, "min":10 }, "NodeStatus":{ "type":"string", "enum":[ "Active", "StandBy", "NotAvailable" ] }, "NodeToNodeEncryptionOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True to enable node-to-node encryption.

" } }, "documentation":"

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

" }, "NodeToNodeEncryptionOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"

The node-to-node encryption options for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the node-to-node encryption options for the specified domain.

" } }, "documentation":"

Status of the node-to-node encryption options for the specified domain.

" }, "NodeType":{ "type":"string", "enum":[ "Data", "Ultrawarm", "Master" ] }, "NonEmptyString":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9\\-\\_\\.]+" }, "NumberOfAZs":{ "type":"string", "pattern":"^((\\d+)|(NotAvailable))$" }, "NumberOfNodes":{ "type":"string", "pattern":"^((\\d+)|(NotAvailable))$" }, "NumberOfShards":{ "type":"string", "pattern":"^((\\d+)|(NotAvailable))$" }, "OffPeakWindow":{ "type":"structure", "members":{ "WindowStartTime":{ "shape":"WindowStartTime", "documentation":"

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.

" } }, "documentation":"

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.

" }, "OffPeakWindowOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

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.

" }, "OffPeakWindow":{ "shape":"OffPeakWindow", "documentation":"

Off-peak window settings for the domain.

" } }, "documentation":"

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

" }, "OffPeakWindowOptionsStatus":{ "type":"structure", "members":{ "Options":{ "shape":"OffPeakWindowOptions", "documentation":"

The domain's off-peak window configuration.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The current status of off-peak window options.

" } }, "documentation":"

The status of off-peak window options for a domain.

" }, "OpenSearchPartitionInstanceType":{ "type":"string", "enum":[ "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search" ] }, "OpenSearchWarmPartitionInstanceType":{ "type":"string", "enum":[ "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search" ] }, "OptionState":{ "type":"string", "documentation":"

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.

", "enum":[ "RequiresIndexDocuments", "Processing", "Active" ] }, "OptionStatus":{ "type":"structure", "required":[ "CreationDate", "UpdateDate", "State" ], "members":{ "CreationDate":{ "shape":"UpdateTimestamp", "documentation":"

The timestamp when the entity was created.

" }, "UpdateDate":{ "shape":"UpdateTimestamp", "documentation":"

The timestamp of the last time the entity was updated.

" }, "UpdateVersion":{ "shape":"UIntValue", "documentation":"

The latest version of the entity.

" }, "State":{ "shape":"OptionState", "documentation":"

The state of the entity.

" }, "PendingDeletion":{ "shape":"Boolean", "documentation":"

Indicates whether the entity is being deleted.

" } }, "documentation":"

Provides the current status of an entity.

" }, "OutboundConnection":{ "type":"structure", "members":{ "LocalDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Information about the source (local) domain.

" }, "RemoteDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"

Information about the destination (remote) domain.

" }, "ConnectionId":{ "shape":"ConnectionId", "documentation":"

Unique identifier of the connection.

" }, "ConnectionAlias":{ "shape":"ConnectionAlias", "documentation":"

Name of the connection.

" }, "ConnectionStatus":{ "shape":"OutboundConnectionStatus", "documentation":"

Status of the connection.

" }, "ConnectionMode":{ "shape":"ConnectionMode", "documentation":"

The connection mode.

" }, "ConnectionProperties":{ "shape":"ConnectionProperties", "documentation":"

Properties for the outbound connection.

" } }, "documentation":"

Specifies details about an outbound cross-cluster connection.

" }, "OutboundConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"OutboundConnectionStatusCode", "documentation":"

The status code for the outbound connection. Can be one of the following:

- VALIDATING - The outbound connection request is being validated.

- VALIDATION_FAILED - Validation failed for the connection request.

- PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.

- APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.

- PROVISIONING - Outbound connection request is in process.

- ACTIVE - Outbound connection is active and ready to use.

- REJECTING - Outbound connection rejection by remote domain owner is in progress.

- REJECTED - Outbound connection request is rejected by remote domain owner.

- DELETING - Outbound connection deletion is in progress.

- DELETED - Outbound connection is deleted and can no longer be used.

" }, "Message":{ "shape":"ConnectionStatusMessage", "documentation":"

Verbose information for the outbound connection.

" } }, "documentation":"

The status of an outbound cross-cluster connection.

" }, "OutboundConnectionStatusCode":{ "type":"string", "enum":[ "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED" ] }, "OutboundConnections":{ "type":"list", "member":{"shape":"OutboundConnection"} }, "OverallChangeStatus":{ "type":"string", "documentation":"

The overall status value of the domain configuration change.

", "enum":[ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "OwnerId":{ "type":"string", "max":12, "min":12, "pattern":"[0-9]+" }, "PackageDescription":{ "type":"string", "max":1024 }, "PackageDetails":{ "type":"structure", "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

The unique identifier of the package.

" }, "PackageName":{ "shape":"PackageName", "documentation":"

The user-specified name of the package.

" }, "PackageType":{ "shape":"PackageType", "documentation":"

The type of package.

" }, "PackageDescription":{ "shape":"PackageDescription", "documentation":"

User-specified description of the package.

" }, "PackageStatus":{ "shape":"PackageStatus", "documentation":"

The current status of the package. The available options are `AVAILABLE`, `COPYING`, `COPY_FAILED`, `VALIDATNG`, `VALIDATION_FAILED`, `DELETING`, and `DELETE_FAILED`.

" }, "CreatedAt":{ "shape":"CreatedAt", "documentation":"

The timestamp when the package was created.

" }, "LastUpdatedAt":{ "shape":"LastUpdated", "documentation":"

Date and time when the package was last updated.

" }, "AvailablePackageVersion":{ "shape":"PackageVersion", "documentation":"

The package version.

" }, "ErrorDetails":{ "shape":"ErrorDetails", "documentation":"

Additional information if the package is in an error state. Null otherwise.

" }, "EngineVersion":{ "shape":"EngineVersion", "documentation":"

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

" }, "AvailablePluginProperties":{ "shape":"PluginProperties", "documentation":"

If the package is a `ZIP-PLUGIN` package, additional information about plugin properties.

" } }, "documentation":"

Basic information about a package.

" }, "PackageDetailsList":{ "type":"list", "member":{"shape":"PackageDetails"} }, "PackageID":{ "type":"string", "pattern":"^([FG][0-9]+)$" }, "PackageName":{ "type":"string", "max":256, "min":3, "pattern":"[a-z][a-z0-9\\-]+" }, "PackageSource":{ "type":"structure", "members":{ "S3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the Amazon S3 bucket containing the package.

" }, "S3Key":{ "shape":"S3Key", "documentation":"

Key (file name) of the package.

" } }, "documentation":"

The Amazon S3 location to import the package from.

" }, "PackageStatus":{ "type":"string", "enum":[ "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED" ] }, "PackageType":{ "type":"string", "enum":[ "TXT-DICTIONARY", "ZIP-PLUGIN" ] }, "PackageVersion":{"type":"string"}, "PackageVersionHistory":{ "type":"structure", "members":{ "PackageVersion":{ "shape":"PackageVersion", "documentation":"

The package version.

" }, "CommitMessage":{ "shape":"CommitMessage", "documentation":"

A message associated with the package version when it was uploaded.

" }, "CreatedAt":{ "shape":"CreatedAt", "documentation":"

The date and time when the package was created.

" }, "PluginProperties":{ "shape":"PluginProperties", "documentation":"

Additional information about plugin properties if the package is a `ZIP-PLUGIN` package.

" } }, "documentation":"

Details about a package version.

" }, "PackageVersionHistoryList":{ "type":"list", "member":{"shape":"PackageVersionHistory"} }, "Password":{ "type":"string", "max":128, "min":8, "pattern":".*", "sensitive":true }, "PluginClassName":{ "type":"string", "max":1024 }, "PluginDescription":{ "type":"string", "max":1024 }, "PluginName":{ "type":"string", "max":1024 }, "PluginProperties":{ "type":"structure", "members":{ "Name":{ "shape":"PluginName", "documentation":"

The name of the plugin.

" }, "Description":{ "shape":"PluginDescription", "documentation":"

The description of the plugin.

" }, "Version":{ "shape":"PluginVersion", "documentation":"

The version of the plugin.

" }, "ClassName":{ "shape":"PluginClassName", "documentation":"

The name of the class to load.

" }, "UncompressedSizeInBytes":{ "shape":"UncompressedPluginSizeInBytes", "documentation":"

The uncompressed size of the plugin.

" } }, "documentation":"

Basic information about the plugin.

" }, "PluginVersion":{ "type":"string", "max":1024 }, "PolicyDocument":{ "type":"string", "documentation":"

Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.

", "max":102400, "min":0, "pattern":".*" }, "PrincipalType":{ "type":"string", "enum":[ "AWS_ACCOUNT", "AWS_SERVICE" ] }, "PurchaseReservedInstanceOfferingRequest":{ "type":"structure", "required":[ "ReservedInstanceOfferingId", "ReservationName" ], "members":{ "ReservedInstanceOfferingId":{ "shape":"GUID", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "ReservationName":{ "shape":"ReservationToken", "documentation":"

A customer-specified identifier to track this reservation.

" }, "InstanceCount":{ "shape":"InstanceCount", "documentation":"

The number of OpenSearch instances to reserve.

" } }, "documentation":"

Container for request parameters to the `PurchaseReservedInstanceOffering` operation.

" }, "PurchaseReservedInstanceOfferingResponse":{ "type":"structure", "members":{ "ReservedInstanceId":{ "shape":"GUID", "documentation":"

The ID of the Reserved Instance offering that was purchased.

" }, "ReservationName":{ "shape":"ReservationToken", "documentation":"

The customer-specified identifier used to track this reservation.

" } }, "documentation":"

Represents the output of a `PurchaseReservedInstanceOffering` operation.

" }, "RecurringCharge":{ "type":"structure", "members":{ "RecurringChargeAmount":{ "shape":"Double", "documentation":"

The monetary amount of the recurring charge.

" }, "RecurringChargeFrequency":{ "shape":"String", "documentation":"

The frequency of the recurring charge.

" } }, "documentation":"

Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

" }, "RecurringChargeList":{ "type":"list", "member":{"shape":"RecurringCharge"} }, "ReferencePath":{"type":"string"}, "Region":{ "type":"string", "max":30, "min":5, "pattern":"[a-z][a-z0-9\\-]+" }, "RejectInboundConnectionRequest":{ "type":"structure", "required":["ConnectionId"], "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"

The unique identifier of the inbound connection to reject.

", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"

Container for the request parameters to the `RejectInboundConnection` operation.

" }, "RejectInboundConnectionResponse":{ "type":"structure", "members":{ "Connection":{ "shape":"InboundConnection", "documentation":"

Contains details about the rejected inbound connection.

" } }, "documentation":"

Represents the output of a `RejectInboundConnection` operation.

" }, "RemoveTagsRequest":{ "type":"structure", "required":[ "ARN", "TagKeys" ], "members":{ "ARN":{ "shape":"ARN", "documentation":"

The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

" }, "TagKeys":{ "shape":"StringList", "documentation":"

The list of tag keys to remove from the domain.

" } }, "documentation":"

Container for the request parameters to the `RemoveTags` operation.

" }, "RequestId":{ "type":"string", "max":100, "min":1, "pattern":"^([\\s\\S]*)$" }, "ReservationToken":{ "type":"string", "max":64, "min":5, "pattern":".*" }, "ReservedInstance":{ "type":"structure", "members":{ "ReservationName":{ "shape":"ReservationToken", "documentation":"

The customer-specified identifier to track this reservation.

" }, "ReservedInstanceId":{ "shape":"GUID", "documentation":"

The unique identifier for the reservation.

" }, "BillingSubscriptionId":{ "shape":"Long", "documentation":"

The unique identifier of the billing subscription.

" }, "ReservedInstanceOfferingId":{ "shape":"String", "documentation":"

The unique identifier of the Reserved Instance offering.

" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"

The OpenSearch instance type offered by theReserved Instance offering.

" }, "StartTime":{ "shape":"UpdateTimestamp", "documentation":"

The date and time when the reservation was purchased.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration, in seconds, for which the OpenSearch instance is reserved.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly rate at which you're charged for the domain using this Reserved Instance.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the offering.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of OpenSearch instances that have been reserved.

" }, "State":{ "shape":"String", "documentation":"

The state of the Reserved Instance.

" }, "PaymentOption":{ "shape":"ReservedInstancePaymentOption", "documentation":"

The payment option as defined in the Reserved Instance offering.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

" } }, "documentation":"

Details of an OpenSearch Reserved Instance.

" }, "ReservedInstanceList":{ "type":"list", "member":{"shape":"ReservedInstance"} }, "ReservedInstanceOffering":{ "type":"structure", "members":{ "ReservedInstanceOfferingId":{ "shape":"GUID", "documentation":"

The unique identifier of the Reserved Instance offering.

" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"

The OpenSearch instance type offered by the Reserved Instance offering.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly rate at which you're charged for the domain using this Reserved Instance.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the Reserved Instance offering.

" }, "PaymentOption":{ "shape":"ReservedInstancePaymentOption", "documentation":"

Payment option for the Reserved Instance offering

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring charge to your account, regardless of whether you creates any domains using the offering.

" } }, "documentation":"

Details of an OpenSearch Reserved Instance offering.

" }, "ReservedInstanceOfferingList":{ "type":"list", "member":{"shape":"ReservedInstanceOffering"} }, "ReservedInstancePaymentOption":{ "type":"string", "enum":[ "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT" ] }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

An exception for creating a resource that already exists.

", "error":{"httpStatusCode":409}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

An exception for accessing or deleting a resource that doesn't exist.

", "error":{"httpStatusCode":409}, "exception":true }, "RevokeVpcEndpointAccessRequest":{ "type":"structure", "required":[ "DomainName", "Account" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the OpenSearch Service domain.

", "location":"uri", "locationName":"DomainName" }, "Account":{ "shape":"AWSAccount", "documentation":"

The account ID to revoke access from.

" } } }, "RevokeVpcEndpointAccessResponse":{ "type":"structure", "members":{ } }, "RoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*" }, "RollbackOnDisable":{ "type":"string", "documentation":"

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

", "enum":[ "NO_ROLLBACK", "DEFAULT_ROLLBACK" ] }, "S3BucketName":{ "type":"string", "max":63, "min":3 }, "S3GlueDataCatalog":{ "type":"structure", "members":{ "RoleArn":{ "shape":"RoleArn", "documentation":"

>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

" } }, "documentation":"

Information about the Amazon S3 Glue Data Catalog.

" }, "S3Key":{ "type":"string", "max":1024, "min":1 }, "SAMLEntityId":{ "type":"string", "max":512, "min":8 }, "SAMLIdp":{ "type":"structure", "required":[ "MetadataContent", "EntityId" ], "members":{ "MetadataContent":{ "shape":"SAMLMetadata", "documentation":"

The metadata of the SAML application, in XML format.

" }, "EntityId":{ "shape":"SAMLEntityId", "documentation":"

The unique entity ID of the application in the SAML identity provider.

" } }, "documentation":"

The SAML identity povider information.

" }, "SAMLMetadata":{ "type":"string", "max":1048576, "min":1 }, "SAMLOptionsInput":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True to enable SAML authentication for a domain.

" }, "Idp":{ "shape":"SAMLIdp", "documentation":"

The SAML Identity Provider's information.

" }, "MasterUserName":{ "shape":"Username", "documentation":"

The SAML master user name, which is stored in the domain's internal user database.

" }, "MasterBackendRole":{ "shape":"BackendRole", "documentation":"

The backend role that the SAML master user is mapped to.

" }, "SubjectKey":{ "shape":"String", "documentation":"

Element of the SAML assertion to use for the user name. Default is `NameID`.

" }, "RolesKey":{ "shape":"String", "documentation":"

Element of the SAML assertion to use for backend roles. Default is `roles`.

" }, "SessionTimeoutMinutes":{ "shape":"IntegerClass", "documentation":"

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

" } }, "documentation":"

The SAML authentication configuration for an Amazon OpenSearch Service domain.

" }, "SAMLOptionsOutput":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True if SAML is enabled.

" }, "Idp":{ "shape":"SAMLIdp", "documentation":"

Describes the SAML identity provider's information.

" }, "SubjectKey":{ "shape":"String", "documentation":"

The key used for matching the SAML subject attribute.

" }, "RolesKey":{ "shape":"String", "documentation":"

The key used for matching the SAML roles attribute.

" }, "SessionTimeoutMinutes":{ "shape":"IntegerClass", "documentation":"

The duration, in minutes, after which a user session becomes inactive.

" } }, "documentation":"

Describes the SAML application configured for the domain.

" }, "ScheduleAt":{ "type":"string", "enum":[ "NOW", "TIMESTAMP", "OFF_PEAK_WINDOW" ] }, "ScheduledAction":{ "type":"structure", "required":[ "Id", "Type", "Severity", "ScheduledTime" ], "members":{ "Id":{ "shape":"String", "documentation":"

The unique identifier of the scheduled action.

" }, "Type":{ "shape":"ActionType", "documentation":"

The type of action that will be taken on the domain.

" }, "Severity":{ "shape":"ActionSeverity", "documentation":"

The severity of the action.

" }, "ScheduledTime":{ "shape":"Long", "documentation":"

The time when the change is scheduled to happen.

" }, "Description":{ "shape":"String", "documentation":"

A description of the action to be taken.

" }, "ScheduledBy":{ "shape":"ScheduledBy", "documentation":"

Whether the action was scheduled manually (`CUSTOMER`, or by OpenSearch Service automatically (`SYSTEM`).

" }, "Status":{ "shape":"ActionStatus", "documentation":"

The current status of the scheduled action.

" }, "Mandatory":{ "shape":"Boolean", "documentation":"

Whether the action is required or optional.

" }, "Cancellable":{ "shape":"Boolean", "documentation":"

Whether or not the scheduled action is cancellable.

" } }, "documentation":"

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

" }, "ScheduledActionsList":{ "type":"list", "member":{"shape":"ScheduledAction"} }, "ScheduledAutoTuneActionType":{ "type":"string", "documentation":"

The Auto-Tune action type.

", "enum":[ "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING" ] }, "ScheduledAutoTuneDescription":{ "type":"string", "documentation":"

The description of an Auto-Tune maintenance action that occurs on a domain.

" }, "ScheduledAutoTuneDetails":{ "type":"structure", "members":{ "Date":{ "shape":"AutoTuneDate", "documentation":"

The date and time when the Auto-Tune action is scheduled for the domain.

" }, "ActionType":{ "shape":"ScheduledAutoTuneActionType", "documentation":"

The type of Auto-Tune action.

" }, "Action":{ "shape":"ScheduledAutoTuneDescription", "documentation":"

A description of the Auto-Tune action.

" }, "Severity":{ "shape":"ScheduledAutoTuneSeverityType", "documentation":"

The severity of the Auto-Tune action. Valid values are `LOW`, `MEDIUM`, and `HIGH`.

" } }, "documentation":"

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

" }, "ScheduledAutoTuneSeverityType":{ "type":"string", "documentation":"

The Auto-Tune action severity.

", "enum":[ "LOW", "MEDIUM", "HIGH" ] }, "ScheduledBy":{ "type":"string", "enum":[ "CUSTOMER", "SYSTEM" ] }, "ServiceSoftwareOptions":{ "type":"structure", "members":{ "CurrentVersion":{ "shape":"String", "documentation":"

The current service software version present on the domain.

" }, "NewVersion":{ "shape":"String", "documentation":"

The new service software version, if one is available.

" }, "UpdateAvailable":{ "shape":"Boolean", "documentation":"

True if you're able to update your service software version. False if you can't update your service software version.

" }, "Cancellable":{ "shape":"Boolean", "documentation":"

True if you're able to cancel your service software version update. False if you can't cancel your service software update.

" }, "UpdateStatus":{ "shape":"DeploymentStatus", "documentation":"

The status of your service software update.

" }, "Description":{ "shape":"String", "documentation":"

A description of the service software update status.

" }, "AutomatedUpdateDate":{ "shape":"DeploymentCloseDateTimeStamp", "documentation":"

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

" }, "OptionalDeployment":{ "shape":"Boolean", "documentation":"

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

" } }, "documentation":"

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

" }, "ServiceUrl":{ "type":"string", "documentation":"

The domain endpoint to which index and search requests are submitted. For example, `search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com` or `doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com`.

" }, "SkipUnavailableStatus":{ "type":"string", "documentation":"

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.

", "enum":[ "ENABLED", "DISABLED" ] }, "SlotList":{ "type":"list", "member":{"shape":"Long"} }, "SlotNotAvailableException":{ "type":"structure", "members":{ "SlotSuggestions":{ "shape":"SlotList", "documentation":"

Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.

" } }, "documentation":"

An exception for attempting to schedule a domain action during an unavailable time slot.

", "error":{"httpStatusCode":409}, "exception":true }, "SnapshotOptions":{ "type":"structure", "members":{ "AutomatedSnapshotStartHour":{ "shape":"IntegerClass", "documentation":"

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is `0` hours.

" } }, "documentation":"

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is `0` hours.

" }, "SnapshotOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"SnapshotOptions", "documentation":"

The daily snapshot options specified for the domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of a daily automated snapshot.

" } }, "documentation":"

Container for information about a daily automated snapshot for an OpenSearch Service domain.

" }, "SoftwareUpdateOptions":{ "type":"structure", "members":{ "AutoSoftwareUpdateEnabled":{ "shape":"Boolean", "documentation":"

Whether automatic service software updates are enabled for the domain.

" } }, "documentation":"

Options for configuring service software updates for a domain.

" }, "SoftwareUpdateOptionsStatus":{ "type":"structure", "members":{ "Options":{ "shape":"SoftwareUpdateOptions", "documentation":"

The service software update options for a domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of service software update options, including creation date and last updated date.

" } }, "documentation":"

The status of the service software options for a domain.

" }, "StartAt":{"type":"timestamp"}, "StartDomainMaintenanceRequest":{ "type":"structure", "required":[ "DomainName", "Action" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "Action":{ "shape":"MaintenanceType", "documentation":"

The name of the action.

" }, "NodeId":{ "shape":"NodeId", "documentation":"

The ID of the data node.

" } }, "documentation":"

Container for the parameters to the `StartDomainMaintenance` operation.

" }, "StartDomainMaintenanceResponse":{ "type":"structure", "members":{ "MaintenanceId":{ "shape":"RequestId", "documentation":"

The request ID of requested action.

" } }, "documentation":"

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

" }, "StartServiceSoftwareUpdateRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain that you want to update to the latest service software.

" }, "ScheduleAt":{ "shape":"ScheduleAt", "documentation":"

When to start the service software update.

- `NOW` - Immediately schedules the update to happen in the current hour if there's capacity available.

- `TIMESTAMP` - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for `DesiredStartTime`.

- `OFF_PEAK_WINDOW` - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: `NOW` if you don't specify a value for `DesiredStartTime`, and `TIMESTAMP` if you do.

" }, "DesiredStartTime":{ "shape":"Long", "documentation":"

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

" } }, "documentation":"

Container for the request parameters to the `StartServiceSoftwareUpdate` operation.

" }, "StartServiceSoftwareUpdateResponse":{ "type":"structure", "members":{ "ServiceSoftwareOptions":{ "shape":"ServiceSoftwareOptions", "documentation":"

The current status of the OpenSearch Service software update.

" } }, "documentation":"

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

" }, "StartTimeHours":{ "type":"long", "max":23, "min":0 }, "StartTimeMinutes":{ "type":"long", "max":59, "min":0 }, "StartTimestamp":{"type":"timestamp"}, "StorageSubTypeName":{ "type":"string", "documentation":"

Sub-type of the given EBS storage type. List of available sub-storage options. The `instance` storage type has no storage sub-type. The `ebs` storage type has the following valid sub-types:

- `standard`

- `gp2`

- `gp3`

- `io1`

" }, "StorageType":{ "type":"structure", "members":{ "StorageTypeName":{ "shape":"StorageTypeName", "documentation":"

The name of the storage type.

" }, "StorageSubTypeName":{ "shape":"StorageSubTypeName", "documentation":"

The storage sub-type, such as `gp3` or `io1`.

" }, "StorageTypeLimits":{ "shape":"StorageTypeLimitList", "documentation":"

Limits that are applicable for the given storage type.

" } }, "documentation":"

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

" }, "StorageTypeLimit":{ "type":"structure", "members":{ "LimitName":{ "shape":"LimitName", "documentation":"

Name of storage limits that are applicable for the given storage type. If `StorageType` is `ebs`, the following options are available:

- MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.

- MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.

- MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

- MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

- MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

- MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

" }, "LimitValues":{ "shape":"LimitValueList", "documentation":"

The limit values.

" } }, "documentation":"

Limits that are applicable for the given Amazon OpenSearch Service storage type.

" }, "StorageTypeLimitList":{ "type":"list", "member":{"shape":"StorageTypeLimit"} }, "StorageTypeList":{ "type":"list", "member":{"shape":"StorageType"} }, "StorageTypeName":{ "type":"string", "documentation":"

The type of storage that the domain uses. Can be one of the following:

instance

  Built-in storage available for the instance.

ebs

  Elastic Block Storage (EBS) attached to the instance.

" }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "TLSSecurityPolicy":{ "type":"string", "enum":[ "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10" ] }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The tag key. Tag keys must be unique for the domain to which they are attached.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of `project : Trinity` and `cost-center : Trinity`

" } }, "documentation":"

A tag (key-value pair) for an Amazon OpenSearch Service resource.

" }, "TagKey":{ "type":"string", "documentation":"

A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they're attached.

", "max":128, "min":1, "pattern":".*" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "documentation":"

A list of tags attached to a domain.

" }, "TagValue":{ "type":"string", "documentation":"

A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.

", "max":256, "min":0, "pattern":".*" }, "TimeUnit":{ "type":"string", "documentation":"

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

", "enum":["HOURS"] }, "TotalNumberOfStages":{"type":"integer"}, "UIntValue":{ "type":"integer", "min":0 }, "UncompressedPluginSizeInBytes":{"type":"long"}, "UpdateDataSourceRequest":{ "type":"structure", "required":[ "DomainName", "Name", "DataSourceType" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain.

", "location":"uri", "locationName":"DomainName" }, "Name":{ "shape":"DataSourceName", "documentation":"

The name of the data source to modify.

", "location":"uri", "locationName":"DataSourceName" }, "DataSourceType":{ "shape":"DataSourceType", "documentation":"

The type of data source.

" }, "Description":{ "shape":"DataSourceDescription", "documentation":"

A new description of the data source.

" } }, "documentation":"

Container for the parameters to the `UpdateDataSource` operation.

" }, "UpdateDataSourceResponse":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

A message associated with the updated data source.

" } }, "documentation":"

The result of an `UpdateDataSource` operation.

" }, "UpdateDomainConfigRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain that you're updating.

", "location":"uri", "locationName":"DomainName" }, "ClusterConfig":{ "shape":"ClusterConfig", "documentation":"

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

" }, "EBSOptions":{ "shape":"EBSOptions", "documentation":"

The type and size of the EBS volume to attach to instances in the domain.

" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"

Option to set the time, in UTC format, for the daily automated snapshot. Default value is `0` hours.

" }, "VPCOptions":{ "shape":"VPCOptions", "documentation":"

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

" }, "CognitoOptions":{ "shape":"CognitoOptions", "documentation":"

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

- `\"rest.action.multi.allow_explicit_index\": \"true\" | \"false\"` - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

- `\"indices.fielddata.cache.size\": \"80\"` - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

- `\"indices.query.bool.max_clause_count\": \"1024\"` - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a `TooManyClauses` error.

For more information, see Advanced cluster parameters.

" }, "AccessPolicies":{ "shape":"PolicyDocument", "documentation":"

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

" }, "IPAddressType":{ "shape":"IPAddressType", "documentation":"

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

" }, "LogPublishingOptions":{ "shape":"LogPublishingOptions", "documentation":"

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptions", "documentation":"

Encryption at rest options for the domain.

" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", "documentation":"

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

" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"

Node-to-node encryption options for the domain.

" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsInput", "documentation":"

Options for fine-grained access control.

" }, "AutoTuneOptions":{ "shape":"AutoTuneOptions", "documentation":"

Options for Auto-Tune.

" }, "DryRun":{ "shape":"DryRun", "documentation":"

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

" }, "DryRunMode":{ "shape":"DryRunMode", "documentation":"

The type of dry run to perform.

- `Basic` only returns the type of deployment (blue/green or dynamic) that the update will cause.

- `Verbose` runs an additional check to validate the changes you're making. For more information, see Validating a domain update.

" }, "OffPeakWindowOptions":{ "shape":"OffPeakWindowOptions", "documentation":"

Off-peak window options for the domain.

" }, "SoftwareUpdateOptions":{ "shape":"SoftwareUpdateOptions", "documentation":"

Service software update options for the domain.

" } }, "documentation":"

Container for the request parameters to the `UpdateDomain` operation.

" }, "UpdateDomainConfigResponse":{ "type":"structure", "required":["DomainConfig"], "members":{ "DomainConfig":{ "shape":"DomainConfig", "documentation":"

The status of the updated domain.

" }, "DryRunResults":{ "shape":"DryRunResults", "documentation":"

Results of the dry run performed in the update domain request.

" }, "DryRunProgressStatus":{ "shape":"DryRunProgressStatus", "documentation":"

The status of the dry run being performed on the domain, if any.

" } }, "documentation":"

The results of an `UpdateDomain` request. Contains the status of the domain being updated.

" }, "UpdatePackageRequest":{ "type":"structure", "required":[ "PackageID", "PackageSource" ], "members":{ "PackageID":{ "shape":"PackageID", "documentation":"

The unique identifier for the package.

" }, "PackageSource":{ "shape":"PackageSource", "documentation":"

Amazon S3 bucket and key for the package.

" }, "PackageDescription":{ "shape":"PackageDescription", "documentation":"

A new description of the package.

" }, "CommitMessage":{ "shape":"CommitMessage", "documentation":"

Commit message for the updated file, which is shown as part of `GetPackageVersionHistoryResponse`.

" } }, "documentation":"

Container for request parameters to the `UpdatePackage` operation.

" }, "UpdatePackageResponse":{ "type":"structure", "members":{ "PackageDetails":{ "shape":"PackageDetails", "documentation":"

Information about a package.

" } }, "documentation":"

Container for the response returned by the `UpdatePackage` operation.

" }, "UpdateScheduledActionRequest":{ "type":"structure", "required":[ "DomainName", "ActionID", "ActionType", "ScheduleAt" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain to reschedule an action for.

", "location":"uri", "locationName":"DomainName" }, "ActionID":{ "shape":"String", "documentation":"

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

" }, "ActionType":{ "shape":"ActionType", "documentation":"

The type of action to reschedule. Can be one of `SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a ListScheduledActions request.

" }, "ScheduleAt":{ "shape":"ScheduleAt", "documentation":"

When to schedule the action.

- `NOW` - Immediately schedules the update to happen in the current hour if there's capacity available.

- `TIMESTAMP` - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for `DesiredStartTime`.

- `OFF_PEAK_WINDOW` - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

" }, "DesiredStartTime":{ "shape":"Long", "documentation":"

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set `ScheduleAt` to `TIMESTAMP`.

" } } }, "UpdateScheduledActionResponse":{ "type":"structure", "members":{ "ScheduledAction":{ "shape":"ScheduledAction", "documentation":"

Information about the rescheduled action.

" } } }, "UpdateTimestamp":{"type":"timestamp"}, "UpdateVpcEndpointRequest":{ "type":"structure", "required":[ "VpcEndpointId", "VpcOptions" ], "members":{ "VpcEndpointId":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "VpcOptions":{ "shape":"VPCOptions", "documentation":"

The security groups and/or subnets to add, remove, or modify.

" } } }, "UpdateVpcEndpointResponse":{ "type":"structure", "required":["VpcEndpoint"], "members":{ "VpcEndpoint":{ "shape":"VpcEndpoint", "documentation":"

The endpoint to be updated.

" } } }, "UpgradeDomainRequest":{ "type":"structure", "required":[ "DomainName", "TargetVersion" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

Name of the OpenSearch Service domain that you want to upgrade.

" }, "TargetVersion":{ "shape":"VersionString", "documentation":"

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

" }, "PerformCheckOnly":{ "shape":"Boolean", "documentation":"

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

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

Only supports the `override_main_response_version` parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

" } }, "documentation":"

Container for the request parameters to the `UpgradeDomain` operation.

" }, "UpgradeDomainResponse":{ "type":"structure", "members":{ "UpgradeId":{ "shape":"String", "documentation":"

The unique identifier of the domain upgrade.

" }, "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain that was upgraded.

" }, "TargetVersion":{ "shape":"VersionString", "documentation":"

OpenSearch or Elasticsearch version that the domain was upgraded to.

" }, "PerformCheckOnly":{ "shape":"Boolean", "documentation":"

When true, indicates that an upgrade eligibility check was performed.

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

The advanced options configuration for the domain.

" }, "ChangeProgressDetails":{ "shape":"ChangeProgressDetails", "documentation":"

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

" } }, "documentation":"

Container for the response returned by `UpgradeDomain` operation.

" }, "UpgradeHistory":{ "type":"structure", "members":{ "UpgradeName":{ "shape":"UpgradeName", "documentation":"

A string that describes the upgrade.

" }, "StartTimestamp":{ "shape":"StartTimestamp", "documentation":"

UTC timestamp at which the upgrade API call was made, in the format `yyyy-MM-ddTHH:mm:ssZ`.

" }, "UpgradeStatus":{ "shape":"UpgradeStatus", "documentation":"

The current status of the upgrade. The status can take one of the following values:

- In Progress

- Succeeded

- Succeeded with Issues

- Failed

" }, "StepsList":{ "shape":"UpgradeStepsList", "documentation":"

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

" } }, "documentation":"

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

" }, "UpgradeHistoryList":{ "type":"list", "member":{"shape":"UpgradeHistory"} }, "UpgradeName":{"type":"string"}, "UpgradeStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "SUCCEEDED", "SUCCEEDED_WITH_ISSUES", "FAILED" ] }, "UpgradeStep":{ "type":"string", "enum":[ "PRE_UPGRADE_CHECK", "SNAPSHOT", "UPGRADE" ] }, "UpgradeStepItem":{ "type":"structure", "members":{ "UpgradeStep":{ "shape":"UpgradeStep", "documentation":"

One of three steps that an upgrade or upgrade eligibility check goes through:

- PreUpgradeCheck

- Snapshot

- Upgrade

" }, "UpgradeStepStatus":{ "shape":"UpgradeStatus", "documentation":"

The current status of the upgrade. The status can take one of the following values:

- In Progress

- Succeeded

- Succeeded with Issues

- Failed

" }, "Issues":{ "shape":"Issues", "documentation":"

A list of strings containing detailed information about the errors encountered in a particular step.

" }, "ProgressPercent":{ "shape":"Double", "documentation":"

The floating point value representing the progress percentage of a particular step.

" } }, "documentation":"

Represents a single step of an upgrade or upgrade eligibility check workflow.

" }, "UpgradeStepsList":{ "type":"list", "member":{"shape":"UpgradeStepItem"} }, "UserPoolId":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+_[0-9a-zA-Z]+" }, "Username":{ "type":"string", "max":64, "min":1, "pattern":".*", "sensitive":true }, "VPCDerivedInfo":{ "type":"structure", "members":{ "VPCId":{ "shape":"String", "documentation":"

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

" }, "SubnetIds":{ "shape":"StringList", "documentation":"

A list of subnet IDs associated with the VPC endpoints for the domain.

" }, "AvailabilityZones":{ "shape":"StringList", "documentation":"

The list of Availability Zones associated with the VPC subnets.

" }, "SecurityGroupIds":{ "shape":"StringList", "documentation":"

The list of security group IDs associated with the VPC endpoints for the domain.

" } }, "documentation":"

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with `VPCOptions`.

" }, "VPCDerivedInfoStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"VPCDerivedInfo", "documentation":"

The VPC options for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the VPC options for the specified domain.

" } }, "documentation":"

Status of the VPC options for a specified domain.

" }, "VPCOptions":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"StringList", "documentation":"

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

" }, "SecurityGroupIds":{ "shape":"StringList", "documentation":"

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

" } }, "documentation":"

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

" }, "ValidationException":{ "type":"structure", "members":{ }, "documentation":"

An exception for accessing or deleting a resource that doesn't exist.

", "error":{"httpStatusCode":400}, "exception":true }, "ValidationFailure":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code of the failure.

" }, "Message":{ "shape":"String", "documentation":"

A message corresponding to the failure.

" } }, "documentation":"

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

" }, "ValidationFailures":{ "type":"list", "member":{"shape":"ValidationFailure"} }, "ValueStringList":{ "type":"list", "member":{"shape":"NonEmptyString"}, "min":1 }, "VersionList":{ "type":"list", "member":{"shape":"VersionString"}, "documentation":"

List of supported OpenSearch versions.

" }, "VersionStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"VersionString", "documentation":"

The OpenSearch or Elasticsearch version for the specified domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the version options for the specified domain.

" } }, "documentation":"

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.

" }, "VersionString":{ "type":"string", "max":18, "min":14, "pattern":"^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$" }, "VolumeSize":{"type":"string"}, "VolumeType":{ "type":"string", "documentation":"

The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.

", "enum":[ "standard", "gp2", "io1", "gp3" ] }, "VpcEndpoint":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "VpcEndpointOwner":{ "shape":"AWSAccount", "documentation":"

The creator of the endpoint.

" }, "DomainArn":{ "shape":"DomainArn", "documentation":"

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

" }, "VpcOptions":{ "shape":"VPCDerivedInfo", "documentation":"

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

" }, "Status":{ "shape":"VpcEndpointStatus", "documentation":"

The current status of the endpoint.

" }, "Endpoint":{ "shape":"Endpoint", "documentation":"

The connection endpoint ID for connecting to the domain.

" } }, "documentation":"

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

" }, "VpcEndpointError":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "ErrorCode":{ "shape":"VpcEndpointErrorCode", "documentation":"

The code associated with the error.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

A message describing the error.

" } }, "documentation":"

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

" }, "VpcEndpointErrorCode":{ "type":"string", "enum":[ "ENDPOINT_NOT_FOUND", "SERVER_ERROR" ] }, "VpcEndpointErrorList":{ "type":"list", "member":{"shape":"VpcEndpointError"} }, "VpcEndpointId":{ "type":"string", "max":256, "min":5, "pattern":"^aos-[a-zA-Z0-9]*$" }, "VpcEndpointIdList":{ "type":"list", "member":{"shape":"VpcEndpointId"} }, "VpcEndpointStatus":{ "type":"string", "enum":[ "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED" ] }, "VpcEndpointSummary":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"VpcEndpointId", "documentation":"

The unique identifier of the endpoint.

" }, "VpcEndpointOwner":{ "shape":"String", "documentation":"

The creator of the endpoint.

" }, "DomainArn":{ "shape":"DomainArn", "documentation":"

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

" }, "Status":{ "shape":"VpcEndpointStatus", "documentation":"

The current status of the endpoint.

" } }, "documentation":"

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

" }, "VpcEndpointSummaryList":{ "type":"list", "member":{"shape":"VpcEndpointSummary"} }, "VpcEndpoints":{ "type":"list", "member":{"shape":"VpcEndpoint"} }, "WindowStartTime":{ "type":"structure", "required":[ "Hours", "Minutes" ], "members":{ "Hours":{ "shape":"StartTimeHours", "documentation":"

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, `17` refers to 5:00 P.M. UTC.

" }, "Minutes":{ "shape":"StartTimeMinutes", "documentation":"

The start minute of the window, in UTC.

" } }, "documentation":"

The desired start time for an off-peak maintenance window.

" }, "ZoneAwarenessConfig":{ "type":"structure", "members":{ "AvailabilityZoneCount":{ "shape":"IntegerClass", "documentation":"

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are `2` and `3`. If your domain is provisioned within a VPC, this value be equal to number of subnets.

" } }, "documentation":"

The zone awareness configuration for an Amazon OpenSearch Service domain.

" }, "ZoneStatus":{ "type":"string", "enum":[ "Active", "StandBy", "NotAvailable" ] } }, "documentation":"

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.

For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

" }