{ "version":"2.0", "metadata":{ "apiVersion":"2015-01-01", "endpointPrefix":"es", "protocol":"rest-json", "serviceFullName":"Amazon Elasticsearch Service", "serviceId":"Elasticsearch Service", "signatureVersion":"v4", "uid":"es-2015-01-01" }, "operations":{ "AcceptInboundCrossClusterSearchConnection":{ "name":"AcceptInboundCrossClusterSearchConnection", "http":{ "method":"PUT", "requestUri":"/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept" }, "input":{"shape":"AcceptInboundCrossClusterSearchConnectionRequest"}, "output":{"shape":"AcceptInboundCrossClusterSearchConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

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

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

" }, "AssociatePackage":{ "name":"AssociatePackage", "http":{ "method":"POST", "requestUri":"/2015-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 ES domain.

" }, "AuthorizeVpcEndpointAccess":{ "name":"AuthorizeVpcEndpointAccess", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/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.

" }, "CancelElasticsearchServiceSoftwareUpdate":{ "name":"CancelElasticsearchServiceSoftwareUpdate", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/serviceSoftwareUpdate/cancel" }, "input":{"shape":"CancelElasticsearchServiceSoftwareUpdateRequest"}, "output":{"shape":"CancelElasticsearchServiceSoftwareUpdateResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "CreateElasticsearchDomain":{ "name":"CreateElasticsearchDomain", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/domain" }, "input":{"shape":"CreateElasticsearchDomainRequest"}, "output":{"shape":"CreateElasticsearchDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "CreateOutboundCrossClusterSearchConnection":{ "name":"CreateOutboundCrossClusterSearchConnection", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/ccs/outboundConnection" }, "input":{"shape":"CreateOutboundCrossClusterSearchConnectionRequest"}, "output":{"shape":"CreateOutboundCrossClusterSearchConnectionResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InternalException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "CreatePackage":{ "name":"CreatePackage", "http":{ "method":"POST", "requestUri":"/2015-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":"

Create a package for use with Amazon ES domains.

" }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/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.

" }, "DeleteElasticsearchDomain":{ "name":"DeleteElasticsearchDomain", "http":{ "method":"DELETE", "requestUri":"/2015-01-01/es/domain/{DomainName}" }, "input":{"shape":"DeleteElasticsearchDomainRequest"}, "output":{"shape":"DeleteElasticsearchDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DeleteElasticsearchServiceRole":{ "name":"DeleteElasticsearchServiceRole", "http":{ "method":"DELETE", "requestUri":"/2015-01-01/es/role" }, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DeleteInboundCrossClusterSearchConnection":{ "name":"DeleteInboundCrossClusterSearchConnection", "http":{ "method":"DELETE", "requestUri":"/2015-01-01/es/ccs/inboundConnection/{ConnectionId}" }, "input":{"shape":"DeleteInboundCrossClusterSearchConnectionRequest"}, "output":{"shape":"DeleteInboundCrossClusterSearchConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DeleteOutboundCrossClusterSearchConnection":{ "name":"DeleteOutboundCrossClusterSearchConnection", "http":{ "method":"DELETE", "requestUri":"/2015-01-01/es/ccs/outboundConnection/{ConnectionId}" }, "input":{"shape":"DeleteOutboundCrossClusterSearchConnectionRequest"}, "output":{"shape":"DeleteOutboundCrossClusterSearchConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

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

Delete the package.

" }, "DeleteVpcEndpoint":{ "name":"DeleteVpcEndpoint", "http":{ "method":"DELETE", "requestUri":"/2015-01-01/es/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.

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

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

" }, "DescribeDomainChangeProgress":{ "name":"DescribeDomainChangeProgress", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/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 a domain, including a change ID, status, and progress stages.

" }, "DescribeElasticsearchDomain":{ "name":"DescribeElasticsearchDomain", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/domain/{DomainName}" }, "input":{"shape":"DescribeElasticsearchDomainRequest"}, "output":{"shape":"DescribeElasticsearchDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeElasticsearchDomainConfig":{ "name":"DescribeElasticsearchDomainConfig", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/domain/{DomainName}/config" }, "input":{"shape":"DescribeElasticsearchDomainConfigRequest"}, "output":{"shape":"DescribeElasticsearchDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeElasticsearchDomains":{ "name":"DescribeElasticsearchDomains", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/domain-info" }, "input":{"shape":"DescribeElasticsearchDomainsRequest"}, "output":{"shape":"DescribeElasticsearchDomainsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "DescribeElasticsearchInstanceTypeLimits":{ "name":"DescribeElasticsearchInstanceTypeLimits", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}" }, "input":{"shape":"DescribeElasticsearchInstanceTypeLimitsRequest"}, "output":{"shape":"DescribeElasticsearchInstanceTypeLimitsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the `DomainName` to know what Limits are supported for modifying.

" }, "DescribeInboundCrossClusterSearchConnections":{ "name":"DescribeInboundCrossClusterSearchConnections", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/ccs/inboundConnection/search" }, "input":{"shape":"DescribeInboundCrossClusterSearchConnectionsRequest"}, "output":{"shape":"DescribeInboundCrossClusterSearchConnectionsResponse"}, "errors":[ {"shape":"InvalidPaginationTokenException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DescribeOutboundCrossClusterSearchConnections":{ "name":"DescribeOutboundCrossClusterSearchConnections", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/ccs/outboundConnection/search" }, "input":{"shape":"DescribeOutboundCrossClusterSearchConnectionsRequest"}, "output":{"shape":"DescribeOutboundCrossClusterSearchConnectionsResponse"}, "errors":[ {"shape":"InvalidPaginationTokenException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

" }, "DescribePackages":{ "name":"DescribePackages", "http":{ "method":"POST", "requestUri":"/2015-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 Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

" }, "DescribeReservedElasticsearchInstanceOfferings":{ "name":"DescribeReservedElasticsearchInstanceOfferings", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/reservedInstanceOfferings" }, "input":{"shape":"DescribeReservedElasticsearchInstanceOfferingsRequest"}, "output":{"shape":"DescribeReservedElasticsearchInstanceOfferingsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"} ], "documentation":"

Lists available reserved Elasticsearch instance offerings.

" }, "DescribeReservedElasticsearchInstances":{ "name":"DescribeReservedElasticsearchInstances", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/reservedInstances" }, "input":{"shape":"DescribeReservedElasticsearchInstancesRequest"}, "output":{"shape":"DescribeReservedElasticsearchInstancesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"

Returns information about reserved Elasticsearch instances for this account.

" }, "DescribeVpcEndpoints":{ "name":"DescribeVpcEndpoints", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/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":"/2015-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":"

Dissociates a package from the Amazon ES domain.

" }, "GetCompatibleElasticsearchVersions":{ "name":"GetCompatibleElasticsearchVersions", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/compatibleVersions" }, "input":{"shape":"GetCompatibleElasticsearchVersionsRequest"}, "output":{"shape":"GetCompatibleElasticsearchVersionsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

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

" }, "GetPackageVersionHistory":{ "name":"GetPackageVersionHistory", "http":{ "method":"GET", "requestUri":"/2015-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 versions of the package, along with their creation time and commit message.

" }, "GetUpgradeHistory":{ "name":"GetUpgradeHistory", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/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 that were performed on the domain.

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

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

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

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

" }, "ListDomainsForPackage":{ "name":"ListDomainsForPackage", "http":{ "method":"GET", "requestUri":"/2015-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 ES domains associated with the package.

" }, "ListElasticsearchInstanceTypes":{ "name":"ListElasticsearchInstanceTypes", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/instanceTypes/{ElasticsearchVersion}" }, "input":{"shape":"ListElasticsearchInstanceTypesRequest"}, "output":{"shape":"ListElasticsearchInstanceTypesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

" }, "ListElasticsearchVersions":{ "name":"ListElasticsearchVersions", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/versions" }, "input":{"shape":"ListElasticsearchVersionsRequest"}, "output":{"shape":"ListElasticsearchVersionsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

List all supported Elasticsearch versions

" }, "ListPackagesForDomain":{ "name":"ListPackagesForDomain", "http":{ "method":"GET", "requestUri":"/2015-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 the Amazon ES domain.

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

Returns all tags for the given Elasticsearch domain.

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

Retrieves information about each 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":"/2015-01-01/es/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 account and Region.

" }, "ListVpcEndpointsForDomain":{ "name":"ListVpcEndpointsForDomain", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/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.

" }, "PurchaseReservedElasticsearchInstanceOffering":{ "name":"PurchaseReservedElasticsearchInstanceOffering", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/purchaseReservedInstanceOffering" }, "input":{"shape":"PurchaseReservedElasticsearchInstanceOfferingRequest"}, "output":{"shape":"PurchaseReservedElasticsearchInstanceOfferingResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Allows you to purchase reserved Elasticsearch instances.

" }, "RejectInboundCrossClusterSearchConnection":{ "name":"RejectInboundCrossClusterSearchConnection", "http":{ "method":"PUT", "requestUri":"/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject" }, "input":{"shape":"RejectInboundCrossClusterSearchConnectionRequest"}, "output":{"shape":"RejectInboundCrossClusterSearchConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"

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

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

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

" }, "RevokeVpcEndpointAccess":{ "name":"RevokeVpcEndpointAccess", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/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.

" }, "StartElasticsearchServiceSoftwareUpdate":{ "name":"StartElasticsearchServiceSoftwareUpdate", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/serviceSoftwareUpdate/start" }, "input":{"shape":"StartElasticsearchServiceSoftwareUpdateRequest"}, "output":{"shape":"StartElasticsearchServiceSoftwareUpdateResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Schedules a service software update for an Amazon ES domain.

" }, "UpdateElasticsearchDomainConfig":{ "name":"UpdateElasticsearchDomainConfig", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/domain/{DomainName}/config" }, "input":{"shape":"UpdateElasticsearchDomainConfigRequest"}, "output":{"shape":"UpdateElasticsearchDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

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

" }, "UpdatePackage":{ "name":"UpdatePackage", "http":{ "method":"POST", "requestUri":"/2015-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 ES domains.

" }, "UpdateVpcEndpoint":{ "name":"UpdateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/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.

" }, "UpgradeElasticsearchDomain":{ "name":"UpgradeElasticsearchDomain", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/upgradeDomain" }, "input":{"shape":"UpgradeElasticsearchDomainRequest"}, "output":{"shape":"UpgradeElasticsearchDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

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

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

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

" }, "AWSAccount":{ "type":"string", "pattern":"^[0-9]+$" }, "AcceptInboundCrossClusterSearchConnectionRequest":{ "type":"structure", "required":["CrossClusterSearchConnectionId"], "members":{ "CrossClusterSearchConnectionId":{ "shape":"CrossClusterSearchConnectionId", "documentation":"

The id of the inbound connection that you want to accept.

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

Container for the parameters to the `AcceptInboundCrossClusterSearchConnection` operation.

" }, "AcceptInboundCrossClusterSearchConnectionResponse":{ "type":"structure", "members":{ "CrossClusterSearchConnection":{ "shape":"InboundCrossClusterSearchConnection", "documentation":"

Specifies the `InboundCrossClusterSearchConnection` of accepted inbound connection.

" } }, "documentation":"

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

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

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

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

The status of the access policy for the Elasticsearch domain. See `OptionStatus` for the status information that's included.

" } }, "documentation":"

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

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

Specify the `ARN` for which you want to add the tags.

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

List of `Tag` that need to be added for the Elasticsearch domain.

" } }, "documentation":"

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

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

Name of Additional Limit is specific to a given InstanceType and for each of it's `InstanceRole` etc.
Attributes and their details:

- MaximumNumberOfDataNodesSupported
This attribute will be present in Master node only to specify how much data nodes upto which given `ESPartitionInstanceType` can support as master node.
- MaximumNumberOfDataNodesWithoutMasterNode
This attribute will be present in Data node only to specify how much data nodes of given `ESPartitionInstanceType` upto which you don't need any master nodes to govern them.

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

Value for given `AdditionalLimit$LimitName` .

" } }, "documentation":"

List of limits that are specific to a given InstanceType and for each of it's `InstanceRole` .

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

Exposes select native Elasticsearch configuration values from `elasticsearch.yml`. Currently, the following advanced options are available:

- Option to allow references to indices in an HTTP request body. Must be `false` when configuring access to individual sub-resources. By default, the value is `true`. See Configuration Advanced Options for more information.
- Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

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

Specifies the status of advanced options for the specified Elasticsearch domain.

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

Specifies the status of `OptionStatus` for advanced options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

- Option to allow references to indices in an HTTP request body. Must be `false` when configuring access to individual sub-resources. By default, the value is `true`. See Configuration Advanced Options for more information.
- Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

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

True if advanced security is enabled.

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

True if the internal user database is enabled.

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

Describes the SAML application configured for a domain.

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

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

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

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

" } }, "documentation":"

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

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

True if advanced security is enabled.

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

True if the internal user database is enabled.

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

Credentials for the master user: username and password, ARN, or both.

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

Specifies the SAML application configuration for the domain.

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

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

" } }, "documentation":"

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

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

Specifies advanced security options for the specified Elasticsearch domain.

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

Status of the advanced security options for the specified Elasticsearch domain.

" } }, "documentation":"

Specifies the status of advanced security options for the specified Elasticsearch domain.

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

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

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

Name of the domain that you want to associate the package with.

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

Container for request parameters to `AssociatePackage` operation.

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

`DomainPackageDetails`

" } }, "documentation":"

Container for response returned by `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 account ID to grant access to.

" } }, "documentation":"

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

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

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

" } }, "documentation":"

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

" }, "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 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":"

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

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

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

" } }, "documentation":"

Specifies Auto-Tune type and Auto-Tune action details.

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

Specifies timestamp for the Auto-Tune action scheduled for the domain.

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

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

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

Specifies timestamp at which Auto-Tune maintenance schedule start.

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

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

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

Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

" } }, "documentation":"

Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.

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

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

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

Specifies list of maitenance schedules. See the Developer Guide for more information.

" } }, "documentation":"

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

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

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

Specifies list of maitenance schedules. See the Developer Guide for more information.

" } }, "documentation":"

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

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

Specifies the `AutoTuneState` for the Elasticsearch domain.

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

Specifies the error message while enabling or disabling the Auto-Tune.

" } }, "documentation":"

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

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

Specifies Auto-Tune options for the specified Elasticsearch domain.

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

Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

" } }, "documentation":"

Specifies the status of Auto-Tune options for the specified Elasticsearch domain.

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

Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide.

", "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":"

Timestamp which tells Auto-Tune options creation date .

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

Timestamp which tells Auto-Tune options last updated time.

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

Specifies the Auto-Tune options latest version.

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

Specifies the `AutoTuneState` for the Elasticsearch domain.

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

Specifies the error message while enabling or disabling the Auto-Tune options.

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

Indicates whether the Elasticsearch domain is being deleted.

" } }, "documentation":"

Provides the current status of the Auto-Tune options.

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

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

", "enum":["SCHEDULED_ACTION"] }, "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"}, "CancelElasticsearchServiceSoftwareUpdateRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain that you want to stop the latest service software update on.

" } }, "documentation":"

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

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

The current status of the Elasticsearch service software update.

" } }, "documentation":"

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

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

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

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

Contains an optional message associated with the domain configuration change.

" } }, "documentation":"

Specifies change details of the domain configuration change.

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

The name of the specific progress stage.

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

The overall status of a specific progress stage.

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

The description of the progress stage.

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

The last updated timestamp of the progress stage.

" } }, "documentation":"

A progress stage details of a specific domain configuration change.

" }, "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. This field can take the following values: `PENDING`, `PROCESSING`, `COMPLETED` and `FAILED`

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

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

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

The list of properties involved in the domain configuration change that are 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 which log needs to be published.

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

Specifies the option to enable Cognito for Kibana authentication.

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

Specifies the Cognito user pool ID for Kibana authentication.

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

Specifies the Cognito identity pool ID for Kibana authentication.

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

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

" } }, "documentation":"

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

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

Specifies the Cognito options for the specified Elasticsearch domain.

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

Specifies the status of the Cognito options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the Cognito options for the specified Elasticsearch domain.

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

Enable cold storage option. Accepted values true or false

" } }, "documentation":"

Specifies the configuration for cold storage options such as enabled

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

The current version of Elasticsearch on which a domain is.

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

A map from an `ElasticsearchVersion` to a list of compatible `ElasticsearchVersion` s to which the domain can be upgraded.

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

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

", "error":{"httpStatusCode":409}, "exception":true }, "ConnectionAlias":{ "type":"string", "max":20 }, "CreateElasticsearchDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

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

" }, "ElasticsearchVersion":{ "shape":"ElasticsearchVersionString", "documentation":"

String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

" }, "ElasticsearchClusterConfig":{ "shape":"ElasticsearchClusterConfig", "documentation":"

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

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

Options to enable, disable and specify the type and size of EBS storage volumes.

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

IAM access policy as a JSON-formatted string.

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

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

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

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

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

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

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

Specifies the Encryption At Rest Options.

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

Specifies the NodeToNodeEncryptionOptions.

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

Option to allow references to indices in an HTTP request body. Must be `false` when configuring access to individual sub-resources. By default, the value is `true`. See Configuration Advanced Options for more information.

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

Map of `LogType` and `LogPublishingOption`, each containing options to publish a given type of Elasticsearch log.

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

Options to specify configuration that will be applied to the domain endpoint.

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

Specifies advanced security options.

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

Specifies Auto-Tune options.

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

A list of `Tag` added during domain creation.

" } } }, "CreateElasticsearchDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{ "shape":"ElasticsearchDomainStatus", "documentation":"

The status of the newly created Elasticsearch domain.

" } }, "documentation":"

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

" }, "CreateOutboundCrossClusterSearchConnectionRequest":{ "type":"structure", "required":[ "SourceDomainInfo", "DestinationDomainInfo", "ConnectionAlias" ], "members":{ "SourceDomainInfo":{ "shape":"DomainInformation", "documentation":"

Specifies the `DomainInformation` for the source Elasticsearch domain.

" }, "DestinationDomainInfo":{ "shape":"DomainInformation", "documentation":"

Specifies the `DomainInformation` for the destination Elasticsearch domain.

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

Specifies the connection alias that will be used by the customer for this connection.

" } }, "documentation":"

Container for the parameters to the `CreateOutboundCrossClusterSearchConnection` operation.

" }, "CreateOutboundCrossClusterSearchConnectionResponse":{ "type":"structure", "members":{ "SourceDomainInfo":{ "shape":"DomainInformation", "documentation":"

Specifies the `DomainInformation` for the source Elasticsearch domain.

" }, "DestinationDomainInfo":{ "shape":"DomainInformation", "documentation":"

Specifies the `DomainInformation` for the destination Elasticsearch domain.

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

Specifies the connection alias provided during the create connection request.

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

Specifies the `OutboundCrossClusterSearchConnectionStatus` for the newly created connection.

" }, "CrossClusterSearchConnectionId":{ "shape":"CrossClusterSearchConnectionId", "documentation":"

Unique id for the created outbound connection, which is used for subsequent operations on connection.

" } }, "documentation":"

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

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

Unique identifier for the package.

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

Type of package. Currently supports only TXT-DICTIONARY.

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

Description of the package.

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

The customer S3 location `PackageSource` for importing the package.

" } }, "documentation":"

Container for request parameters to `CreatePackage` operation.

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

Information about the package `PackageDetails`.

" } }, "documentation":"

Container for response returned by `CreatePackage` operation.

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

The Amazon Resource Name (ARN) of the domain to grant access to.

" }, "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.

" } }, "documentation":"

Container for the parameters to the `CreateVpcEndpointRequest` operation.

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

Information about the newly created VPC endpoint.

" } }, "documentation":"

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

" }, "CreatedAt":{"type":"timestamp"}, "CrossClusterSearchConnectionId":{"type":"string"}, "CrossClusterSearchConnectionStatusMessage":{"type":"string"}, "DeleteElasticsearchDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the Elasticsearch domain that you want to permanently delete.

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

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

" }, "DeleteElasticsearchDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{ "shape":"ElasticsearchDomainStatus", "documentation":"

The status of the Elasticsearch domain being deleted.

" } }, "documentation":"

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

" }, "DeleteInboundCrossClusterSearchConnectionRequest":{ "type":"structure", "required":["CrossClusterSearchConnectionId"], "members":{ "CrossClusterSearchConnectionId":{ "shape":"CrossClusterSearchConnectionId", "documentation":"

The id of the inbound connection that you want to permanently delete.

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

Container for the parameters to the `DeleteInboundCrossClusterSearchConnection` operation.

" }, "DeleteInboundCrossClusterSearchConnectionResponse":{ "type":"structure", "members":{ "CrossClusterSearchConnection":{ "shape":"InboundCrossClusterSearchConnection", "documentation":"

Specifies the `InboundCrossClusterSearchConnection` of deleted inbound connection.

" } }, "documentation":"

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

" }, "DeleteOutboundCrossClusterSearchConnectionRequest":{ "type":"structure", "required":["CrossClusterSearchConnectionId"], "members":{ "CrossClusterSearchConnectionId":{ "shape":"CrossClusterSearchConnectionId", "documentation":"

The id of the outbound connection that you want to permanently delete.

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

Container for the parameters to the `DeleteOutboundCrossClusterSearchConnection` operation.

" }, "DeleteOutboundCrossClusterSearchConnectionResponse":{ "type":"structure", "members":{ "CrossClusterSearchConnection":{ "shape":"OutboundCrossClusterSearchConnection", "documentation":"

Specifies the `OutboundCrossClusterSearchConnection` of deleted outbound connection.

" } }, "documentation":"

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

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

Internal ID of the package that you want to delete. Use `DescribePackages` to find this value.

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

Container for request parameters to `DeletePackage` operation.

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

`PackageDetails`

" } }, "documentation":"

Container for response parameters to `DeletePackage` operation.

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

The unique identifier of the endpoint to be deleted.

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

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

" }, "DeleteVpcEndpointResponse":{ "type":"structure", "required":["VpcEndpointSummary"], "members":{ "VpcEndpointSummary":{ "shape":"VpcEndpointSummary", "documentation":"

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

" } }, "documentation":"

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

" }, "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":"

Specifies the domain name for which you want Auto-Tune action details.

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

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

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

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

" } }, "documentation":"

Container for the parameters to the `DescribeDomainAutoTunes` operation.

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

Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

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

Specifies an identifier to allow retrieval of paginated results.

" } }, "documentation":"

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

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

The domain you want to get the progress information about.

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

The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

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

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

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

Progress information for the configuration change that is requested in the `DescribeDomainChangeProgress` request.

" } }, "documentation":"

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

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

The Elasticsearch domain that you want to get information about.

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

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

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

The configuration information of the domain requested in the `DescribeElasticsearchDomainConfig` request.

" } }, "documentation":"

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

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

The name of the Elasticsearch domain for which you want information.

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

Container for the parameters to the `DescribeElasticsearchDomain` operation.

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

The current status of the Elasticsearch domain.

" } }, "documentation":"

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

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

The Elasticsearch domains for which you want information.

" } }, "documentation":"

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

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

The status of the domains requested in the `DescribeElasticsearchDomains` request.

" } }, "documentation":"

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

" }, "DescribeElasticsearchInstanceTypeLimitsRequest":{ "type":"structure", "required":[ "InstanceType", "ElasticsearchVersion" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch `Limits` for existing domain.

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

The instance type for an Elasticsearch cluster for which Elasticsearch `Limits` are needed.

", "location":"uri", "locationName":"InstanceType" }, "ElasticsearchVersion":{ "shape":"ElasticsearchVersionString", "documentation":"

Version of Elasticsearch for which `Limits` are needed.

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

Container for the parameters to `DescribeElasticsearchInstanceTypeLimits` operation.

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

Container for the parameters received from `DescribeElasticsearchInstanceTypeLimits` operation.

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

A list of filters used to match properties for inbound cross-cluster search connection. Available `Filter` names for this operation are:

- cross-cluster-search-connection-id
- source-domain-info.domain-name
- source-domain-info.owner-id
- source-domain-info.region
- destination-domain-info.domain-name

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

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

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

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

" } }, "documentation":"

Container for the parameters to the `DescribeInboundCrossClusterSearchConnections` operation.

" }, "DescribeInboundCrossClusterSearchConnectionsResponse":{ "type":"structure", "members":{ "CrossClusterSearchConnections":{ "shape":"InboundCrossClusterSearchConnections", "documentation":"

Consists of list of `InboundCrossClusterSearchConnection` matching the specified filter criteria.

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

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

" } }, "documentation":"

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

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

A list of filters used to match properties for outbound cross-cluster search connection. Available `Filter` names for this operation are:

- cross-cluster-search-connection-id
- destination-domain-info.domain-name
- destination-domain-info.owner-id
- destination-domain-info.region
- source-domain-info.domain-name

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

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

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

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

" } }, "documentation":"

Container for the parameters to the `DescribeOutboundCrossClusterSearchConnections` operation.

" }, "DescribeOutboundCrossClusterSearchConnectionsResponse":{ "type":"structure", "members":{ "CrossClusterSearchConnections":{ "shape":"OutboundCrossClusterSearchConnections", "documentation":"

Consists of list of `OutboundCrossClusterSearchConnection` matching the specified filter criteria.

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

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

" } }, "documentation":"

The result of a `DescribeOutboundCrossClusterSearchConnections` request. Contains the 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 field.

" } }, "documentation":"

Filter to apply in `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" ] }, "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":"

Limits results to a maximum number of packages.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

" } }, "documentation":"

Container for request parameters to `DescribePackage` operation.

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

List of `PackageDetails` objects.

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

Container for response returned by `DescribePackages` operation.

" }, "DescribeReservedElasticsearchInstanceOfferingsRequest":{ "type":"structure", "members":{ "ReservedElasticsearchInstanceOfferingId":{ "shape":"GUID", "documentation":"

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

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

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

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

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

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

Container for parameters to `DescribeReservedElasticsearchInstanceOfferings`

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

Provides an identifier to allow retrieval of paginated results.

" }, "ReservedElasticsearchInstanceOfferings":{ "shape":"ReservedElasticsearchInstanceOfferingList", "documentation":"

List of reserved Elasticsearch instance offerings

" } }, "documentation":"

Container for results from `DescribeReservedElasticsearchInstanceOfferings`

" }, "DescribeReservedElasticsearchInstancesRequest":{ "type":"structure", "members":{ "ReservedElasticsearchInstanceId":{ "shape":"GUID", "documentation":"

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

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

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

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

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

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

Container for parameters to `DescribeReservedElasticsearchInstances`

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

Provides an identifier to allow retrieval of paginated results.

" }, "ReservedElasticsearchInstances":{ "shape":"ReservedElasticsearchInstanceList", "documentation":"

List of reserved Elasticsearch instances.

" } }, "documentation":"

Container for results from `DescribeReservedElasticsearchInstances`

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

The unique identifiers of the endpoints to get information about.

" } }, "documentation":"

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

" }, "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.

" } }, "documentation":"

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

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

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

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

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

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

Name of the domain that you want to associate the package with.

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

Container for request parameters to `DissociatePackage` operation.

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

`DomainPackageDetails`

" } }, "documentation":"

Container for response returned by `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\\-]+" }, "DomainEndpointOptions":{ "type":"structure", "members":{ "EnforceHTTPS":{ "shape":"Boolean", "documentation":"

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

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

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It 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":"

Specify if custom endpoint should be enabled for the Elasticsearch domain.

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

Specify the fully qualified domain for your custom endpoint.

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

Specify ACM certificate ARN for your custom endpoint.

" } }, "documentation":"

Options to configure endpoint for the Elasticsearch domain.

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

Options to configure endpoint for the Elasticsearch domain.

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

The status of the endpoint options for the Elasticsearch domain. See `OptionStatus` for the status information that's included.

" } }, "documentation":"

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

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

Unique identifier for an Elasticsearch domain.

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

Specifies the `DomainName`.

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

Specifies the `EngineType` of the domain.

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

Contains the list of Elasticsearch domain information.

" }, "DomainInformation":{ "type":"structure", "required":["DomainName"], "members":{ "OwnerId":{"shape":"OwnerId"}, "DomainName":{"shape":"DomainName"}, "Region":{"shape":"Region"} } }, "DomainName":{ "type":"string", "documentation":"

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

", "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 Elasticsearch domain names.

" }, "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":"

Currently supports only TXT-DICTIONARY.

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

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

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

Name of the domain you've associated a package with.

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

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

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

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

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

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

" } }, "documentation":"

Information on a package that is associated with a domain.

" }, "DomainPackageDetailsList":{ "type":"list", "member":{"shape":"DomainPackageDetails"} }, "DomainPackageStatus":{ "type":"string", "enum":[ "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED" ] }, "Double":{"type":"double"}, "DryRun":{"type":"boolean"}, "DryRunResults":{ "type":"structure", "members":{ "DeploymentType":{ "shape":"DeploymentType", "documentation":"

Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are `Blue/Green` (The update will require a blue/green deployment.) `DynamicUpdate` (The update can be applied in-place without a Blue/Green deployment required.) `Undetermined` (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) `None` (The configuration change matches the current configuration and will not result in any update.)

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

Contains an optional message associated with the DryRunResults.

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

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

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

Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

" } }, "documentation":"

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

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

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

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

Specifies whether EBS-based storage is enabled.

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

Specifies the volume type for EBS-based storage.

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

Integer to specify the size of an EBS volume.

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

Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

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

Specifies the Throughput for GP3 EBS volume (SSD).

" } }, "documentation":"

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

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

Specifies the EBS options for the specified Elasticsearch domain.

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

Specifies the status of the EBS options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the EBS options for the specified Elasticsearch domain.

" }, "ESPartitionInstanceType":{ "type":"string", "enum":[ "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch" ] }, "ESWarmPartitionInstanceType":{ "type":"string", "enum":[ "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch" ] }, "ElasticsearchClusterConfig":{ "type":"structure", "members":{ "InstanceType":{ "shape":"ESPartitionInstanceType", "documentation":"

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

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

The number of instances in the specified domain cluster.

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

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

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

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

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

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

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

The instance type for a dedicated master node.

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

Total number of dedicated master nodes, active and on standby, for the cluster.

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

True to enable warm storage.

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

The instance type for the Elasticsearch cluster's warm nodes.

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

The number of warm nodes in the cluster.

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

Specifies the `ColdStorageOptions` config for Elasticsearch Domain

" } }, "documentation":"

Specifies the configuration for the domain cluster, such as the type and number of instances.

" }, "ElasticsearchClusterConfigStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"ElasticsearchClusterConfig", "documentation":"

Specifies the cluster configuration for the specified Elasticsearch domain.

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

Specifies the status of the configuration for the specified Elasticsearch domain.

" } }, "documentation":"

Specifies the configuration status for the specified Elasticsearch domain.

" }, "ElasticsearchDomainConfig":{ "type":"structure", "members":{ "ElasticsearchVersion":{ "shape":"ElasticsearchVersionStatus", "documentation":"

String of format X.Y to specify version for the Elasticsearch domain.

" }, "ElasticsearchClusterConfig":{ "shape":"ElasticsearchClusterConfigStatus", "documentation":"

Specifies the `ElasticsearchClusterConfig` for the Elasticsearch domain.

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

Specifies the `EBSOptions` for the Elasticsearch domain.

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

IAM access policy as a JSON-formatted string.

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

Specifies the `SnapshotOptions` for the Elasticsearch domain.

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

The `VPCOptions` for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

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

The `CognitoOptions` for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

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

Specifies the `EncryptionAtRestOptions` for the Elasticsearch domain.

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

Specifies the `NodeToNodeEncryptionOptions` for the Elasticsearch domain.

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

Specifies the `AdvancedOptions` for the domain. See Configuring Advanced Options for more information.

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

Log publishing options for the given domain.

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

Specifies the `DomainEndpointOptions` for the Elasticsearch domain.

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

Specifies `AdvancedSecurityOptions` for the domain.

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

Specifies `AutoTuneOptions` for the domain.

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

Specifies change details of the domain configuration change.

" } }, "documentation":"

The configuration of an Elasticsearch domain.

" }, "ElasticsearchDomainStatus":{ "type":"structure", "required":[ "DomainId", "DomainName", "ARN", "ElasticsearchClusterConfig" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"

The unique identifier for the specified Elasticsearch domain.

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

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

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

The domain creation status. `True` if the creation of an Elasticsearch domain is complete. `False` if domain creation is still in progress.

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

The domain deletion status. `True` if a delete request has been received for the domain but resource cleanup is still in progress. `False` if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

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

The Elasticsearch domain endpoint that you use to submit index and search requests.

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

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example `key, value`: `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`.

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

The status of the Elasticsearch domain configuration. `True` if Amazon Elasticsearch Service is processing configuration changes. `False` if the configuration is active.

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

The status of an Elasticsearch domain version upgrade. `True` if Amazon Elasticsearch Service is undergoing a version upgrade. `False` if the configuration is active.

" }, "ElasticsearchVersion":{"shape":"ElasticsearchVersionString"}, "ElasticsearchClusterConfig":{ "shape":"ElasticsearchClusterConfig", "documentation":"

The type and number of instances in the domain cluster.

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

The `EBSOptions` for the specified domain. See Configuring EBS-based Storage for more information.

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

IAM access policy as a JSON-formatted string.

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

Specifies the status of the `SnapshotOptions`

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

The `VPCOptions` for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

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

The `CognitoOptions` for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

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

Specifies the status of the `EncryptionAtRestOptions`.

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

Specifies the status of the `NodeToNodeEncryptionOptions`.

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

Specifies the status of the `AdvancedOptions`

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

Log publishing options for the given domain.

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

The current status of the Elasticsearch domain's service software.

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

The current status of the Elasticsearch domain's endpoint options.

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

The current status of the Elasticsearch domain's advanced security options.

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

The current status of the Elasticsearch domain's Auto-Tune options.

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

Specifies change details of the domain configuration change.

" } }, "documentation":"

The current status of an Elasticsearch domain.

" }, "ElasticsearchDomainStatusList":{ "type":"list", "member":{"shape":"ElasticsearchDomainStatus"}, "documentation":"

A list that contains the status of each requested Elasticsearch domain.

" }, "ElasticsearchInstanceTypeList":{ "type":"list", "member":{"shape":"ESPartitionInstanceType"}, "documentation":"

List of instance types supported by Amazon Elasticsearch service.

" }, "ElasticsearchVersionList":{ "type":"list", "member":{"shape":"ElasticsearchVersionString"}, "documentation":"

List of supported elastic search versions.

" }, "ElasticsearchVersionStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"ElasticsearchVersionString", "documentation":"

Specifies the Elasticsearch version for the specified Elasticsearch domain.

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

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the Elasticsearch version options for the specified Elasticsearch domain.

" }, "ElasticsearchVersionString":{ "type":"string", "pattern":"^[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$|^OS_[0-9]{1,2}\\.[0-9]{1,2}$" }, "EncryptionAtRestOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Specifies the option to enable Encryption At Rest.

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

Specifies the KMS Key ID for Encryption At Rest options.

" } }, "documentation":"

Specifies the Encryption At Rest Options.

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

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

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

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the Encryption At Rest options for the specified Elasticsearch domain.

" }, "Endpoint":{ "type":"string", "pattern":"^[A-Za-z0-9\\-\\.]+$" }, "EndpointsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"ServiceUrl"} }, "EngineType":{ "type":"string", "enum":[ "OpenSearch", "Elasticsearch" ] }, "ErrorDetails":{ "type":"structure", "members":{ "ErrorType":{"shape":"ErrorType"}, "ErrorMessage":{"shape":"ErrorMessage"} } }, "ErrorMessage":{"type":"string"}, "ErrorType":{"type":"string"}, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"NonEmptyString", "documentation":"

Specifies the name of the filter.

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

Contains one or more values for the filter.

" } }, "documentation":"

A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search 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", "pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}" }, "GetCompatibleElasticsearchVersionsRequest":{ "type":"structure", "members":{ "DomainName":{ "shape":"DomainName", "location":"querystring", "locationName":"domainName" } }, "documentation":"

Container for request parameters to `GetCompatibleElasticsearchVersions` operation.

" }, "GetCompatibleElasticsearchVersionsResponse":{ "type":"structure", "members":{ "CompatibleElasticsearchVersions":{ "shape":"CompatibleElasticsearchVersionsList", "documentation":"

A map of compatible Elasticsearch versions returned as part of the `GetCompatibleElasticsearchVersions` operation.

" } }, "documentation":"

Container for response returned by `GetCompatibleElasticsearchVersions` operation.

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

Returns an audit history of versions of the package.

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

Limits results to a maximum number of versions.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

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

Container for request parameters to `GetPackageVersionHistory` operation.

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

List of `PackageVersionHistory` objects.

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

Container for response returned by `GetPackageVersionHistory` operation.

" }, "GetUpgradeHistoryRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "location":"uri", "locationName":"DomainName" }, "MaxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

Container for request parameters to `GetUpgradeHistory` operation.

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

A list of `UpgradeHistory` objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of `GetUpgradeHistoryResponse` object.

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

Pagination token that needs to be supplied to the next call to get the next page of results

" } }, "documentation":"

Container for response returned by `GetUpgradeHistory` operation.

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

Container for request parameters to `GetUpgradeStatus` operation.

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

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

- PreUpgradeCheck
- Snapshot
- Upgrade

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

One of 4 statuses that a step can go through returned as part of the `GetUpgradeStatusResponse` object. The status can take one of the following values:

- In Progress
- Succeeded
- Succeeded with Issues
- Failed

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

A string that describes the update briefly

" } }, "documentation":"

Container for response returned by `GetUpgradeStatus` operation.

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

Specifies the `DomainInformation` for the source Elasticsearch domain.

" }, "DestinationDomainInfo":{ "shape":"DomainInformation", "documentation":"

Specifies the `DomainInformation` for the destination Elasticsearch domain.

" }, "CrossClusterSearchConnectionId":{ "shape":"CrossClusterSearchConnectionId", "documentation":"

Specifies the connection id for the inbound cross-cluster search connection.

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

Specifies the `InboundCrossClusterSearchConnectionStatus` for the outbound connection.

" } }, "documentation":"

Specifies details of an inbound connection.

" }, "InboundCrossClusterSearchConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"InboundCrossClusterSearchConnectionStatusCode", "documentation":"

The state code for inbound connection. This can be one of the following:

- PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
- APPROVED: Inbound connection is pending acceptance by destination domain owner.
- 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 cannot be used further.

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

Specifies verbose information for the inbound connection status.

" } }, "documentation":"

Specifies the coonection status of an inbound cross-cluster search connection.

" }, "InboundCrossClusterSearchConnectionStatusCode":{ "type":"string", "enum":[ "PENDING_ACCEPTANCE", "APPROVED", "REJECTING", "REJECTED", "DELETING", "DELETED" ] }, "InboundCrossClusterSearchConnections":{ "type":"list", "member":{"shape":"InboundCrossClusterSearchConnection"} }, "InstanceCount":{ "type":"integer", "documentation":"

Specifies the number of EC2 instances in the Elasticsearch domain.

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

InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

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

InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

" }, "InstanceRole":{"type":"string"}, "Integer":{"type":"integer"}, "IntegerClass":{"type":"integer"}, "InternalException":{ "type":"structure", "members":{ }, "documentation":"

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

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

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

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

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

", "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":"

StorageType represents the list of storage related types and attributes that are available for given InstanceType.

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

List of additional limits that are specific to a given InstanceType and for each of it's `InstanceRole` .

" } }, "documentation":"

Limits for given InstanceType and for each of it's role.
Limits contains following `StorageTypes,` `InstanceLimits` and `AdditionalLimits`

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

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

- data: If the given InstanceType is used as data node
- master: If the given InstanceType is used as master node
- ultra_warm: If the given InstanceType is used as warm node

" }, "ListDomainNamesRequest":{ "type":"structure", "members":{ "EngineType":{ "shape":"EngineType", "documentation":"

Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.

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

Container for the parameters to the `ListDomainNames` operation.

" }, "ListDomainNamesResponse":{ "type":"structure", "members":{ "DomainNames":{ "shape":"DomainInfoList", "documentation":"

List of domain names and respective engine types.

" } }, "documentation":"

The result 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 package for which to list domains.

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

Limits results to a maximum number of domains.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

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

Container for request parameters to `ListDomainsForPackage` operation.

" }, "ListDomainsForPackageResponse":{ "type":"structure", "members":{ "DomainPackageDetailsList":{ "shape":"DomainPackageDetailsList", "documentation":"

List of `DomainPackageDetails` objects.

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

Container for response parameters to `ListDomainsForPackage` operation.

" }, "ListElasticsearchInstanceTypesRequest":{ "type":"structure", "required":["ElasticsearchVersion"], "members":{ "ElasticsearchVersion":{ "shape":"ElasticsearchVersionString", "documentation":"

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

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

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

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

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

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

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

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

Container for the parameters to the `ListElasticsearchInstanceTypes` operation.

" }, "ListElasticsearchInstanceTypesResponse":{ "type":"structure", "members":{ "ElasticsearchInstanceTypes":{ "shape":"ElasticsearchInstanceTypeList", "documentation":"

List of instance types supported by Amazon Elasticsearch service for given `ElasticsearchVersion`

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

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

" } }, "documentation":"

Container for the parameters returned by `ListElasticsearchInstanceTypes` operation.

" }, "ListElasticsearchVersionsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

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

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

Container for the parameters to the `ListElasticsearchVersions` operation.

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

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

" }, "ListElasticsearchVersionsResponse":{ "type":"structure", "members":{ "ElasticsearchVersions":{"shape":"ElasticsearchVersionList"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Container for the parameters for response received from `ListElasticsearchVersions` operation.

" }, "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":"

Limits results to a maximum number of packages.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

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

Container for request parameters to `ListPackagesForDomain` operation.

" }, "ListPackagesForDomainResponse":{ "type":"structure", "members":{ "DomainPackageDetailsList":{ "shape":"DomainPackageDetailsList", "documentation":"

List of `DomainPackageDetails` objects.

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

Pagination token that needs to be supplied to the next call to get the next page of results.

" } }, "documentation":"

Container for response parameters to `ListPackagesForDomain` operation.

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

Specify the `ARN` for the Elasticsearch domain to which the tags are attached that you want to view.

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

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

" }, "ListTagsResponse":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

List of `Tag` for the requested Elasticsearch domain.

" } }, "documentation":"

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

" }, "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":"

Provides an identifier to allow retrieval of paginated results.

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

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

" }, "ListVpcEndpointAccessResponse":{ "type":"structure", "required":[ "AuthorizedPrincipalList", "NextToken" ], "members":{ "AuthorizedPrincipalList":{ "shape":"AuthorizedPrincipalList", "documentation":"

List of `AuthorizedPrincipal` describing the details of the permissions to manage VPC endpoints against the specified domain.

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

Provides an identifier to allow retrieval of paginated results.

" } }, "documentation":"

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

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

Name of the ElasticSearch domain whose VPC endpoints are to be listed.

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

Provides an identifier to allow retrieval of paginated results.

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

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

" }, "ListVpcEndpointsForDomainResponse":{ "type":"structure", "required":[ "VpcEndpointSummaryList", "NextToken" ], "members":{ "VpcEndpointSummaryList":{ "shape":"VpcEndpointSummaryList", "documentation":"

Provides list of `VpcEndpointSummary` summarizing details of the VPC endpoints.

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

Information about each endpoint associated with the domain.

" } }, "documentation":"

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

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

Identifier to allow retrieval of paginated results.

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

Container for request parameters to the `ListVpcEndpoints` operation.

" }, "ListVpcEndpointsResponse":{ "type":"structure", "required":[ "VpcEndpointSummaryList", "NextToken" ], "members":{ "VpcEndpointSummaryList":{ "shape":"VpcEndpointSummaryList", "documentation":"

Information about each endpoint.

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

Provides an identifier to allow retrieval of paginated results.

" } }, "documentation":"

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

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

Specifies whether given log publishing option is enabled or not.

" } }, "documentation":"

Log Publishing option that is set for given domain.
Attributes and their details:

- CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
- Enabled: Whether the log publishing for given log type is enabled or not

" }, "LogPublishingOptions":{ "type":"map", "key":{"shape":"LogType"}, "value":{"shape":"LogPublishingOption"} }, "LogPublishingOptionsStatus":{ "type":"structure", "members":{ "Options":{ "shape":"LogPublishingOptions", "documentation":"

The log publishing options configured for the Elasticsearch domain.

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

The status of the log publishing options for the Elasticsearch domain. See `OptionStatus` for the status information that's included.

" } }, "documentation":"

The configured log publishing options for the domain and their current status.

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

Type of Log File, it can be one of the following:

- INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
- SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
- ES_APPLICATION_LOGS: Elasticsearch 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 from the domain.

", "enum":[ "INDEX_SLOW_LOGS", "SEARCH_SLOW_LOGS", "ES_APPLICATION_LOGS", "AUDIT_LOGS" ] }, "MasterUserOptions":{ "type":"structure", "members":{ "MasterUserARN":{ "shape":"ARN", "documentation":"

ARN for the master user (if IAM is enabled).

" }, "MasterUserName":{ "shape":"Username", "documentation":"

The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.

" }, "MasterUserPassword":{ "shape":"Password", "documentation":"

The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.

" } }, "documentation":"

Credentials for the master user: username and password, ARN, or both.

" }, "MaxResults":{ "type":"integer", "documentation":"

Set this value to limit the number of results returned.

", "max":100 }, "MaximumInstanceCount":{ "type":"integer", "documentation":"

Maximum number of Instances that can be instantiated for given InstanceType.

" }, "Message":{ "type":"string", "max":1024, "min":0 }, "MinimumInstanceCount":{ "type":"integer", "documentation":"

Minimum number of Instances that can be instantiated for given InstanceType.

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

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

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

Specify true to enable node-to-node encryption.

" } }, "documentation":"

Specifies the node-to-node encryption options.

" }, "NodeToNodeEncryptionOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

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

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the node-to-node encryption options for the specified Elasticsearch domain.

" }, "NonEmptyString":{ "type":"string", "min":1 }, "OptionState":{ "type":"string", "documentation":"

The state of a requested change. One of the following:

- Processing: The request change is still in-process.
- Active: The request change is processed and deployed to the Elasticsearch domain.

", "enum":[ "RequiresIndexDocuments", "Processing", "Active" ] }, "OptionStatus":{ "type":"structure", "required":[ "CreationDate", "UpdateDate", "State" ], "members":{ "CreationDate":{ "shape":"UpdateTimestamp", "documentation":"

Timestamp which tells the creation date for the entity.

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

Timestamp which tells the last updated time for the entity.

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

Specifies the latest version for the entity.

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

Provides the `OptionState` for the Elasticsearch domain.

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

Indicates whether the Elasticsearch domain is being deleted.

" } }, "documentation":"

Provides the current status of the entity.

" }, "OutboundCrossClusterSearchConnection":{ "type":"structure", "members":{ "SourceDomainInfo":{ "shape":"DomainInformation", "documentation":"

Specifies the `DomainInformation` for the source Elasticsearch domain.

" }, "DestinationDomainInfo":{ "shape":"DomainInformation", "documentation":"

Specifies the `DomainInformation` for the destination Elasticsearch domain.

" }, "CrossClusterSearchConnectionId":{ "shape":"CrossClusterSearchConnectionId", "documentation":"

Specifies the connection id for the outbound cross-cluster search connection.

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

Specifies the connection alias for the outbound cross-cluster search connection.

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

Specifies the `OutboundCrossClusterSearchConnectionStatus` for the outbound connection.

" } }, "documentation":"

Specifies details of an outbound connection.

" }, "OutboundCrossClusterSearchConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"OutboundCrossClusterSearchConnectionStatusCode", "documentation":"

The state code for outbound connection. This 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 destination domain owner.
- PROVISIONING: Outbound connection request is in process.
- ACTIVE: Outbound connection is active and ready to use.
- REJECTED: Outbound connection request is rejected by destination domain owner.
- DELETING: Outbound connection deletion is in progress.
- DELETED: Outbound connection is deleted and cannot be used further.

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

Specifies verbose information for the outbound connection status.

" } }, "documentation":"

Specifies the connection status of an outbound cross-cluster search connection.

" }, "OutboundCrossClusterSearchConnectionStatusCode":{ "type":"string", "enum":[ "PENDING_ACCEPTANCE", "VALIDATING", "VALIDATION_FAILED", "PROVISIONING", "ACTIVE", "REJECTED", "DELETING", "DELETED" ] }, "OutboundCrossClusterSearchConnections":{ "type":"list", "member":{"shape":"OutboundCrossClusterSearchConnection"} }, "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 }, "PackageDescription":{ "type":"string", "max":1024 }, "PackageDetails":{ "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":"

Currently supports only TXT-DICTIONARY.

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

User-specified description of the package.

" }, "PackageStatus":{ "shape":"PackageStatus", "documentation":"

Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

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

Timestamp which tells creation date of the package.

" }, "LastUpdatedAt":{"shape":"LastUpdated"}, "AvailablePackageVersion":{"shape":"PackageVersion"}, "ErrorDetails":{ "shape":"ErrorDetails", "documentation":"

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

" } }, "documentation":"

Basic information about a package.

" }, "PackageDetailsList":{ "type":"list", "member":{"shape":"PackageDetails"} }, "PackageID":{"type":"string"}, "PackageName":{ "type":"string", "max":28, "min":3, "pattern":"[a-z][a-z0-9\\-]+" }, "PackageSource":{ "type":"structure", "members":{ "S3BucketName":{ "shape":"S3BucketName", "documentation":"

Name of the bucket containing the package.

" }, "S3Key":{ "shape":"S3Key", "documentation":"

Key (file name) of the package.

" } }, "documentation":"

The S3 location for importing the package specified as `S3BucketName` and `S3Key`

" }, "PackageStatus":{ "type":"string", "enum":[ "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED" ] }, "PackageType":{ "type":"string", "enum":["TXT-DICTIONARY"] }, "PackageVersion":{"type":"string"}, "PackageVersionHistory":{ "type":"structure", "members":{ "PackageVersion":{ "shape":"PackageVersion", "documentation":"

Version of the package.

" }, "CommitMessage":{ "shape":"CommitMessage", "documentation":"

A message associated with the version.

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

Timestamp which tells creation time of the package version.

" } }, "documentation":"

Details of a package version.

" }, "PackageVersionHistoryList":{ "type":"list", "member":{"shape":"PackageVersionHistory"} }, "Password":{ "type":"string", "min":8, "sensitive":true }, "PolicyDocument":{ "type":"string", "documentation":"

Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

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

Specifies the type of AWS account permitted to manage VPC endpoints.:

- AWS_ACCOUNT: Indicates that the account is owned by an AWS user.
- AWS_SERVICE: Indicates the the account is owned by an AWS service.

", "enum":[ "AWS_ACCOUNT", "AWS_SERVICE" ] }, "PurchaseReservedElasticsearchInstanceOfferingRequest":{ "type":"structure", "required":[ "ReservedElasticsearchInstanceOfferingId", "ReservationName" ], "members":{ "ReservedElasticsearchInstanceOfferingId":{ "shape":"GUID", "documentation":"

The ID of the reserved Elasticsearch instance offering to purchase.

" }, "ReservationName":{ "shape":"ReservationToken", "documentation":"

A customer-specified identifier to track this reservation.

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

The number of Elasticsearch instances to reserve.

" } }, "documentation":"

Container for parameters to `PurchaseReservedElasticsearchInstanceOffering`

" }, "PurchaseReservedElasticsearchInstanceOfferingResponse":{ "type":"structure", "members":{ "ReservedElasticsearchInstanceId":{ "shape":"GUID", "documentation":"

Details of the reserved Elasticsearch instance which was purchased.

" }, "ReservationName":{ "shape":"ReservationToken", "documentation":"

The customer-specified identifier used to track this reservation.

" } }, "documentation":"

Represents the output of a `PurchaseReservedElasticsearchInstanceOffering` 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 a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

" }, "RecurringChargeList":{ "type":"list", "member":{"shape":"RecurringCharge"} }, "ReferencePath":{"type":"string"}, "Region":{"type":"string"}, "RejectInboundCrossClusterSearchConnectionRequest":{ "type":"structure", "required":["CrossClusterSearchConnectionId"], "members":{ "CrossClusterSearchConnectionId":{ "shape":"CrossClusterSearchConnectionId", "documentation":"

The id of the inbound connection that you want to reject.

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

Container for the parameters to the `RejectInboundCrossClusterSearchConnection` operation.

" }, "RejectInboundCrossClusterSearchConnectionResponse":{ "type":"structure", "members":{ "CrossClusterSearchConnection":{ "shape":"InboundCrossClusterSearchConnection", "documentation":"

Specifies the `InboundCrossClusterSearchConnection` of rejected inbound connection.

" } }, "documentation":"

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

" }, "RemoveTagsRequest":{ "type":"structure", "required":[ "ARN", "TagKeys" ], "members":{ "ARN":{ "shape":"ARN", "documentation":"

Specifies the `ARN` for the Elasticsearch domain from which you want to delete the specified tags.

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

Specifies the `TagKey` list which you want to remove from the Elasticsearch domain.

" } }, "documentation":"

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

" }, "ReservationToken":{ "type":"string", "max":64, "min":5 }, "ReservedElasticsearchInstance":{ "type":"structure", "members":{ "ReservationName":{ "shape":"ReservationToken", "documentation":"

The customer-specified identifier to track this reservation.

" }, "ReservedElasticsearchInstanceId":{ "shape":"GUID", "documentation":"

The unique identifier for the reservation.

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

The offering identifier.

" }, "ElasticsearchInstanceType":{ "shape":"ESPartitionInstanceType", "documentation":"

The Elasticsearch instance type offered by the reserved instance offering.

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

The time the reservation started.

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

The duration, in seconds, for which the Elasticsearch instance is reserved.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The rate you are charged for each hour for the domain that is using this reserved instance.

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

The currency code for the reserved Elasticsearch instance offering.

" }, "ElasticsearchInstanceCount":{ "shape":"Integer", "documentation":"

The number of Elasticsearch instances that have been reserved.

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

The state of the reserved Elasticsearch instance.

" }, "PaymentOption":{ "shape":"ReservedElasticsearchInstancePaymentOption", "documentation":"

The payment option as defined in the reserved Elasticsearch instance offering.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The charge to your account regardless of whether you are creating any domains using the instance offering.

" } }, "documentation":"

Details of a reserved Elasticsearch instance.

" }, "ReservedElasticsearchInstanceList":{ "type":"list", "member":{"shape":"ReservedElasticsearchInstance"} }, "ReservedElasticsearchInstanceOffering":{ "type":"structure", "members":{ "ReservedElasticsearchInstanceOfferingId":{ "shape":"GUID", "documentation":"

The Elasticsearch reserved instance offering identifier.

" }, "ElasticsearchInstanceType":{ "shape":"ESPartitionInstanceType", "documentation":"

The Elasticsearch instance type offered by the reserved instance offering.

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

The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The rate you are charged for each hour the domain that is using the offering is running.

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

The currency code for the reserved Elasticsearch instance offering.

" }, "PaymentOption":{ "shape":"ReservedElasticsearchInstancePaymentOption", "documentation":"

Payment option for the reserved Elasticsearch instance offering

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The charge to your account regardless of whether you are creating any domains using the instance offering.

" } }, "documentation":"

Details of a reserved Elasticsearch instance offering.

" }, "ReservedElasticsearchInstanceOfferingList":{ "type":"list", "member":{"shape":"ReservedElasticsearchInstanceOffering"} }, "ReservedElasticsearchInstancePaymentOption":{ "type":"string", "enum":[ "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT" ] }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

An exception for creating a resource that already exists. Gives http status code of 400.

", "error":{"httpStatusCode":409}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

", "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.

" } }, "documentation":"

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

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

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

" }, "RoleArn":{ "type":"string", "max":2048, "min":20 }, "RollbackOnDisable":{ "type":"string", "documentation":"

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

", "enum":[ "NO_ROLLBACK", "DEFAULT_ROLLBACK" ] }, "S3BucketName":{ "type":"string", "max":63, "min":3 }, "S3Key":{"type":"string"}, "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 SAML Identity Provider.

" } }, "documentation":"

Specifies the SAML Identity Provider's information.

" }, "SAMLMetadata":{ "type":"string", "max":1048576, "min":1 }, "SAMLOptionsInput":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

True if SAML is enabled.

" }, "Idp":{ "shape":"SAMLIdp", "documentation":"

Specifies the SAML Identity Provider's information.

" }, "MasterUserName":{ "shape":"Username", "documentation":"

The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.

" }, "MasterBackendRole":{ "shape":"BackendRole", "documentation":"

The backend role to which the SAML master user is mapped to.

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

The key to use for matching the SAML Subject attribute.

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

The key to use for matching the SAML Roles attribute.

" }, "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":"

Specifies the SAML application configuration for the 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.

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

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

", "enum":[ "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING" ] }, "ScheduledAutoTuneDescription":{ "type":"string", "documentation":"

Specifies Auto-Tune action description.

" }, "ScheduledAutoTuneDetails":{ "type":"structure", "members":{ "Date":{ "shape":"AutoTuneDate", "documentation":"

Specifies timestamp for the Auto-Tune action scheduled for the domain.

" }, "ActionType":{ "shape":"ScheduledAutoTuneActionType", "documentation":"

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

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

Specifies Auto-Tune action description.

" }, "Severity":{ "shape":"ScheduledAutoTuneSeverityType", "documentation":"

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

" } }, "documentation":"

Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

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

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

", "enum":[ "LOW", "MEDIUM", "HIGH" ] }, "ServiceSoftwareOptions":{ "type":"structure", "members":{ "CurrentVersion":{ "shape":"String", "documentation":"

The current service software version that is present on the domain.

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

The new service software version if one is available.

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

`True` if you are able to update you service software version. `False` if you are not able to update your service software version.

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

`True` if you are able to cancel your service software version update. `False` if you are not able to cancel your service software version.

" }, "UpdateStatus":{ "shape":"DeploymentStatus", "documentation":"

The status of your service software update. This field can take the following values: `ELIGIBLE`, `PENDING_UPDATE`, `IN_PROGRESS`, `COMPLETED`, and `NOT_ELIGIBLE`.

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

The description of the `UpdateStatus`.

" }, "AutomatedUpdateDate":{ "shape":"DeploymentCloseDateTimeStamp", "documentation":"

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

" } }, "documentation":"

The current options of an Elasticsearch domain service software options.

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

The endpoint to which service requests are submitted. For example, `search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com` or `doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com`.

" }, "SnapshotOptions":{ "type":"structure", "members":{ "AutomatedSnapshotStartHour":{ "shape":"IntegerClass", "documentation":"

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is `0` hours.

" } }, "documentation":"

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is `0` hours.

" }, "SnapshotOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"SnapshotOptions", "documentation":"

Specifies the daily snapshot options specified for the Elasticsearch domain.

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

Specifies the status of a daily automated snapshot.

" } }, "documentation":"

Status of a daily automated snapshot.

" }, "StartAt":{"type":"timestamp"}, "StartElasticsearchServiceSoftwareUpdateRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain that you want to update to the latest service software.

" } }, "documentation":"

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

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

The current status of the Elasticsearch service software update.

" } }, "documentation":"

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

" }, "StartTimestamp":{"type":"timestamp"}, "StorageSubTypeName":{ "type":"string", "documentation":"

SubType of the given storage type. List of available sub-storage options: For \"instance\" storageType we wont have any storageSubType, in case of \"ebs\" storageType we will have following valid storageSubTypes

1. standard
2. gp2
3. gp3
4. io1

Refer `VolumeType` for more information regarding above EBS storage options. " }, "StorageType":{ "type":"structure", "members":{ "StorageTypeName":{"shape":"StorageTypeName"}, "StorageSubTypeName":{"shape":"StorageSubTypeName"}, "StorageTypeLimits":{ "shape":"StorageTypeLimitList", "documentation":"

List of limits that are applicable for given storage type.

" } }, "documentation":"

StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

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

Name of storage limits that are applicable for given storage type. If `StorageType` is ebs, following storage options are applicable

1. MinimumVolumeSize
Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
2. MaximumVolumeSize
Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
3. MaximumIops
Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
4. MinimumIops
Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
5. MaximumThroughput
Maximum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
6. MinimumThroughput
Minimum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.

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

Values for the `StorageTypeLimit$LimitName` .

" } }, "documentation":"

Limits that are applicable for given storage type.

" }, "StorageTypeLimitList":{ "type":"list", "member":{"shape":"StorageTypeLimit"} }, "StorageTypeList":{ "type":"list", "member":{"shape":"StorageType"} }, "StorageTypeName":{ "type":"string", "documentation":"

Type of the storage. List of available storage options:

1. instance
Inbuilt storage available for the given Instance
2. ebs
Elastic block storage that would be attached to the given 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":"

Specifies the `TagKey`, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

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

Specifies the `TagValue`, the value assigned to the corresponding tag key. Tag values can be null and do not 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":"

Specifies a key value pair for a resource tag.

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

A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

", "max":128, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "documentation":"

A list of `Tag`

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

A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.

", "max":256, "min":0 }, "TimeUnit":{ "type":"string", "documentation":"

Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.

", "enum":["HOURS"] }, "TotalNumberOfStages":{"type":"integer"}, "UIntValue":{ "type":"integer", "min":0 }, "UpdateElasticsearchDomainConfigRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the Elasticsearch domain that you are updating.

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

The type and number of instances to instantiate for the domain cluster.

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

Specify the type and size of the EBS volume that you want to use.

" }, "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 VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

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

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

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

Modifies the advanced option to allow references to indices in an HTTP request body. Must be `false` when configuring access to individual sub-resources. By default, the value is `true`. See Configuration Advanced Options for more information.

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

IAM access policy as a JSON-formatted string.

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

Map of `LogType` and `LogPublishingOption`, each containing options to publish a given type of Elasticsearch log.

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

Options to specify configuration that will be applied to the domain endpoint.

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

Specifies advanced security options.

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

Specifies the NodeToNodeEncryptionOptions.

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

Specifies the Encryption At Rest Options.

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

Specifies Auto-Tune options.

" }, "DryRun":{ "shape":"DryRun", "documentation":"

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

" } }, "documentation":"

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

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

The status of the updated Elasticsearch domain.

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

Contains result of DryRun.

" } }, "documentation":"

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

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

Unique identifier for the package.

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

New description of the package.

" }, "CommitMessage":{ "shape":"CommitMessage", "documentation":"

An info message for the new version which will be shown as part of `GetPackageVersionHistoryResponse`.

" } }, "documentation":"

Container for request parameters to `UpdatePackage` operation.

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

Information about the package `PackageDetails`.

" } }, "documentation":"

Container for response returned by `UpdatePackage` operation.

" }, "UpdateTimestamp":{"type":"timestamp"}, "UpdateVpcEndpointRequest":{ "type":"structure", "required":[ "VpcEndpointId", "VpcOptions" ], "members":{ "VpcEndpointId":{ "shape":"VpcEndpointId", "documentation":"

Unique identifier of the VPC endpoint to be updated.

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

The security groups and/or subnets to add, remove, or modify.

" } }, "documentation":"

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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

The endpoint to be updated.

" } }, "documentation":"

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

" }, "UpgradeElasticsearchDomainRequest":{ "type":"structure", "required":[ "DomainName", "TargetVersion" ], "members":{ "DomainName":{"shape":"DomainName"}, "TargetVersion":{ "shape":"ElasticsearchVersionString", "documentation":"

The version of Elasticsearch that you intend to upgrade the domain to.

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

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

" } }, "documentation":"

Container for request parameters to `UpgradeElasticsearchDomain` operation.

" }, "UpgradeElasticsearchDomainResponse":{ "type":"structure", "members":{ "DomainName":{"shape":"DomainName"}, "TargetVersion":{ "shape":"ElasticsearchVersionString", "documentation":"

The version of Elasticsearch that you intend to upgrade the domain to.

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

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

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

Container for response returned by `UpgradeElasticsearchDomain` operation.

" }, "UpgradeHistory":{ "type":"structure", "members":{ "UpgradeName":{ "shape":"UpgradeName", "documentation":"

A string that describes the update briefly

" }, "StartTimestamp":{ "shape":"StartTimestamp", "documentation":"

UTC Timestamp at which the Upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.

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

The overall status of the update. The status can take one of the following values:

- In Progress
- Succeeded
- Succeeded with Issues
- Failed

" }, "StepsList":{ "shape":"UpgradeStepsList", "documentation":"

A list of `UpgradeStepItem` s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

" } }, "documentation":"

History of the last 10 Upgrades and Upgrade Eligibility Checks.

" }, "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":"

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

- PreUpgradeCheck
- Snapshot
- Upgrade

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

The status of a particular step during an 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 progress percentage of a particular step.

" } }, "documentation":"

Represents a single step of the 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", "min":1, "sensitive":true }, "VPCDerivedInfo":{ "type":"structure", "members":{ "VPCId":{ "shape":"String", "documentation":"

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

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

Specifies the subnets for VPC endpoint.

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

The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

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

Specifies the security groups for VPC endpoint.

" } }, "documentation":"

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" }, "VPCDerivedInfoStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"VPCDerivedInfo", "documentation":"

Specifies the VPC options for the specified Elasticsearch domain.

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

Specifies the status of the VPC options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the VPC options for the specified Elasticsearch domain.

" }, "VPCOptions":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"StringList", "documentation":"

Specifies the subnets for VPC endpoint.

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

Specifies the security groups for VPC endpoint.

" } }, "documentation":"

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

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

An exception for missing / invalid input fields. Gives http status code of 400.

", "error":{"httpStatusCode":400}, "exception":true }, "ValueStringList":{ "type":"list", "member":{"shape":"NonEmptyString"}, "min":1 }, "VolumeType":{ "type":"string", "documentation":"

The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.

", "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", "documentation":"

Specifies the error code of the failure encountered while describing the VPC endpoint:

- ENDPOINT_NOT_FOUND: Indicates that the requested VPC endpoint does not exist.
- SERVER_ERROR: Indicates the describe endpoint operation failed due to an internal server error.

", "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", "documentation":"

Specifies the current status of the VPC endpoint:

- CREATING: Indicates that the VPC endpoint is currently being created.
- CREATE_FAILED: Indicates that the VPC endpoint creation failed.
- ACTIVE: Indicates that the VPC endpoint is currently active.
- UPDATING: Indicates that the VPC endpoint is currently being updated.
- UPDATE_FAILED: Indicates that the VPC endpoint update failed.
- DELETING: Indicates that the VPC endpoint is currently being deleted.
- DELETE_FAILED: Indicates that the VPC endpoint deletion failed.

", "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"} }, "ZoneAwarenessConfig":{ "type":"structure", "members":{ "AvailabilityZoneCount":{ "shape":"IntegerClass", "documentation":"

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled

" } }, "documentation":"

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

" } }, "documentation":"Amazon Elasticsearch Configuration Service

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

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

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

" }