Package-level declarations
Types
Container for the parameters to the <a>AcceptInboundCrossClusterSearchConnection</a> operation.
The result of a <a>AcceptInboundCrossClusterSearchConnection</a> operation. Contains details of accepted inbound connection.
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
List of limits that are specific to a given InstanceType and for each of it's <a>InstanceRole</a> .
Container for the parameters to the <a>AddTags</a> operation. Specify the tags that you want to attach to the Elasticsearch domain.
Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:
Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).
Specifies the status of advanced security options for the specified Elasticsearch domain.
Container for request parameters to <a>AssociatePackage</a> operation.
Container for response returned by <a>AssociatePackage</a> operation.
Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
Container for request parameters to the <a>AuthorizeVpcEndpointAccess</a> operation. Specifies the account to be permitted to manage VPC endpoints against the domain.
Container for response parameters to the <a>AuthorizeVpcEndpointAccess</a> operation. Contains the account ID and the type of the account being authorized to access the VPC endpoint.
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
Specifies details of the Auto-Tune action. See the Developer Guide for more information.
Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
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.
Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
Specifies the status of Auto-Tune options for the specified Elasticsearch domain.
Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide.
Provides the current status of the Auto-Tune options.
Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
An error occurred while processing the request.
Container for parameters of the CancelDomainConfigChange operation.
Contains the details of the cancelled domain config change.
Container for the parameters to the <a>CancelElasticsearchServiceSoftwareUpdate</a> operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.
The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
A property change that was cancelled for an Amazon OpenSearch Service domain.
Specifies change details of the domain configuration change.
A progress stage details of a specific domain configuration change.
The progress details of a specific domain configuration change.
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
Status of the Cognito options for the specified Elasticsearch domain.
Specifies the configuration for cold storage options such as enabled
A map from an <a>ElasticsearchVersion</a> to a list of compatible <a>ElasticsearchVersion</a> 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.
The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.
Container for the parameters to the <a>CreateOutboundCrossClusterSearchConnection</a> operation.
The result of a <a>CreateOutboundCrossClusterSearchConnection</a> request. Contains the details of the newly created cross-cluster search connection.
Container for request parameters to <a>CreatePackage</a> operation.
Container for response returned by <a>CreatePackage</a> operation.
Container for the parameters to the <a>CreateVpcEndpointRequest</a> operation.
Container for response parameters to the <a>CreateVpcEndpoint</a> operation. Contains the configuration and status of the VPC Endpoint being created.
Container for the parameters to the <a>DeleteElasticsearchDomain</a> operation. Specifies the name of the Elasticsearch domain that you want to delete.
The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.
Container for the parameters to the <a>DeleteInboundCrossClusterSearchConnection</a> operation.
The result of a <a>DeleteInboundCrossClusterSearchConnection</a> operation. Contains details of deleted inbound connection.
Container for the parameters to the <a>DeleteOutboundCrossClusterSearchConnection</a> operation.
The result of a <a>DeleteOutboundCrossClusterSearchConnection</a> operation. Contains details of deleted outbound connection.
Container for request parameters to <a>DeletePackage</a> operation.
Container for response parameters to <a>DeletePackage</a> operation.
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
Container for response parameters to the <a>DeleteVpcEndpoint</a> operation. Contains the summarized detail of the VPC Endpoint being deleted.
Container for the parameters to the DescribeDomainAutoTunes operation.
The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.
Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information.
The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change.
Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.
The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.
Container for the parameters to the <a>DescribeElasticsearchDomain</a> operation.
The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.
Container for the parameters to the <a>DescribeElasticsearchDomains</a> operation. By default, the API returns the status of all Elasticsearch domains.
The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.
Container for the parameters to <a>DescribeElasticsearchInstanceTypeLimits</a> operation.
Container for the parameters received from <a>DescribeElasticsearchInstanceTypeLimits</a> operation.
Container for the parameters to the <a>DescribeInboundCrossClusterSearchConnections</a> operation.
The result of a <a>DescribeInboundCrossClusterSearchConnections</a> request. Contains the list of connections matching the filter criteria.
Container for the parameters to the <a>DescribeOutboundCrossClusterSearchConnections</a> operation.
The result of a <a>DescribeOutboundCrossClusterSearchConnections</a> request. Contains the list of connections matching the filter criteria.
Filter to apply in DescribePackage response.
Container for request parameters to <a>DescribePackage</a> operation.
Container for response returned by <a>DescribePackages</a> operation.
Container for parameters to DescribeReservedElasticsearchInstanceOfferings
Container for results from DescribeReservedElasticsearchInstanceOfferings
Container for parameters to DescribeReservedElasticsearchInstances
Container for results from DescribeReservedElasticsearchInstances
Container for request parameters to the <a>DescribeVpcEndpoints</a> operation. Specifies the list of VPC endpoints to be described.
Container for response parameters to the <a>DescribeVpcEndpoints</a> operation. Returns a list containing configuration details and status of the VPC Endpoints as well as a list containing error responses of the endpoints that could not be described
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
Container for request parameters to <a>DissociatePackage</a> operation.
Container for response returned by <a>DissociatePackage</a> operation.
Options to configure endpoint for the Elasticsearch domain.
The configured endpoint options for the domain and their current status.
Information on a package that is associated with a domain.
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
Status of the EBS options for the specified Elasticsearch domain.
Specifies the configuration for the domain cluster, such as the type and number of instances.
Specifies the configuration status for the specified Elasticsearch domain.
The configuration of an Elasticsearch domain.
The current status of an Elasticsearch domain.
Base class for all service related exceptions thrown by the Elasticsearch client
Status of the Elasticsearch version options for the specified Elasticsearch domain.
Specifies the Encryption At Rest Options.
Status of the Encryption At Rest options for the specified Elasticsearch domain.
A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
Container for request parameters to <a>GetCompatibleElasticsearchVersions</a> operation.
Container for response returned by <a>GetCompatibleElasticsearchVersions</a> operation.
Container for request parameters to <a>GetPackageVersionHistory</a> operation.
Container for response returned by <a>GetPackageVersionHistory</a> operation.
Container for request parameters to <a>GetUpgradeHistory</a> operation.
Container for response returned by <a>GetUpgradeHistory</a> operation.
Container for request parameters to <a>GetUpgradeStatus</a> operation.
Container for response returned by <a>GetUpgradeStatus</a> operation.
Specifies details of an inbound connection.
Specifies the coonection status of an inbound cross-cluster search connection.
InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
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.
The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
Container for the parameters to the <a>ListDomainNames</a> operation.
The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
Container for request parameters to <a>ListDomainsForPackage</a> operation.
Container for response parameters to <a>ListDomainsForPackage</a> operation.
Container for the parameters to the <a>ListElasticsearchInstanceTypes</a> operation.
Container for the parameters returned by <a>ListElasticsearchInstanceTypes</a> operation.
Container for the parameters to the <a>ListElasticsearchVersions</a> operation.
Container for the parameters for response received from <a>ListElasticsearchVersions</a> operation.
Container for request parameters to <a>ListPackagesForDomain</a> operation.
Container for response parameters to <a>ListPackagesForDomain</a> operation.
Container for the parameters to the <a>ListTags</a> operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.
The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint
Container for response parameters to the <a>ListVpcEndpointAccess</a> operation. Returns a list of accounts id and account type authorized to manage VPC endpoints.
Container for request parameters to the <a>ListVpcEndpointsForDomain</a> operation. Specifies the domain whose VPC endpoints will be listed.
Container for response parameters to the <a>ListVpcEndpointsForDomain</a> operation. Returns a list containing summarized details of the VPC endpoints.
Container for request parameters to the <a>ListVpcEndpoints</a> operation.
Container for response parameters to the <a>ListVpcEndpoints</a> operation. Returns a list containing summarized details of the VPC endpoints.
Log Publishing option that is set for given domain. Attributes and their details:
The configured log publishing options for the domain and their current status.
Credentials for the master user: username and password, ARN, or both.
Information about the domain properties that are currently being modified.
Specifies the node-to-node encryption options.
Status of the node-to-node encryption options for the specified Elasticsearch domain.
The state of a requested change. One of the following:
Provides the current status of the entity.
Specifies details of an outbound connection.
Specifies the connection status of an outbound cross-cluster search connection.
The overall status value of the domain configuration change.
Basic information about a package.
The S3 location for importing the package specified as S3BucketName and S3Key
Details of a package version.
Specifies the type of AWS account permitted to manage VPC endpoints.:
Container for parameters to PurchaseReservedElasticsearchInstanceOffering
Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.
Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
Container for the parameters to the <a>RejectInboundCrossClusterSearchConnection</a> operation.
The result of a <a>RejectInboundCrossClusterSearchConnection</a> operation. Contains details of rejected inbound connection.
Container for the parameters to the <a>RemoveTags</a> operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.
Details of a reserved Elasticsearch instance.
Details of a reserved Elasticsearch instance offering.
An exception for creating a resource that already exists. Gives http status code of 400.
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
Container for response parameters to the <a>RevokeVpcEndpointAccess</a> operation. The response body for this operation is empty.
Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
Specifies the SAML application configuration for the domain.
Describes the SAML application configured for the domain.
Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.
Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
The current options of an Elasticsearch domain service software options.
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
Status of a daily automated snapshot.
Container for the parameters to the <a>StartElasticsearchServiceSoftwareUpdate</a> operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.
The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
Limits that are applicable for given storage type.
Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.
Container for the parameters to the <a>UpdateElasticsearchDomain</a> operation. Specifies the type and number of instances in the domain cluster.
The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.
Container for request parameters to <a>UpdatePackage</a> operation.
Container for response returned by <a>UpdatePackage</a> operation.
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
Contains the configuration and status of the VPC endpoint being updated.
Container for request parameters to <a>UpgradeElasticsearchDomain</a> operation.
Container for response returned by <a>UpgradeElasticsearchDomain</a> operation.
History of the last 10 Upgrades and Upgrade Eligibility Checks.
Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
An exception for missing / invalid input fields. Gives http status code of 400.
The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.
Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
Status of the VPC options for the specified Elasticsearch domain.
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
Specifies the error code of the failure encountered while describing the VPC endpoint:
Specifies the current status of the VPC endpoint:
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.