Amazon OpenSearch Service API Es API
The Es API from Amazon OpenSearch Service API — 34 operation(s) for es.
Amazon OpenSearch Service API Es API is one of 5 APIs that Amazon OpenSearch Service API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Es. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.
This API exposes 37 operations across 34 paths, and defines 227 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://es.{region}.amazonaws.com, https://es.{region}.amazonaws.com, http://es.{region}.amazonaws.com.cn, https://es.{region}.amazonaws.com.cn.
37 operations
34 paths
227 schemas
5 DELETE15 GET15 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Amazon OpenSearch Service API Es API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 37
Across 34 paths, the API surfaces 37 operations — 5 DELETE, 15 GET, 15 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Es 37
PUT
/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
Amazon OpenSearch Accept Inbound Cross Cluster Search Connection
POST
/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
Amazon OpenSearch Authorize Vpc Endpoint Access
POST
/2015-01-01/es/serviceSoftwareUpdate/cancel
Amazon OpenSearch Cancel Elasticsearch Service Software Update
POST
/2015-01-01/es/domain
Amazon OpenSearch Create Elasticsearch Domain
POST
/2015-01-01/es/ccs/outboundConnection
Amazon OpenSearch Create Outbound Cross Cluster Search Connection
POST
/2015-01-01/es/vpcEndpoints
Amazon OpenSearch Create Vpc Endpoint
GET
/2015-01-01/es/vpcEndpoints
Amazon OpenSearch List Vpc Endpoints
DELETE
/2015-01-01/es/domain/{DomainName}
Amazon OpenSearch Delete Elasticsearch Domain
GET
/2015-01-01/es/domain/{DomainName}
Amazon OpenSearch Describe Elasticsearch Domain
DELETE
/2015-01-01/es/role
Amazon OpenSearch Delete Elasticsearch Service Role
DELETE
/2015-01-01/es/ccs/inboundConnection/{ConnectionId}
Amazon OpenSearch Delete Inbound Cross Cluster Search Connection
DELETE
/2015-01-01/es/ccs/outboundConnection/{ConnectionId}
Amazon OpenSearch Delete Outbound Cross Cluster Search Connection
DELETE
/2015-01-01/es/vpcEndpoints/{VpcEndpointId}
Amazon OpenSearch Delete Vpc Endpoint
GET
/2015-01-01/es/domain/{DomainName}/autoTunes
Amazon OpenSearch Describe Domain Auto Tunes
GET
/2015-01-01/es/domain/{DomainName}/progress
Amazon OpenSearch Describe Domain Change Progress
GET
/2015-01-01/es/domain/{DomainName}/config
Amazon OpenSearch Describe Elasticsearch Domain Config
POST
/2015-01-01/es/domain/{DomainName}/config
Amazon OpenSearch Update Elasticsearch Domain Config
POST
/2015-01-01/es/domain-info
Amazon OpenSearch Describe Elasticsearch Domains
GET
/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
Amazon OpenSearch Describe Elasticsearch Instance Type Limits
POST
/2015-01-01/es/ccs/inboundConnection/search
Amazon OpenSearch Describe Inbound Cross Cluster Search Connections
POST
/2015-01-01/es/ccs/outboundConnection/search
Amazon OpenSearch Describe Outbound Cross Cluster Search Connections
GET
/2015-01-01/es/reservedInstanceOfferings
Amazon OpenSearch Describe Reserved Elasticsearch Instance Offerings
GET
/2015-01-01/es/reservedInstances
Amazon OpenSearch Describe Reserved Elasticsearch Instances
POST
/2015-01-01/es/vpcEndpoints/describe
Amazon OpenSearch Describe Vpc Endpoints
GET
/2015-01-01/es/compatibleVersions
Amazon OpenSearch Get Compatible Elasticsearch Versions
GET
/2015-01-01/es/upgradeDomain/{DomainName}/history
Amazon OpenSearch Get Upgrade History
GET
/2015-01-01/es/upgradeDomain/{DomainName}/status
Amazon OpenSearch Get Upgrade Status
GET
/2015-01-01/es/instanceTypes/{ElasticsearchVersion}
Amazon OpenSearch List Elasticsearch Instance Types
GET
/2015-01-01/es/versions
Amazon OpenSearch List Elasticsearch Versions
GET
/2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
Amazon OpenSearch List Vpc Endpoint Access
GET
/2015-01-01/es/domain/{DomainName}/vpcEndpoints
Amazon OpenSearch List Vpc Endpoints for Domain
POST
/2015-01-01/es/purchaseReservedInstanceOffering
Amazon OpenSearch Purchase Reserved Elasticsearch Instance Offering
PUT
/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
Amazon OpenSearch Reject Inbound Cross Cluster Search Connection
POST
/2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
Amazon OpenSearch Revoke Vpc Endpoint Access
POST
/2015-01-01/es/serviceSoftwareUpdate/start
Amazon OpenSearch Start Elasticsearch Service Software Update
POST
/2015-01-01/es/vpcEndpoints/update
Amazon OpenSearch Update Vpc Endpoint
POST
/2015-01-01/es/upgradeDomain
Amazon OpenSearch Upgrade Elasticsearch Domain
Schemas 227
The contract defines 227 schemas that model the data the API accepts and returns. The most detailed are ElasticsearchDomainStatus (25 properties), ElasticsearchDomainConfig (15 properties), ReservedElasticsearchInstance (13 properties), ElasticsearchClusterConfig (11 properties). Each schema is shown below with its type and property counts.
ElasticsearchInstanceTypeList
array
List of instance types supported by Amazon Elasticsearch service.
GetUpgradeHistoryResponse
object
Container for response returned by GetUpgradeHistory operation.
2 properties
ElasticsearchDomainConfig
object
The configuration of an Elasticsearch domain.
15 properties
ReservationToken
string
OverallChangeStatus
string
The overall status value of the domain configuration change.
DeploymentCloseDateTimeStamp
string
ChangeProgressStageName
string
EncryptionAtRestOptionsStatus
object
Status of the Encryption At Rest options for the specified Elasticsearch domain.
2 properties
2 required
InstanceCountLimits
object
InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
2 properties
DescribeDomainAutoTunesResponse
object
The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.
2 properties
LimitsByRole
object
Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following: data: If the given I…
SnapshotOptions
object
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
1 property
LimitValueList
array
UpdateVpcEndpointResponse
object
Contains the configuration and status of the VPC endpoint being updated.
1 property
1 required
AdvancedOptions
object
Exposes select native Elasticsearch configuration values from elasticsearch.yml . Currently, the following advanced options are available: Option to allow refe…
ColdStorageOptions
object
Specifies the configuration for cold storage options such as enabled
1 property
1 required
CompatibleVersionsMap
object
A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.
2 properties
ListVpcEndpointAccessResponse
object
Container for response parameters to the ListVpcEndpointAccess operation. Returns a list of accounts id and account type authorized to manage VPC endpoints.
2 properties
2 required
ResourceNotFoundException
CloudWatchLogsLogGroupArn
string
ARN of the Cloudwatch log group to which log needs to be published.
OutboundCrossClusterSearchConnection
object
Specifies details of an outbound connection.
5 properties
SAMLMetadata
string
OutboundCrossClusterSearchConnections
array
ReservedElasticsearchInstanceOffering
object
Details of a reserved Elasticsearch instance offering.
8 properties
GetUpgradeStatusResponse
object
Container for response returned by GetUpgradeStatus operation.
3 properties
UpgradeElasticsearchDomainResponse
object
Container for response returned by UpgradeElasticsearchDomain operation.
4 properties
DeploymentStatus
string
ChangeProgressStageStatus
string
TimeUnit
string
Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.
AuthorizedPrincipal
object
Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
2 properties
DeleteVpcEndpointResponse
object
Container for response parameters to the DeleteVpcEndpoint operation. Contains the summarized detail of the VPC Endpoint being deleted.
1 property
1 required
String
string
UpgradeStatus
string
VpcEndpointSummary
object
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
4 properties
GUID
string
Double
number
ChangeProgressStatusDetails
object
The progress details of a specific domain configuration change.
7 properties
AdditionalLimit
object
List of limits that are specific to a given InstanceType and for each of it's InstanceRole .
2 properties
NonEmptyString
string
ListElasticsearchVersionsResponse
object
Container for the parameters for response received from ListElasticsearchVersions operation.
2 properties
InboundCrossClusterSearchConnections
array
DeleteElasticsearchDomainResponse
object
The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been d…
1 property
VpcEndpoints
array
Endpoint
string
DescribeOutboundCrossClusterSearchConnectionsResponse
object
The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.
2 properties
UpgradeStepItem
object
Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
4 properties
Issues
array
DurationValue
integer
Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.
VpcEndpointErrorCode
string
Specifies the error code of the failure encountered while describing the VPC endpoint: ENDPOINTNOTFOUND: Indicates that the requested VPC endpoint does not exi…
TagValue
string
A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.
StartTimestamp
string
TLSSecurityPolicy
string
DescribeReservedElasticsearchInstanceOfferingsResponse
object
Container for results from DescribeReservedElasticsearchInstanceOfferings
2 properties
StartElasticsearchServiceSoftwareUpdateResponse
object
The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
1 property
LimitExceededException
GetCompatibleElasticsearchVersionsResponse
object
Container for response returned by GetCompatibleElasticsearchVersions operation.
1 property
Description
string
SAMLOptionsOutput
object
Describes the SAML application configured for the domain.
5 properties
CrossClusterSearchConnectionStatusMessage
string
AuthorizeVpcEndpointAccessResponse
object
Container for response parameters to the AuthorizeVpcEndpointAccess operation. Contains the account ID and the type of the account being authorized to access t…
1 property
1 required
DescribeElasticsearchDomainConfigResponse
object
The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.
1 property
1 required
ServiceSoftwareOptions
object
The current options of an Elasticsearch domain service software options.
8 properties
StorageTypeLimit
object
Limits that are applicable for given storage type.
2 properties
AutoTuneState
string
Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide .
AutoTune
object
Specifies Auto-Tune type and Auto-Tune action details.
2 properties
TagKey
string
A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
DomainEndpointOptionsStatus
object
The configured endpoint options for the domain and their current status.
2 properties
2 required
AccessPoliciesStatus
object
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
2 properties
2 required
ScheduledAutoTuneSeverityType
string
Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
UpdateTimestamp
string
DeploymentType
string
StorageTypeLimitList
array
Message
string
UpgradeStepsList
array
PolicyDocument
string
Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service De…
RoleArn
string
PrincipalType
string
Specifies the type of AWS account permitted to manage VPC endpoints.: AWSACCOUNT: Indicates that the account is owned by an AWS user. AWSSERVICE: Indicates the…
DescribeInboundCrossClusterSearchConnectionsResponse
object
The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.
2 properties
EBSOptionsStatus
object
Status of the EBS options for the specified Elasticsearch domain.
2 properties
2 required
OutboundCrossClusterSearchConnectionStatus
object
Specifies the connection status of an outbound cross-cluster search connection.
2 properties
UpgradeName
string
DomainNameFqdn
string
Integer
integer
LogPublishingOptionsStatus
object
The configured log publishing options for the domain and their current status.
2 properties
ResourceAlreadyExistsException
Boolean
boolean
ESWarmPartitionInstanceType
string
LastUpdated
string
UpgradeHistory
object
History of the last 10 Upgrades and Upgrade Eligibility Checks.
4 properties
DescribeElasticsearchInstanceTypeLimitsResponse
object
Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.
1 property
CreateElasticsearchDomainResponse
object
The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.
1 property
ZoneAwarenessConfig
object
Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.
1 property
OwnerId
string
InboundCrossClusterSearchConnectionStatus
object
Specifies the coonection status of an inbound cross-cluster search connection.
2 properties
VpcEndpointStatus
string
Specifies the current status of the VPC endpoint: CREATING: Indicates that the VPC endpoint is currently being created. CREATEFAILED: Indicates that the VPC en…
ChangeProgressStage
object
A progress stage details of a specific domain configuration change.
4 properties
NodeToNodeEncryptionOptions
object
Specifies the node-to-node encryption options.
1 property
DisableTimestamp
string
DeleteOutboundCrossClusterSearchConnectionResponse
object
The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection.
1 property
CreateOutboundCrossClusterSearchConnectionResponse
object
The result of a CreateOutboundCrossClusterSearchConnection request. Contains the details of the newly created cross-cluster search connection.
5 properties
StorageTypeName
string
Type of the storage. List of available storage options: instance Inbuilt storage available for the given Instance ebs Elastic block storage that would be attac…
AcceptInboundCrossClusterSearchConnectionResponse
object
The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection.
1 property
InboundCrossClusterSearchConnectionStatusCode
string
CognitoOptions
object
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana .
4 properties
AutoTuneStatus
object
Provides the current status of the Auto-Tune options.
6 properties
3 required
AutoTuneDetails
object
Specifies details of the Auto-Tune action. See the Developer Guide for more information.
1 property
InternalException
UpdateElasticsearchDomainConfigResponse
object
The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.
2 properties
1 required
InstanceLimits
object
InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
1 property
ValueStringList
array
DescribeElasticsearchDomainsResponse
object
The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.
1 property
1 required
ListElasticsearchInstanceTypesResponse
object
Container for the parameters returned by ListElasticsearchInstanceTypes operation.
2 properties
SAMLOptionsInput
object
Specifies the SAML application configuration for the domain.
7 properties
ListVpcEndpointsResponse
object
Container for response parameters to the ListVpcEndpoints operation. Returns a list containing summarized details of the VPC endpoints.
2 properties
2 required
ElasticsearchClusterConfigStatus
object
Specifies the configuration status for the specified Elasticsearch domain.
2 properties
2 required
TotalNumberOfStages
integer
DescribeVpcEndpointsResponse
object
Container for response parameters to the DescribeVpcEndpoints operation. Returns a list containing configuration details and status of the VPC Endpoints as wel…
2 properties
2 required
SnapshotOptionsStatus
object
Status of a daily automated snapshot.
2 properties
2 required
UpgradeHistoryList
array
AutoTuneMaintenanceSchedule
object
Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
3 properties
ReservedElasticsearchInstanceList
array
AdvancedSecurityOptions
object
Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
5 properties
DomainName
string
The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or n…
ScheduledAutoTuneDescription
string
Specifies Auto-Tune action description.
OptionState
string
The state of a requested change. One of the following: Processing: The request change is still in-process. Active: The request change is processed and deployed…
ScheduledAutoTuneActionType
string
Specifies Auto-Tune action type. Valid values are JVMHEAPSIZETUNING and JVMYOUNGGENTUNING.
Tag
object
Specifies a key value pair for a resource tag.
2 properties
2 required
UserPoolId
string
AdvancedSecurityOptionsStatus
object
Specifies the status of advanced security options for the specified Elasticsearch domain.
2 properties
2 required
VPCDerivedInfoStatus
object
Status of the VPC options for the specified Elasticsearch domain.
2 properties
2 required
ScheduledAutoTuneDetails
object
Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.
4 properties
LogPublishingOption
object
Log Publishing option that is set for given domain. Attributes and their details: CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs…
2 properties
CognitoOptionsStatus
object
Status of the Cognito options for the specified Elasticsearch domain.
2 properties
2 required
NodeToNodeEncryptionOptionsStatus
object
Status of the node-to-node encryption options for the specified Elasticsearch domain.
2 properties
2 required
ReservedElasticsearchInstancePaymentOption
string
ConnectionAlias
string
NextToken
string
Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve…
DeleteInboundCrossClusterSearchConnectionResponse
object
The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection.
1 property
MaximumInstanceCount
integer
Maximum number of Instances that can be instantiated for given InstanceType.
AutoTuneDesiredState
string
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
AutoTuneOptions
object
Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.
3 properties
ReservedElasticsearchInstance
object
Details of a reserved Elasticsearch instance.
13 properties
StorageTypeList
array
StorageSubTypeName
string
SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageT…
AutoTuneDate
string
Specifies timestamp for the Auto-Tune action scheduled for the domain.
ElasticsearchClusterConfig
object
Specifies the configuration for the domain cluster, such as the type and number of instances.
11 properties
DryRunResults
object
2 properties
MinimumInstanceCount
integer
Minimum number of Instances that can be instantiated for given InstanceType.
CrossClusterSearchConnectionId
string
VpcEndpointError
object
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
3 properties
OutboundCrossClusterSearchConnectionStatusCode
string
ElasticsearchVersionList
array
List of supported elastic search versions.
AutoTuneType
string
Specifies Auto-Tune type. Valid value is SCHEDULEDACTION.
DisabledOperationException
Limits
object
Limits for given InstanceType and for each of it's role. Limits contains following StorageTypes, InstanceLimits and AdditionalLimits
3 properties
ChangeProgressStageList
array
The list of progress stages of a specific domain configuration change.
DescribeElasticsearchDomainResponse
object
The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.
1 property
1 required
Filter
object
A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-clust…
2 properties
ESPartitionInstanceType
string
DescribeDomainChangeProgressResponse
object
The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change.
1 property
EndpointsMap
object
RejectInboundCrossClusterSearchConnectionResponse
object
The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection.
1 property
Region
string
InvalidTypeException
VpcEndpointId
string
StartAt
string
RevokeVpcEndpointAccessResponse
object
Container for response parameters to the RevokeVpcEndpointAccess operation. The response body for this operation is empty.
BaseException
ChangeProgressDetails
object
Specifies change details of the domain configuration change.
2 properties
Issue
string
EBSOptions
object
Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage .
5 properties
ElasticsearchDomainStatus
object
The current status of an Elasticsearch domain.
25 properties
4 required
VPCDerivedInfo
object
Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
4 properties
AWSAccount
string
ReservedElasticsearchInstanceOfferingList
array
UIntValue
integer
AutoTuneList
array
ElasticsearchVersionString
string
ElasticsearchVersionStatus
object
Status of the Elasticsearch version options for the specified Elasticsearch domain.
2 properties
2 required
MasterUserOptions
object
Credentials for the master user: username and password, ARN, or both.
3 properties
CreateVpcEndpointResponse
object
Container for response parameters to the CreateVpcEndpoint operation. Contains the configuration and status of the VPC Endpoint being created.
1 property
1 required
ConflictException
LogPublishingOptions
object
AutoTuneMaintenanceScheduleList
array
InboundCrossClusterSearchConnection
object
Specifies details of an inbound connection.
4 properties
RecurringChargeList
array
StorageType
object
StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
3 properties
CancelElasticsearchServiceSoftwareUpdateResponse
object
The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
1 property
IdentityPoolId
string
PurchaseReservedElasticsearchInstanceOfferingResponse
object
Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.
2 properties
SAMLIdp
object
Specifies the SAML Identity Provider's information.
2 properties
2 required
AutoTuneOptionsStatus
object
Specifies the status of Auto-Tune options for the specified Elasticsearch domain.
2 properties
VolumeType
string
The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storage for more information.
Duration
object
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
2 properties
VpcEndpointSummaryList
array
InvalidPaginationTokenException
DomainArn
string
StringList
array
AdditionalLimitList
array
IntegerClass
integer
CompatibleElasticsearchVersionsList
array
AutoTuneOptionsOutput
object
Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
2 properties
OptionStatus
object
Provides the current status of the entity.
5 properties
3 required
ARN
string
The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
ListVpcEndpointsForDomainResponse
object
Container for response parameters to the ListVpcEndpointsForDomain operation. Returns a list containing summarized details of the VPC endpoints.
2 properties
2 required
LimitName
string
AdvancedOptionsStatus
object
Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available: Option to allow references to i…
2 properties
2 required
Username
string
DomainEndpointOptions
object
Options to configure endpoint for the Elasticsearch domain.
5 properties
BackendRole
string
LimitValue
string
KmsKeyId
string
DescribeReservedElasticsearchInstancesResponse
object
Container for results from DescribeReservedElasticsearchInstances
2 properties
VpcEndpoint
object
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
6 properties
ElasticsearchDomainStatusList
array
A list that contains the status of each requested Elasticsearch domain.
DomainId
string
Unique identifier for an Elasticsearch domain.
ValidationException
AuthorizedPrincipalList
array
DomainInformation
object
3 properties
1 required
EncryptionAtRestOptions
object
Specifies the Encryption At Rest Options.
2 properties
VpcEndpointErrorList
array
RecurringCharge
object
Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
2 properties
ServiceUrl
string
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-…
RollbackOnDisable
string
Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NOROLLBACK, DEFAULTROLLBACK.
SAMLEntityId
string
Password
string
UpgradeStep
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Amazon OpenSearch Service API 4
Other APIs Amazon OpenSearch Service API publishes across the network.
Amazon OpenSearch Service API Domain API
Amazon OpenSearch Service API Packages API
Amazon OpenSearch Service API Tags API
Amazon OpenSearch Service API Tags Removal API
#Es
Where this information came from
This is an independent, third-party profile of Amazon OpenSearch Service API Es API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.