Allows the remote domain owner to accept an inbound cross-cluster connection request.
" }, "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/2021-01-01/tags" }, "input":{"shape":"AddTagsRequest"}, "errors":[ {"shape":"BaseException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
" }, "AssociatePackage":{ "name":"AssociatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/associate/{PackageID}/{DomainName}" }, "input":{"shape":"AssociatePackageRequest"}, "output":{"shape":"AssociatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"} ], "documentation":"Associates a package with an Amazon OpenSearch Service domain.
" }, "CancelServiceSoftwareUpdate":{ "name":"CancelServiceSoftwareUpdate", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/serviceSoftwareUpdate/cancel" }, "input":{"shape":"CancelServiceSoftwareUpdateRequest"}, "output":{"shape":"CancelServiceSoftwareUpdateResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
" }, "CreateOutboundConnection":{ "name":"CreateOutboundConnection", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/cc/outboundConnection" }, "input":{"shape":"CreateOutboundConnectionRequest"}, "output":{"shape":"CreateOutboundConnectionResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InternalException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"DisabledOperationException"} ], "documentation":"Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
" }, "CreatePackage":{ "name":"CreatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages" }, "input":{"shape":"CreatePackageRequest"}, "output":{"shape":"CreatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidTypeException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Create a package for use with Amazon OpenSearch Service domains.
" }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}" }, "input":{"shape":"DeleteDomainRequest"}, "output":{"shape":"DeleteDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
" }, "DeleteInboundConnection":{ "name":"DeleteInboundConnection", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}" }, "input":{"shape":"DeleteInboundConnectionRequest"}, "output":{"shape":"DeleteInboundConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"Allows the remote domain owner to delete an existing inbound cross-cluster connection.
" }, "DeleteOutboundConnection":{ "name":"DeleteOutboundConnection", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}" }, "input":{"shape":"DeleteOutboundConnectionRequest"}, "output":{"shape":"DeleteOutboundConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"Allows the local domain owner to delete an existing outbound cross-cluster connection.
" }, "DeletePackage":{ "name":"DeletePackage", "http":{ "method":"DELETE", "requestUri":"/2021-01-01/packages/{PackageID}" }, "input":{"shape":"DeletePackageRequest"}, "output":{"shape":"DeletePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"} ], "documentation":"Deletes the package.
" }, "DescribeDomain":{ "name":"DescribeDomain", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}" }, "input":{"shape":"DescribeDomainRequest"}, "output":{"shape":"DescribeDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
" }, "DescribeDomainAutoTunes":{ "name":"DescribeDomainAutoTunes", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/autoTunes" }, "input":{"shape":"DescribeDomainAutoTunesRequest"}, "output":{"shape":"DescribeDomainAutoTunesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
" }, "DescribeDomainConfig":{ "name":"DescribeDomainConfig", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/config" }, "input":{"shape":"DescribeDomainConfigRequest"}, "output":{"shape":"DescribeDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
" }, "DescribeDomains":{ "name":"DescribeDomains", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain-info" }, "input":{"shape":"DescribeDomainsRequest"}, "output":{"shape":"DescribeDomainsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ValidationException"} ], "documentation":"Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
" }, "DescribeInboundConnections":{ "name":"DescribeInboundConnections", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/cc/inboundConnection/search" }, "input":{"shape":"DescribeInboundConnectionsRequest"}, "output":{"shape":"DescribeInboundConnectionsResponse"}, "errors":[ {"shape":"InvalidPaginationTokenException"}, {"shape":"DisabledOperationException"} ], "documentation":"Lists all the inbound cross-cluster connections for a remote domain.
" }, "DescribeInstanceTypeLimits":{ "name":"DescribeInstanceTypeLimits", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}" }, "input":{"shape":"DescribeInstanceTypeLimitsRequest"}, "output":{"shape":"DescribeInstanceTypeLimitsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":" Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.
Lists all the outbound cross-cluster connections for a local domain.
" }, "DescribePackages":{ "name":"DescribePackages", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/describe" }, "input":{"shape":"DescribePackagesRequest"}, "output":{"shape":"DescribePackagesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
" }, "DescribeReservedInstanceOfferings":{ "name":"DescribeReservedInstanceOfferings", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/reservedInstanceOfferings" }, "input":{"shape":"DescribeReservedInstanceOfferingsRequest"}, "output":{"shape":"DescribeReservedInstanceOfferingsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"} ], "documentation":"Lists available reserved OpenSearch instance offerings.
" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/reservedInstances" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"}, {"shape":"ValidationException"}, {"shape":"DisabledOperationException"} ], "documentation":"Returns information about reserved OpenSearch instances for this account.
" }, "DissociatePackage":{ "name":"DissociatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/dissociate/{PackageID}/{DomainName}" }, "input":{"shape":"DissociatePackageRequest"}, "output":{"shape":"DissociatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"} ], "documentation":"Dissociates a package from the Amazon OpenSearch Service domain.
" }, "GetCompatibleVersions":{ "name":"GetCompatibleVersions", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/compatibleVersions" }, "input":{"shape":"GetCompatibleVersionsRequest"}, "output":{"shape":"GetCompatibleVersionsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":" Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.
Returns a list of package versions, along with their creation time and commit message.
" }, "GetUpgradeHistory":{ "name":"GetUpgradeHistory", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/upgradeDomain/{DomainName}/history" }, "input":{"shape":"GetUpgradeHistoryRequest"}, "output":{"shape":"GetUpgradeHistoryResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"Retrieves the complete history of the last 10 upgrades performed on the domain.
" }, "GetUpgradeStatus":{ "name":"GetUpgradeStatus", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/upgradeDomain/{DomainName}/status" }, "input":{"shape":"GetUpgradeStatusRequest"}, "output":{"shape":"GetUpgradeStatusResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
" }, "ListDomainNames":{ "name":"ListDomainNames", "http":{ "method":"GET", "requestUri":"/2021-01-01/domain" }, "input":{"shape":"ListDomainNamesRequest"}, "output":{"shape":"ListDomainNamesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ValidationException"} ], "documentation":"Returns the names of all domains owned by the current user's account.
" }, "ListDomainsForPackage":{ "name":"ListDomainsForPackage", "http":{ "method":"GET", "requestUri":"/2021-01-01/packages/{PackageID}/domains" }, "input":{"shape":"ListDomainsForPackageRequest"}, "output":{"shape":"ListDomainsForPackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Lists all Amazon OpenSearch Service domains associated with the package.
" }, "ListInstanceTypeDetails":{ "name":"ListInstanceTypeDetails", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}" }, "input":{"shape":"ListInstanceTypeDetailsRequest"}, "output":{"shape":"ListInstanceTypeDetailsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ] }, "ListPackagesForDomain":{ "name":"ListPackagesForDomain", "http":{ "method":"GET", "requestUri":"/2021-01-01/domain/{DomainName}/packages" }, "input":{"shape":"ListPackagesForDomainRequest"}, "output":{"shape":"ListPackagesForDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Lists all packages associated with the Amazon OpenSearch Service domain.
" }, "ListTags":{ "name":"ListTags", "http":{ "method":"GET", "requestUri":"/2021-01-01/tags/" }, "input":{"shape":"ListTagsRequest"}, "output":{"shape":"ListTagsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"Returns all tags for the given domain.
" }, "ListVersions":{ "name":"ListVersions", "http":{ "method":"GET", "requestUri":"/2021-01-01/opensearch/versions" }, "input":{"shape":"ListVersionsRequest"}, "output":{"shape":"ListVersionsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"List all supported versions of OpenSearch and Elasticsearch.
" }, "PurchaseReservedInstanceOffering":{ "name":"PurchaseReservedInstanceOffering", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/purchaseReservedInstanceOffering" }, "input":{"shape":"PurchaseReservedInstanceOfferingRequest"}, "output":{"shape":"PurchaseReservedInstanceOfferingResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"Allows you to purchase reserved OpenSearch instances.
" }, "RejectInboundConnection":{ "name":"RejectInboundConnection", "http":{ "method":"PUT", "requestUri":"/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject" }, "input":{"shape":"RejectInboundConnectionRequest"}, "output":{"shape":"RejectInboundConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DisabledOperationException"} ], "documentation":"Allows the remote domain owner to reject an inbound cross-cluster connection request.
" }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/2021-01-01/tags-removal" }, "input":{"shape":"RemoveTagsRequest"}, "errors":[ {"shape":"BaseException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"Removes the specified set of tags from the given domain.
" }, "StartServiceSoftwareUpdate":{ "name":"StartServiceSoftwareUpdate", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/serviceSoftwareUpdate/start" }, "input":{"shape":"StartServiceSoftwareUpdateRequest"}, "output":{"shape":"StartServiceSoftwareUpdateResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Schedules a service software update for an Amazon OpenSearch Service domain.
" }, "UpdateDomainConfig":{ "name":"UpdateDomainConfig", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/domain/{DomainName}/config" }, "input":{"shape":"UpdateDomainConfigRequest"}, "output":{"shape":"UpdateDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
" }, "UpdatePackage":{ "name":"UpdatePackage", "http":{ "method":"POST", "requestUri":"/2021-01-01/packages/update" }, "input":{"shape":"UpdatePackageRequest"}, "output":{"shape":"UpdatePackageResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Updates a package for use with Amazon OpenSearch Service domains.
" }, "UpgradeDomain":{ "name":"UpgradeDomain", "http":{ "method":"POST", "requestUri":"/2021-01-01/opensearch/upgradeDomain" }, "input":{"shape":"UpgradeDomainRequest"}, "output":{"shape":"UpgradeDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"DisabledOperationException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
" } }, "shapes":{ "ARN":{ "type":"string", "documentation":"The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
", "max":2048, "min":20, "pattern":".*" }, "AWSDomainInformation":{ "type":"structure", "required":["DomainName"], "members":{ "OwnerId":{"shape":"OwnerId"}, "DomainName":{"shape":"DomainName"}, "Region":{"shape":"Region"} } }, "AcceptInboundConnectionRequest":{ "type":"structure", "required":["ConnectionId"], "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"The ID of the inbound connection you want to accept.
", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"Container for the parameters to the AcceptInboundConnection operation.
The InboundConnection of the accepted inbound connection.
The result of an AcceptInboundConnection operation. Contains details about the accepted inbound connection.
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 domain. Access policies can 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 domain. See OptionStatus for the status information that's included.
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 of the domain you want to add tags to.
List of Tag to add to the domain.
Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
Additional limit is specific to a given InstanceType and for each of its InstanceRole etc.
Attributes and their details:
ESPartitionInstanceType can support as master node. ESPartitionInstanceType up to which you don't need any master nodes to govern them. Value for a given AdditionalLimit$LimitName .
List of limits that are specific to a given InstanceType and for each of its InstanceRole .
Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:
false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information. For more information, see Advanced cluster parameters.
" }, "AdvancedOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"AdvancedOptions", "documentation":"The status of advanced options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The OptionStatus for advanced options for the specified domain.
Status of the advanced options for the specified domain. Currently, the following advanced options are available:
false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information. For more information, see Advanced cluster parameters.
" }, "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.
" } }, "documentation":"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":"The SAML application configuration for the domain.
" } }, "documentation":"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":"Advanced security options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"Status of the advanced security options for the specified domain.
" } }, "documentation":"The status of advanced security options for the specified domain.
" }, "AssociatePackageRequest":{ "type":"structure", "required":[ "PackageID", "DomainName" ], "members":{ "PackageID":{ "shape":"PackageID", "documentation":"Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
The name of the domain to associate the package with.
", "location":"uri", "locationName":"DomainName" } }, "documentation":" Container for the request parameters to the AssociatePackage operation.
DomainPackageDetails
Container for the response returned by AssociatePackage operation.
Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
" }, "AutoTuneDetails":{ "shape":"AutoTuneDetails", "documentation":"Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "documentation":"Specifies the Auto-Tune type and Auto-Tune action details.
" }, "AutoTuneDate":{ "type":"timestamp", "documentation":"The timestamp of the Auto-Tune action scheduled for the domain.
" }, "AutoTuneDesiredState":{ "type":"string", "documentation":"The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
", "enum":[ "ENABLED", "DISABLED" ] }, "AutoTuneDetails":{ "type":"structure", "members":{ "ScheduledAutoTuneDetails":{"shape":"ScheduledAutoTuneDetails"} }, "documentation":"Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
" }, "AutoTuneList":{ "type":"list", "member":{"shape":"AutoTune"} }, "AutoTuneMaintenanceSchedule":{ "type":"structure", "members":{ "StartAt":{ "shape":"StartAt", "documentation":"The timestamp at which the Auto-Tune maintenance schedule starts.
" }, "Duration":{ "shape":"Duration", "documentation":"Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
" }, "CronExpressionForRecurrence":{ "shape":"String", "documentation":"A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "documentation":"Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
" }, "AutoTuneMaintenanceScheduleList":{ "type":"list", "member":{"shape":"AutoTuneMaintenanceSchedule"}, "max":100 }, "AutoTuneOptions":{ "type":"structure", "members":{ "DesiredState":{ "shape":"AutoTuneDesiredState", "documentation":"The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
" }, "RollbackOnDisable":{ "shape":"RollbackOnDisable", "documentation":"The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
" }, "MaintenanceSchedules":{ "shape":"AutoTuneMaintenanceScheduleList", "documentation":"A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "documentation":"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":"The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
" }, "MaintenanceSchedules":{ "shape":"AutoTuneMaintenanceScheduleList", "documentation":"A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "documentation":"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":"The AutoTuneState for the domain.
The error message while enabling or disabling Auto-Tune.
" } }, "documentation":"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 domain.
" }, "Status":{ "shape":"AutoTuneStatus", "documentation":"The status of the Auto-Tune options for the domain.
" } }, "documentation":"The Auto-Tune status for the domain.
" }, "AutoTuneState":{ "type":"string", "documentation":"The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.
", "enum":[ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR" ] }, "AutoTuneStatus":{ "type":"structure", "required":[ "CreationDate", "UpdateDate", "State" ], "members":{ "CreationDate":{ "shape":"UpdateTimestamp", "documentation":"The timestamp of the Auto-Tune options creation date.
" }, "UpdateDate":{ "shape":"UpdateTimestamp", "documentation":"The timestamp of when the Auto-Tune options were last updated.
" }, "UpdateVersion":{ "shape":"UIntValue", "documentation":"The latest version of the Auto-Tune options.
" }, "State":{ "shape":"AutoTuneState", "documentation":"The AutoTuneState for the domain.
The error message while enabling or disabling Auto-Tune.
" }, "PendingDeletion":{ "shape":"Boolean", "documentation":"Indicates whether the domain is being deleted.
" } }, "documentation":"Provides the current Auto-Tune status for the domain.
" }, "AutoTuneType":{ "type":"string", "documentation":"Specifies the 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"}, "CancelServiceSoftwareUpdateRequest":{ "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 CancelServiceSoftwareUpdate operation. Specifies the name of the domain that you wish to cancel a service software update on.
The current status of the OpenSearch service software update.
" } }, "documentation":"The result of a CancelServiceSoftwareUpdate operation. Contains the status of the update.
ARN of the Cloudwatch log group to publish logs to.
", "max":2048, "min":20, "pattern":".*" }, "ClusterConfig":{ "type":"structure", "members":{ "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"The instance type for an OpenSearch 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 Dedicated master nodes in Amazon OpenSearch Service for more information.
" }, "ZoneAwarenessEnabled":{ "shape":"Boolean", "documentation":"A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
" }, "ZoneAwarenessConfig":{ "shape":"ZoneAwarenessConfig", "documentation":"The zone awareness configuration for a domain when zone awareness is enabled.
" }, "DedicatedMasterType":{ "shape":"OpenSearchPartitionInstanceType", "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 UltraWarm storage.
" }, "WarmType":{ "shape":"OpenSearchWarmPartitionInstanceType", "documentation":"The instance type for the OpenSearch cluster's warm nodes.
" }, "WarmCount":{ "shape":"IntegerClass", "documentation":"The number of UltraWarm nodes in the cluster.
" }, "ColdStorageOptions":{ "shape":"ColdStorageOptions", "documentation":"Specifies the ColdStorageOptions config for a Domain
The configuration for the domain cluster, such as the type and number of instances.
" }, "ClusterConfigStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"ClusterConfig", "documentation":"The cluster configuration for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The cluster configuration status for the specified domain.
" } }, "documentation":"The configuration status for the specified domain.
" }, "CognitoOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"The option to enable Cognito for OpenSearch Dashboards authentication.
" }, "UserPoolId":{ "shape":"UserPoolId", "documentation":"The Cognito user pool ID for OpenSearch Dashboards authentication.
" }, "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"The Cognito identity pool ID for OpenSearch Dashboards authentication.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The role ARN that provides OpenSearch permissions for accessing Cognito resources.
" } }, "documentation":"Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" }, "CognitoOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"CognitoOptions", "documentation":"Cognito options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the Cognito options for the specified domain.
" } }, "documentation":"The status of the Cognito options for the specified domain.
" }, "ColdStorageOptions":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"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 }, "CompatibleVersionsList":{ "type":"list", "member":{"shape":"CompatibleVersionsMap"} }, "CompatibleVersionsMap":{ "type":"structure", "members":{ "SourceVersion":{ "shape":"VersionString", "documentation":"The current version of OpenSearch a domain is on.
" }, "TargetVersions":{"shape":"VersionList"} }, "documentation":" A map from an EngineVersion to a list of compatible EngineVersion s to which the domain can be upgraded.
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":100, "min":2, "pattern":"[a-zA-Z][a-zA-Z0-9\\-\\_]+" }, "ConnectionId":{ "type":"string", "max":256, "min":10, "pattern":"[a-z][a-z0-9\\-]+" }, "ConnectionStatusMessage":{"type":"string"}, "CreateDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
" }, "EngineVersion":{ "shape":"VersionString", "documentation":"String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, \"OpenSearch_1.0\" or \"Elasticsearch_7.9\". For more information, see Creating and managing Amazon OpenSearch Service domains .
" }, "ClusterConfig":{ "shape":"ClusterConfig", "documentation":"Configuration options for a domain. Specifies the instance type and number of instances in the domain.
" }, "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 a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
" }, "CognitoOptions":{ "shape":"CognitoOptions", "documentation":"Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" }, "EncryptionAtRestOptions":{ "shape":"EncryptionAtRestOptions", "documentation":"Options for encryption of data at rest.
" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"Node-to-node encryption options.
" }, "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 Advanced cluster parameters for more information.
Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
Options to specify configurations that will be applied to the domain endpoint.
" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsInput", "documentation":"Specifies advanced security options.
" }, "TagList":{ "shape":"TagList", "documentation":"A list of Tag added during domain creation.
Specifies Auto-Tune options.
" } } }, "CreateDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{ "shape":"DomainStatus", "documentation":"The status of the newly created domain.
" } }, "documentation":"The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.
The AWSDomainInformation for the local OpenSearch domain.
The AWSDomainInformation for the remote OpenSearch domain.
The connection alias used used by the customer for this cross-cluster connection.
" } }, "documentation":"Container for the parameters to the CreateOutboundConnection operation.
The AWSDomainInformation for the local OpenSearch domain.
The AWSDomainInformation for the remote OpenSearch domain.
The connection alias provided during the create connection request.
" }, "ConnectionStatus":{ "shape":"OutboundConnectionStatus", "documentation":"The OutboundConnectionStatus for the newly created connection.
The unique ID for the created outbound connection, which is used for subsequent operations on the connection.
" } }, "documentation":"The result of a CreateOutboundConnection request. Contains the details about the newly created cross-cluster connection.
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 Amazon S3 location from which to import the package.
" } }, "documentation":" Container for request parameters to the CreatePackage operation.
Information about the package.
" } }, "documentation":" Container for the response returned by the CreatePackage operation.
The name of the domain you want to permanently delete.
", "location":"uri", "locationName":"DomainName" } }, "documentation":"Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.
The status of the domain being deleted.
" } }, "documentation":"The result of a DeleteDomain request. Contains the status of the pending deletion, or a \"domain not found\" error if the domain and all of its resources have been deleted.
The ID of the inbound connection to permanently delete.
", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"Container for the parameters to the DeleteInboundConnection operation.
The InboundConnection of the deleted inbound connection.
The result of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
The ID of the outbound connection you want to permanently delete.
", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"Container for the parameters to the DeleteOutboundConnection operation.
The OutboundConnection of the deleted outbound connection.
The result of a DeleteOutboundConnection operation. Contains details about the deleted outbound connection.
The internal ID of the package you want to delete. Use DescribePackages to find this value.
Container for the request parameters to the DeletePackage operation.
PackageDetails
Container for the response parameters to the DeletePackage operation.
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. Used for pagination.
" } }, "documentation":"Container for the parameters to the DescribeDomainAutoTunes operation.
The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.
" }, "NextToken":{ "shape":"NextToken", "documentation":"An identifier to allow retrieval of paginated results.
" } }, "documentation":"The result of a DescribeDomainAutoTunes request. See Auto-Tune for Amazon OpenSearch Service for more information.
The domain you want to get information about.
", "location":"uri", "locationName":"DomainName" } }, "documentation":"Container for the parameters to the DescribeDomainConfig operation. Specifies the domain name for which you want configuration information.
The configuration information of the domain requested in the DescribeDomainConfig request.
The result of a DescribeDomainConfig request. Contains the configuration information of the requested domain.
The name of the domain for which you want information.
", "location":"uri", "locationName":"DomainName" } }, "documentation":"Container for the parameters to the DescribeDomain operation.
The current status of the domain.
" } }, "documentation":"The result of a DescribeDomain request. Contains the status of the domain specified in the request.
The domains for which you want information.
" } }, "documentation":"Container for the parameters to the DescribeDomains operation. By default, the API returns the status of all domains.
The status of the domains requested in the DescribeDomains request.
The result of a DescribeDomains request. Contains the status of the specified domains or all domains owned by the account.
A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are:
Set this value to limit the number of results returned. If not specified, defaults to 100.
" }, "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":"Container for the parameters to the DescribeInboundConnections operation.
A list of InboundConnection matching the specified filter criteria.
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 DescribeInboundConnections request. Contains a list of connections matching the filter criteria.
The name of the domain you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.
The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.
Version of OpenSearch for which Limits are needed.
Container for the parameters to the DescribeInstanceTypeLimits operation.
Container for the parameters received from the DescribeInstanceTypeLimits operation.
A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are:
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 parameter. Used for pagination.
" } }, "documentation":"Container for the parameters to the DescribeOutboundConnections operation.
A list of OutboundConnection matching the specified filter criteria.
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 DescribeOutboundConnections request. Contains the list of connections matching the filter criteria.
Any field from PackageDetails.
A list of values for the specified field.
" } }, "documentation":"A filter to apply to the DescribePackage response.
A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
Only returns packages that match the DescribePackagesFilterList values.
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 the request parameters to the DescribePackage operation.
List of PackageDetails objects.
Container for the response returned by the DescribePackages operation.
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":"Provides an identifier to allow retrieval of paginated results.
", "location":"querystring", "locationName":"nextToken" } }, "documentation":"Container for parameters to DescribeReservedInstanceOfferings
Provides an identifier to allow retrieval of paginated results.
" }, "ReservedInstanceOfferings":{ "shape":"ReservedInstanceOfferingList", "documentation":"List of reserved OpenSearch instance offerings
" } }, "documentation":"Container for results from DescribeReservedInstanceOfferings
The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
", "location":"querystring", "locationName":"reservationId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"Set this value to limit the number of results returned. If not specified, defaults to 100.
", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"Provides an identifier to allow retrieval of paginated results.
", "location":"querystring", "locationName":"nextToken" } }, "documentation":"Container for parameters to DescribeReservedInstances
Provides an identifier to allow retrieval of paginated results.
" }, "ReservedInstances":{ "shape":"ReservedInstanceList", "documentation":"List of reserved OpenSearch instances.
" } }, "documentation":"Container for results from DescribeReservedInstances
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":"The internal ID of the package to associate with a domain. Use DescribePackages to find this value.
The name of the domain to associate the package with.
", "location":"uri", "locationName":"DomainName" } }, "documentation":" Container for the request parameters to the DissociatePackage operation.
DomainPackageDetails
Container for the response returned by DissociatePackage operation.
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
" }, "ClusterConfig":{ "shape":"ClusterConfigStatus", "documentation":"The ClusterConfig for the domain.
The EBSOptions for the domain.
IAM access policy as a JSON-formatted string.
" }, "SnapshotOptions":{ "shape":"SnapshotOptionsStatus", "documentation":"The SnapshotOptions for the domain.
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
The EncryptionAtRestOptions for the domain.
The NodeToNodeEncryptionOptions for the domain.
The AdvancedOptions for the domain. See Advanced options for more information.
Log publishing options for the given domain.
" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptionsStatus", "documentation":"The DomainEndpointOptions for the domain.
Specifies AdvancedSecurityOptions for the domain.
Specifies AutoTuneOptions for the domain.
The configuration of a domain.
" }, "DomainEndpointOptions":{ "type":"structure", "members":{ "EnforceHTTPS":{ "shape":"Boolean", "documentation":"Whether only HTTPS endpoint should be enabled for the domain.
" }, "TLSSecurityPolicy":{ "shape":"TLSSecurityPolicy", "documentation":"Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Whether to enable a custom endpoint for the domain.
" }, "CustomEndpoint":{ "shape":"DomainNameFqdn", "documentation":"The fully qualified domain for your custom endpoint.
" }, "CustomEndpointCertificateArn":{ "shape":"ARN", "documentation":"The ACM certificate ARN for your custom endpoint.
" } }, "documentation":"Options to configure the endpoint for the domain.
" }, "DomainEndpointOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"DomainEndpointOptions", "documentation":"Options to configure the endpoint for the domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the endpoint options for the domain. See OptionStatus for the status information that's included.
The configured endpoint options for the domain and their current status.
" }, "DomainId":{ "type":"string", "documentation":"Unique identifier for the domain.
", "max":64, "min":1 }, "DomainInfo":{ "type":"structure", "members":{ "DomainName":{ "shape":"DomainName", "documentation":"The DomainName.
Specifies the EngineType of the domain.
Contains the list of domain information.
" }, "DomainInformationContainer":{ "type":"structure", "members":{ "AWSDomainInformation":{"shape":"AWSDomainInformation"} } }, "DomainName":{ "type":"string", "documentation":"The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
", "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 domain names.
" }, "DomainPackageDetails":{ "type":"structure", "members":{ "PackageID":{ "shape":"PackageID", "documentation":"The 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":"The timestamp of the most recent update to the package association status.
" }, "DomainName":{ "shape":"DomainName", "documentation":"The 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, and DISSOCIATION_FAILED.
" }, "PackageVersion":{"shape":"PackageVersion"}, "ReferencePath":{ "shape":"ReferencePath", "documentation":"The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.
" }, "ErrorDetails":{ "shape":"ErrorDetails", "documentation":"Additional information if the package is in an error state. Null otherwise.
" } }, "documentation":"Information on a package associated with a domain.
" }, "DomainPackageDetailsList":{ "type":"list", "member":{"shape":"DomainPackageDetails"} }, "DomainPackageStatus":{ "type":"string", "enum":[ "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED" ] }, "DomainStatus":{ "type":"structure", "required":[ "DomainId", "DomainName", "ARN", "ClusterConfig" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The unique identifier for the specified domain.
" }, "DomainName":{ "shape":"DomainName", "documentation":"The name of a 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 a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
" }, "Created":{ "shape":"Boolean", "documentation":"The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
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.
The domain endpoint that you use to submit index and search requests.
" }, "Endpoints":{ "shape":"EndpointsMap", "documentation":"Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
The type and number of instances in the domain.
" }, "EBSOptions":{ "shape":"EBSOptions", "documentation":"The EBSOptions for the specified domain.
IAM access policy as a JSON-formatted string.
" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"The status of the SnapshotOptions.
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
The status of the EncryptionAtRestOptions.
The status of the NodeToNodeEncryptionOptions.
The status of the AdvancedOptions.
Log publishing options for the given domain.
" }, "ServiceSoftwareOptions":{ "shape":"ServiceSoftwareOptions", "documentation":"The current status of the domain's service software.
" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", "documentation":"The current status of the domain's endpoint options.
" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptions", "documentation":"The current status of the domain's advanced security options.
" }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsOutput", "documentation":"The current status of the domain's Auto-Tune options.
" } }, "documentation":"The current status of a domain.
" }, "DomainStatusList":{ "type":"list", "member":{"shape":"DomainStatus"}, "documentation":"A list that contains the status of each requested domain.
" }, "Double":{"type":"double"}, "Duration":{ "type":"structure", "members":{ "Value":{ "shape":"DurationValue", "documentation":"Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
" }, "Unit":{ "shape":"TimeUnit", "documentation":"The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "documentation":"The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
" }, "DurationValue":{ "type":"long", "documentation":"Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
", "max":24, "min":1 }, "EBSOptions":{ "type":"structure", "members":{ "EBSEnabled":{ "shape":"Boolean", "documentation":"Whether EBS-based storage is enabled.
" }, "VolumeType":{ "shape":"VolumeType", "documentation":"The volume type for EBS-based storage.
" }, "VolumeSize":{ "shape":"IntegerClass", "documentation":"Integer to specify the size of an EBS volume.
" }, "Iops":{ "shape":"IntegerClass", "documentation":"The IOPD for a Provisioned IOPS EBS volume (SSD).
" } }, "documentation":"Options to enable, disable, and specify the properties of EBS storage volumes.
" }, "EBSOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"EBSOptions", "documentation":"The EBS options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the EBS options for the specified domain.
" } }, "documentation":"Status of the EBS options for the specified domain.
" }, "EncryptionAtRestOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"The option to enable encryption at rest.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The KMS key ID for encryption at rest options.
" } }, "documentation":"Specifies encryption at rest options.
" }, "EncryptionAtRestOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"EncryptionAtRestOptions", "documentation":"The Encryption At Rest options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the Encryption At Rest options for the specified domain.
" } }, "documentation":"Status of the encryption At Rest options for the specified domain.
" }, "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":"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 connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
" }, "FilterList":{ "type":"list", "member":{"shape":"Filter"} }, "GUID":{ "type":"string", "max":36, "min":36, "pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}" }, "GetCompatibleVersionsRequest":{ "type":"structure", "members":{ "DomainName":{ "shape":"DomainName", "location":"querystring", "locationName":"domainName" } }, "documentation":" Container for the request parameters to GetCompatibleVersions operation.
A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.
Container for the response returned by the GetCompatibleVersions operation.
Returns an audit history of package versions.
", "location":"uri", "locationName":"PackageID" }, "MaxResults":{ "shape":"MaxResults", "documentation":"Limits results to a maximum number of package 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 the request parameters to the GetPackageVersionHistory operation.
List of PackageVersionHistory objects.
Container for response returned by GetPackageVersionHistory operation.
Container for the request parameters to the GetUpgradeHistory operation.
A list of UpgradeHistory objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the GetUpgradeHistoryResponse object.
Pagination token that needs to be supplied to the next call to get the next page of results.
" } }, "documentation":" Container for the response returned by the GetUpgradeHistory operation.
Container for the request parameters to the GetUpgradeStatus operation.
One of three steps an upgrade or upgrade eligibility check goes through:
One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:
A string that briefly describes the update.
" } }, "documentation":" Container for the response returned by the GetUpgradeStatus operation.
The AWSDomainInformation for the local OpenSearch domain.
The AWSDomainInformation for the remote OpenSearch domain.
The connection ID for the inbound cross-cluster connection.
" }, "ConnectionStatus":{ "shape":"InboundConnectionStatus", "documentation":"The InboundConnectionStatus for the outbound connection.
Details of an inbound connection.
" }, "InboundConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"InboundConnectionStatusCode", "documentation":"The state code for the inbound connection. Can be one of the following:
Verbose information for the inbound connection status.
" } }, "documentation":"The connection status of an inbound cross-cluster connection.
" }, "InboundConnectionStatusCode":{ "type":"string", "enum":[ "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED" ] }, "InboundConnections":{ "type":"list", "member":{"shape":"InboundConnection"} }, "InstanceCount":{ "type":"integer", "documentation":"The number of EC2 instances in the domain.
", "min":1 }, "InstanceCountLimits":{ "type":"structure", "members":{ "MinimumInstanceCount":{"shape":"MinimumInstanceCount"}, "MaximumInstanceCount":{"shape":"MaximumInstanceCount"} }, "documentation":"InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.
" }, "InstanceLimits":{ "type":"structure", "members":{ "InstanceCountLimits":{"shape":"InstanceCountLimits"} }, "documentation":"InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.
" }, "InstanceRole":{"type":"string"}, "InstanceRoleList":{ "type":"list", "member":{"shape":"InstanceRole"} }, "InstanceTypeDetails":{ "type":"structure", "members":{ "InstanceType":{"shape":"OpenSearchPartitionInstanceType"}, "EncryptionEnabled":{"shape":"Boolean"}, "CognitoEnabled":{"shape":"Boolean"}, "AppLogsEnabled":{"shape":"Boolean"}, "AdvancedSecurityEnabled":{"shape":"Boolean"}, "WarmEnabled":{"shape":"Boolean"}, "InstanceRole":{"shape":"InstanceRoleList"} } }, "InstanceTypeDetailsList":{ "type":"list", "member":{"shape":"InstanceTypeDetails"} }, "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, "pattern":".*" }, "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":"Storage-related types and attributes that are available for a given InstanceType.
" }, "InstanceLimits":{"shape":"InstanceLimits"}, "AdditionalLimits":{ "shape":"AdditionalLimitList", "documentation":" List of additional limits that are specific to a given InstanceType and for each of its InstanceRole .
Limits for a given InstanceType and for each of its roles.
Limits contains the following: StorageTypes , InstanceLimits , and AdditionalLimits
The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:
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.
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.
The package for which to list associated domains.
", "location":"uri", "locationName":"PackageID" }, "MaxResults":{ "shape":"MaxResults", "documentation":"Limits the 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 the request parameters to the ListDomainsForPackage operation.
List of DomainPackageDetails objects.
Container for the response parameters to the ListDomainsForPackage operation.
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 the request parameters to the ListPackagesForDomain operation.
List of DomainPackageDetails objects.
Pagination token to supply to the next call to get the next page of results.
" } }, "documentation":" Container for the response parameters to the ListPackagesForDomain operation.
Specify the ARN of the domain that the tags you want to view are attached to.
Container for the parameters to the ListTags operation. Specify the ARN of the domain that the tags you want to view are attached to.
List of Tag for the requested domain.
The result of a ListTags operation. Contains tags for all requested domains.
Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.
", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"nextToken" } }, "documentation":" Container for the parameters to the ListVersions operation.
Use MaxResults to control the maximum number of results to retrieve in a single call.
Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, there are no more results to retrieve.
Container for the parameters for response received from the ListVersions operation.
Whether the given log publishing option is enabled or not.
" } }, "documentation":"Log Publishing option that is set for a given domain.
Attributes and their details:
The log publishing options configured for the domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the log publishing options for the domain. See OptionStatus for the status information that's included.
The configured log publishing options for the domain and their current status.
" }, "LogType":{ "type":"string", "documentation":"Type of log file. Can be one of the following:
ARN for the master user (if IAM is enabled).
" }, "MasterUserName":{ "shape":"Username", "documentation":"The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.
" }, "MasterUserPassword":{ "shape":"Password", "documentation":"The master user's password, which is stored in the Amazon OpenSearch 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 a given InstanceType.
" }, "MinimumInstanceCount":{ "type":"integer", "documentation":"Minimum number of instances that can be instantiated for a given InstanceType.
" }, "NextToken":{ "type":"string", "documentation":"Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.
" }, "NodeToNodeEncryptionOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"True to enable node-to-node encryption.
" } }, "documentation":"The node-to-node encryption options.
" }, "NodeToNodeEncryptionOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"The node-to-node encryption options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the node-to-node encryption options for the specified domain.
" } }, "documentation":"Status of the node-to-node encryption options for the specified domain.
" }, "NonEmptyString":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9\\-\\_\\.]+" }, "OpenSearchPartitionInstanceType":{ "type":"string", "enum":[ "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search" ] }, "OpenSearchWarmPartitionInstanceType":{ "type":"string", "enum":[ "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search" ] }, "OptionState":{ "type":"string", "documentation":"The state of a requested change. One of the following:
The timestamp of when the entity was created.
" }, "UpdateDate":{ "shape":"UpdateTimestamp", "documentation":"The timestamp of the last time the entity was updated.
" }, "UpdateVersion":{ "shape":"UIntValue", "documentation":"The latest version of the entity.
" }, "State":{ "shape":"OptionState", "documentation":"Provides the OptionState for the domain.
Indicates whether the domain is being deleted.
" } }, "documentation":"Provides the current status of the entity.
" }, "OutboundConnection":{ "type":"structure", "members":{ "LocalDomainInfo":{ "shape":"DomainInformationContainer", "documentation":"The DomainInformation for the local OpenSearch domain.
The DomainInformation for the remote OpenSearch domain.
The connection ID for the outbound cross-cluster connection.
" }, "ConnectionAlias":{ "shape":"ConnectionAlias", "documentation":"The connection alias for the outbound cross-cluster connection.
" }, "ConnectionStatus":{ "shape":"OutboundConnectionStatus", "documentation":"The OutboundConnectionStatus for the outbound connection.
Specifies details about an outbound connection.
" }, "OutboundConnectionStatus":{ "type":"structure", "members":{ "StatusCode":{ "shape":"OutboundConnectionStatusCode", "documentation":"The state code for the outbound connection. Can be one of the following:
Verbose information for the outbound connection status.
" } }, "documentation":"The connection status of an outbound cross-cluster connection.
" }, "OutboundConnectionStatusCode":{ "type":"string", "enum":[ "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED" ] }, "OutboundConnections":{ "type":"list", "member":{"shape":"OutboundConnection"} }, "OwnerId":{ "type":"string", "max":12, "min":12, "pattern":"[0-9]+" }, "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, and DELETE_FAILED.
" }, "CreatedAt":{ "shape":"CreatedAt", "documentation":"The timestamp of when the package was created.
" }, "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":"The name of the Amazon S3 bucket containing the package.
" }, "S3Key":{ "shape":"S3Key", "documentation":"Key (file name) of the package.
" } }, "documentation":"The Amazon S3 location for importing the package specified as S3BucketName and S3Key
The package version.
" }, "CommitMessage":{ "shape":"CommitMessage", "documentation":"A message associated with the package version.
" }, "CreatedAt":{ "shape":"CreatedAt", "documentation":"The timestamp of when the package was created.
" } }, "documentation":"Details of a package version.
" }, "PackageVersionHistoryList":{ "type":"list", "member":{"shape":"PackageVersionHistory"} }, "Password":{ "type":"string", "max":128, "min":8, "pattern":".*", "sensitive":true }, "PolicyDocument":{ "type":"string", "documentation":"Access policy rules for a domain service endpoints. For more information, see Configuring access policies . The maximum size of a policy document is 100 KB.
", "max":102400, "min":0, "pattern":".*" }, "PurchaseReservedInstanceOfferingRequest":{ "type":"structure", "required":[ "ReservedInstanceOfferingId", "ReservationName" ], "members":{ "ReservedInstanceOfferingId":{ "shape":"GUID", "documentation":"The ID of the reserved OpenSearch instance offering to purchase.
" }, "ReservationName":{ "shape":"ReservationToken", "documentation":"A customer-specified identifier to track this reservation.
" }, "InstanceCount":{ "shape":"InstanceCount", "documentation":"The number of OpenSearch instances to reserve.
" } }, "documentation":"Container for parameters to PurchaseReservedInstanceOffering
Details of the reserved OpenSearch instance which was purchased.
" }, "ReservationName":{ "shape":"ReservationToken", "documentation":"The customer-specified identifier used to track this reservation.
" } }, "documentation":"Represents the output of a PurchaseReservedInstanceOffering operation.
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 OpenSearch instance, or for a reserved OpenSearch instance offering.
" }, "RecurringChargeList":{ "type":"list", "member":{"shape":"RecurringCharge"} }, "ReferencePath":{"type":"string"}, "Region":{ "type":"string", "max":30, "min":5, "pattern":"[a-z][a-z0-9\\-]+" }, "RejectInboundConnectionRequest":{ "type":"structure", "required":["ConnectionId"], "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"The ID of the inbound connection to reject.
", "location":"uri", "locationName":"ConnectionId" } }, "documentation":"Container for the parameters to the RejectInboundConnection operation.
The InboundConnection of the rejected inbound connection.
The result of a RejectInboundConnection operation. Contains details about the rejected inbound connection.
The ARN of the domain from which you want to delete the specified tags.
The TagKey list you want to remove from the domain.
Container for the parameters to the RemoveTags operation. Specify the ARN for the domain from which you want to remove the specified TagKey.
The customer-specified identifier to track this reservation.
" }, "ReservedInstanceId":{ "shape":"GUID", "documentation":"The unique identifier for the reservation.
" }, "BillingSubscriptionId":{"shape":"Long"}, "ReservedInstanceOfferingId":{ "shape":"String", "documentation":"The offering identifier.
" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"The OpenSearch 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 OpenSearch instance is reserved.
" }, "FixedPrice":{ "shape":"Double", "documentation":"The upfront fixed charge you will paid to purchase the specific reserved OpenSearch 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 OpenSearch instance offering.
" }, "InstanceCount":{ "shape":"Integer", "documentation":"The number of OpenSearch instances that have been reserved.
" }, "State":{ "shape":"String", "documentation":"The state of the reserved OpenSearch instance.
" }, "PaymentOption":{ "shape":"ReservedInstancePaymentOption", "documentation":"The payment option as defined in the reserved OpenSearch 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 OpenSearch instance.
" }, "ReservedInstanceList":{ "type":"list", "member":{"shape":"ReservedInstance"} }, "ReservedInstanceOffering":{ "type":"structure", "members":{ "ReservedInstanceOfferingId":{ "shape":"GUID", "documentation":"The OpenSearch reserved instance offering identifier.
" }, "InstanceType":{ "shape":"OpenSearchPartitionInstanceType", "documentation":"The OpenSearch instance type offered by the reserved instance offering.
" }, "Duration":{ "shape":"Integer", "documentation":"The duration, in seconds, for which the offering will reserve the OpenSearch instance.
" }, "FixedPrice":{ "shape":"Double", "documentation":"The upfront fixed charge you will pay to purchase the specific reserved OpenSearch 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 OpenSearch instance offering.
" }, "PaymentOption":{ "shape":"ReservedInstancePaymentOption", "documentation":"Payment option for the reserved OpenSearch 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 OpenSearch instance offering.
" }, "ReservedInstanceOfferingList":{ "type":"list", "member":{"shape":"ReservedInstanceOffering"} }, "ReservedInstancePaymentOption":{ "type":"string", "enum":[ "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT" ] }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"An exception for creating a resource that already exists. 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 }, "RoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*" }, "RollbackOnDisable":{ "type":"string", "documentation":"The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
", "enum":[ "NO_ROLLBACK", "DEFAULT_ROLLBACK" ] }, "S3BucketName":{ "type":"string", "max":63, "min":3 }, "S3Key":{ "type":"string", "max":1024, "min":1 }, "SAMLEntityId":{ "type":"string", "max":512, "min":8 }, "SAMLIdp":{ "type":"structure", "required":[ "MetadataContent", "EntityId" ], "members":{ "MetadataContent":{ "shape":"SAMLMetadata", "documentation":"The metadata of the SAML application in XML format.
" }, "EntityId":{ "shape":"SAMLEntityId", "documentation":"The unique entity ID of the application in SAML identity provider.
" } }, "documentation":"The SAML identity povider'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":"The SAML Identity Provider's information.
" }, "MasterUserName":{ "shape":"Username", "documentation":"The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
" }, "MasterBackendRole":{ "shape":"BackendRole", "documentation":"The backend role that the SAML master user is mapped to.
" }, "SubjectKey":{ "shape":"String", "documentation":"Element of the SAML assertion to use for username. Default is NameID.
" }, "RolesKey":{ "shape":"String", "documentation":"Element of the SAML assertion to use for backend roles. Default is roles.
" }, "SessionTimeoutMinutes":{ "shape":"IntegerClass", "documentation":"The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
" } }, "documentation":"The SAML 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":"The 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":"The Auto-Tune action description.
" }, "ScheduledAutoTuneDetails":{ "type":"structure", "members":{ "Date":{ "shape":"AutoTuneDate", "documentation":"The timestamp of the Auto-Tune action scheduled for the domain.
" }, "ActionType":{ "shape":"ScheduledAutoTuneActionType", "documentation":"The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
" }, "Action":{ "shape":"ScheduledAutoTuneDescription", "documentation":"The Auto-Tune action description.
" }, "Severity":{ "shape":"ScheduledAutoTuneSeverityType", "documentation":"The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
" } }, "documentation":"Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
" }, "ScheduledAutoTuneSeverityType":{ "type":"string", "documentation":"The 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 present on the domain.
" }, "NewVersion":{ "shape":"String", "documentation":"The new service software version if one is available.
" }, "UpdateAvailable":{ "shape":"Boolean", "documentation":" True if you're able to update your service software version. False if you can't update your service software version.
True if you're able to cancel your service software version update. False if you can't cancel your service software update.
The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
The description of the UpdateStatus.
The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
" }, "OptionalDeployment":{ "shape":"Boolean", "documentation":" True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
The current options of an 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.
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The daily snapshot options specified for the domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of a daily automated snapshot.
" } }, "documentation":"Status of a daily automated snapshot.
" }, "StartAt":{"type":"timestamp"}, "StartServiceSoftwareUpdateRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"The name of the domain that you want to update to the latest service software.
" } }, "documentation":"Container for the parameters to the StartServiceSoftwareUpdate operation. Specifies the name of the domain to schedule a service software update for.
The current status of the OpenSearch service software update.
" } }, "documentation":"The result of a StartServiceSoftwareUpdate operation. Contains the status of the update.
Sub-type of the given storage type. List of available sub-storage options: \"instance\" storageType has no storageSubType. \"ebs\" storageType has the following valid storageSubTypes:
VolumeType for more information regarding each EBS storage option. "
},
"StorageType":{
"type":"structure",
"members":{
"StorageTypeName":{"shape":"StorageTypeName"},
"StorageSubTypeName":{"shape":"StorageSubTypeName"},
"StorageTypeLimits":{
"shape":"StorageTypeLimitList",
"documentation":"Limits that are applicable for the given storage type.
" } }, "documentation":"StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.
" }, "StorageTypeLimit":{ "type":"structure", "members":{ "LimitName":{ "shape":"LimitName", "documentation":" Name of storage limits that are applicable for the given storage type. If StorageType is \"ebs\", the following storage options are applicable:
Values for the StorageTypeLimit$LimitName .
Limits that are applicable for the given storage type.
" }, "StorageTypeLimitList":{ "type":"list", "member":{"shape":"StorageTypeLimit"} }, "StorageTypeList":{ "type":"list", "member":{"shape":"StorageType"} }, "StorageTypeName":{ "type":"string", "documentation":"Type of storage. List of available storage options:
The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.
The TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
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 domain to which they're attached.
", "max":128, "min":1, "pattern":".*" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "documentation":"A list of Tag.
A string of length from 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.
", "max":256, "min":0, "pattern":".*" }, "TimeUnit":{ "type":"string", "documentation":"The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service for more information.
", "enum":["HOURS"] }, "UIntValue":{ "type":"integer", "min":0 }, "UpdateDomainConfigRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"The name of the domain you're updating.
", "location":"uri", "locationName":"DomainName" }, "ClusterConfig":{ "shape":"ClusterConfig", "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 to use.
" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
" }, "CognitoOptions":{ "shape":"CognitoOptions", "documentation":"Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" }, "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 Advanced options for more information.
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 OpenSearch log.
Specifies encryption of data at rest options.
" }, "DomainEndpointOptions":{ "shape":"DomainEndpointOptions", "documentation":"Options to specify configuration that will be applied to the domain endpoint.
" }, "NodeToNodeEncryptionOptions":{ "shape":"NodeToNodeEncryptionOptions", "documentation":"Specifies node-to-node encryption options.
" }, "AdvancedSecurityOptions":{ "shape":"AdvancedSecurityOptionsInput", "documentation":"Specifies advanced security options.
" }, "AutoTuneOptions":{ "shape":"AutoTuneOptions", "documentation":"Specifies Auto-Tune options.
" } }, "documentation":"Container for the parameters to the UpdateDomain operation. Specifies the type and number of instances in the domain cluster.
The status of the updated domain.
" } }, "documentation":"The result of an UpdateDomain request. Contains the status of the domain being updated.
The unique identifier for the package.
" }, "PackageSource":{"shape":"PackageSource"}, "PackageDescription":{ "shape":"PackageDescription", "documentation":"A new description of the package.
" }, "CommitMessage":{ "shape":"CommitMessage", "documentation":"A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.
Container for request parameters to the UpdatePackage operation.
Information about the package.
" } }, "documentation":" Container for the response returned by the UpdatePackage operation.
The version of OpenSearch you intend to upgrade the domain to.
" }, "PerformCheckOnly":{ "shape":"Boolean", "documentation":"When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
" }, "AdvancedOptions":{"shape":"AdvancedOptions"} }, "documentation":" Container for the request parameters to UpgradeDomain operation.
The version of OpenSearch that you intend to upgrade the domain to.
" }, "PerformCheckOnly":{ "shape":"Boolean", "documentation":"When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
" }, "AdvancedOptions":{"shape":"AdvancedOptions"} }, "documentation":" Container for response returned by UpgradeDomain operation.
A string that briefly describes the upgrade.
" }, "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 current status of the upgrade. The status can take one of the following values:
A list of UpgradeStepItem s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.
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":"One of three steps an upgrade or upgrade eligibility check goes through:
The current status of the upgrade. The status can take one of the following values:
A list of strings containing detailed information about the errors encountered in a particular step.
" }, "ProgressPercent":{ "shape":"Double", "documentation":"The floating point value representing the progress percentage of a particular step.
" } }, "documentation":"Represents a single step of 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", "max":64, "min":1, "pattern":".*", "sensitive":true }, "VPCDerivedInfo":{ "type":"structure", "members":{ "VPCId":{ "shape":"String", "documentation":"The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
The subnets for the VPC endpoint.
" }, "AvailabilityZones":{ "shape":"StringList", "documentation":"The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.
The security groups for the VPC endpoint.
" } }, "documentation":"Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
" }, "VPCDerivedInfoStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"VPCDerivedInfo", "documentation":"The VPC options for the specified domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the VPC options for the specified domain.
" } }, "documentation":"Status of the VPC options for the specified domain.
" }, "VPCOptions":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"StringList", "documentation":"The subnets for the VPC endpoint.
" }, "SecurityGroupIds":{ "shape":"StringList", "documentation":"The security groups for the VPC endpoint.
" } }, "documentation":"Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
" }, "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 }, "VersionList":{ "type":"list", "member":{"shape":"VersionString"}, "documentation":"List of supported OpenSearch versions.
" }, "VersionStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"VersionString", "documentation":"The OpenSearch version for the specified OpenSearch domain.
" }, "Status":{ "shape":"OptionStatus", "documentation":"The status of the OpenSearch version options for the specified OpenSearch domain.
" } }, "documentation":"The status of the OpenSearch version options for the specified OpenSearch domain.
" }, "VersionString":{ "type":"string", "max":18, "min":14, "pattern":"^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$" }, "VolumeType":{ "type":"string", "documentation":"The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage for more information.
", "enum":[ "standard", "gp2", "io1" ] }, "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":"The zone awareness configuration for the domain cluster, such as the number of availability zones.
" } }, "documentation":"Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs.
The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
" }