| Class | Description |
|---|---|
| AcceptInboundCrossClusterSearchConnectionRequest |
Container for the parameters to the
AcceptInboundCrossClusterSearchConnection operation. |
| AcceptInboundCrossClusterSearchConnectionResult |
The result of a
AcceptInboundCrossClusterSearchConnection operation. |
| AccessPoliciesStatus |
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
|
| AdditionalLimit |
List of limits that are specific to a given InstanceType and for each of it's
InstanceRole . |
| AddTagsRequest |
Container for the parameters to the
AddTags operation. |
| AddTagsResult | |
| AdvancedOptionsStatus |
Status of the advanced options for the specified Elasticsearch domain.
|
| AdvancedSecurityOptions |
Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database
option is enabled.
|
| AdvancedSecurityOptionsInput |
Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database
option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is
enabled).
|
| AdvancedSecurityOptionsStatus |
Specifies the status of advanced security options for the specified Elasticsearch domain.
|
| AssociatePackageRequest |
Container for request parameters to
AssociatePackage operation. |
| AssociatePackageResult |
Container for response returned by
AssociatePackage operation. |
| AuthorizedPrincipal |
Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an
interface VPC endpoint.
|
| AuthorizeVpcEndpointAccessRequest |
Container for request parameters to the
AuthorizeVpcEndpointAccess operation. |
| AuthorizeVpcEndpointAccessResult |
Container for response parameters to the
AuthorizeVpcEndpointAccess operation. |
| AutoTune |
Specifies Auto-Tune type and Auto-Tune action details.
|
| AutoTuneDetails |
Specifies details of the Auto-Tune action.
|
| AutoTuneMaintenanceSchedule |
Specifies Auto-Tune maitenance schedule.
|
| AutoTuneOptions |
Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune
options and list of maintenance schedules.
|
| AutoTuneOptionsInput |
Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
|
| AutoTuneOptionsOutput |
Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
|
| AutoTuneOptionsStatus |
Specifies the status of Auto-Tune options for the specified Elasticsearch domain.
|
| AutoTuneStatus |
Provides the current status of the Auto-Tune options.
|
| CancelDomainConfigChangeRequest |
Container for parameters of the
CancelDomainConfigChange operation. |
| CancelDomainConfigChangeResult |
Contains the details of the cancelled domain config change.
|
| CancelElasticsearchServiceSoftwareUpdateRequest |
Container for the parameters to the
CancelElasticsearchServiceSoftwareUpdate operation. |
| CancelElasticsearchServiceSoftwareUpdateResult |
The result of a
CancelElasticsearchServiceSoftwareUpdate operation. |
| CancelledChangeProperty |
A property change that was cancelled for an Amazon OpenSearch Service domain.
|
| ChangeProgressDetails |
Specifies change details of the domain configuration change.
|
| ChangeProgressStage |
A progress stage details of a specific domain configuration change.
|
| ChangeProgressStatusDetails |
The progress details of a specific domain configuration change.
|
| CognitoOptions |
Options to specify the Cognito user and identity pools for Kibana authentication.
|
| CognitoOptionsStatus |
Status of the Cognito options for the specified Elasticsearch domain.
|
| ColdStorageOptions |
Specifies the configuration for cold storage options such as enabled
|
| CompatibleVersionsMap |
A map from an
ElasticsearchVersion to a list of compatible
ElasticsearchVersion s to which the domain can be upgraded. |
| CreateElasticsearchDomainRequest | |
| CreateElasticsearchDomainResult |
The result of a
CreateElasticsearchDomain operation. |
| CreateOutboundCrossClusterSearchConnectionRequest |
Container for the parameters to the
CreateOutboundCrossClusterSearchConnection operation. |
| CreateOutboundCrossClusterSearchConnectionResult |
The result of a
CreateOutboundCrossClusterSearchConnection request. |
| CreatePackageRequest |
Container for request parameters to
CreatePackage operation. |
| CreatePackageResult |
Container for response returned by
CreatePackage operation. |
| CreateVpcEndpointRequest |
Container for the parameters to the
CreateVpcEndpointRequest operation. |
| CreateVpcEndpointResult |
Container for response parameters to the
CreateVpcEndpoint operation. |
| DeleteElasticsearchDomainRequest |
Container for the parameters to the
DeleteElasticsearchDomain operation. |
| DeleteElasticsearchDomainResult |
The result of a
DeleteElasticsearchDomain request. |
| DeleteElasticsearchServiceRoleRequest | |
| DeleteElasticsearchServiceRoleResult | |
| DeleteInboundCrossClusterSearchConnectionRequest |
Container for the parameters to the
DeleteInboundCrossClusterSearchConnection operation. |
| DeleteInboundCrossClusterSearchConnectionResult |
The result of a
DeleteInboundCrossClusterSearchConnection operation. |
| DeleteOutboundCrossClusterSearchConnectionRequest |
Container for the parameters to the
DeleteOutboundCrossClusterSearchConnection operation. |
| DeleteOutboundCrossClusterSearchConnectionResult |
The result of a
DeleteOutboundCrossClusterSearchConnection operation. |
| DeletePackageRequest |
Container for request parameters to
DeletePackage operation. |
| DeletePackageResult |
Container for response parameters to
DeletePackage operation. |
| DeleteVpcEndpointRequest |
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
|
| DeleteVpcEndpointResult |
Container for response parameters to the
DeleteVpcEndpoint operation. |
| DescribeDomainAutoTunesRequest |
Container for the parameters to the
DescribeDomainAutoTunes operation. |
| DescribeDomainAutoTunesResult |
The result of
DescribeDomainAutoTunes request. |
| DescribeDomainChangeProgressRequest |
Container for the parameters to the
DescribeDomainChangeProgress operation. |
| DescribeDomainChangeProgressResult |
The result of a
DescribeDomainChangeProgress request. |
| DescribeElasticsearchDomainConfigRequest |
Container for the parameters to the
DescribeElasticsearchDomainConfig operation. |
| DescribeElasticsearchDomainConfigResult |
The result of a
DescribeElasticsearchDomainConfig request. |
| DescribeElasticsearchDomainRequest |
Container for the parameters to the
DescribeElasticsearchDomain operation. |
| DescribeElasticsearchDomainResult |
The result of a
DescribeElasticsearchDomain request. |
| DescribeElasticsearchDomainsRequest |
Container for the parameters to the
DescribeElasticsearchDomains operation. |
| DescribeElasticsearchDomainsResult |
The result of a
DescribeElasticsearchDomains request. |
| DescribeElasticsearchInstanceTypeLimitsRequest |
Container for the parameters to
DescribeElasticsearchInstanceTypeLimits operation. |
| DescribeElasticsearchInstanceTypeLimitsResult |
Container for the parameters received from
DescribeElasticsearchInstanceTypeLimits operation. |
| DescribeInboundCrossClusterSearchConnectionsRequest |
Container for the parameters to the
DescribeInboundCrossClusterSearchConnections operation. |
| DescribeInboundCrossClusterSearchConnectionsResult |
The result of a
DescribeInboundCrossClusterSearchConnections request. |
| DescribeOutboundCrossClusterSearchConnectionsRequest |
Container for the parameters to the
DescribeOutboundCrossClusterSearchConnections operation. |
| DescribeOutboundCrossClusterSearchConnectionsResult |
The result of a
DescribeOutboundCrossClusterSearchConnections request. |
| DescribePackagesFilter |
Filter to apply in
DescribePackage response. |
| DescribePackagesRequest |
Container for request parameters to
DescribePackage operation. |
| DescribePackagesResult |
Container for response returned by
DescribePackages operation. |
| DescribeReservedElasticsearchInstanceOfferingsRequest |
Container for parameters to
DescribeReservedElasticsearchInstanceOfferings |
| DescribeReservedElasticsearchInstanceOfferingsResult |
Container for results from
DescribeReservedElasticsearchInstanceOfferings |
| DescribeReservedElasticsearchInstancesRequest |
Container for parameters to
DescribeReservedElasticsearchInstances |
| DescribeReservedElasticsearchInstancesResult |
Container for results from
DescribeReservedElasticsearchInstances |
| DescribeVpcEndpointsRequest |
Container for request parameters to the
DescribeVpcEndpoints operation. |
| DescribeVpcEndpointsResult |
Container for response parameters to the
DescribeVpcEndpoints operation. |
| DissociatePackageRequest |
Container for request parameters to
DissociatePackage operation. |
| DissociatePackageResult |
Container for response returned by
DissociatePackage operation. |
| DomainEndpointOptions |
Options to configure endpoint for the Elasticsearch domain.
|
| DomainEndpointOptionsStatus |
The configured endpoint options for the domain and their current status.
|
| DomainInfo | |
| DomainInformation | |
| DomainPackageDetails |
Information on a package that is associated with a domain.
|
| DryRunResults | |
| Duration |
Specifies maintenance schedule duration: duration value and duration unit.
|
| EBSOptions |
Options to enable, disable, and specify the properties of EBS storage volumes.
|
| EBSOptionsStatus |
Status of the EBS options for the specified Elasticsearch domain.
|
| ElasticsearchClusterConfig |
Specifies the configuration for the domain cluster, such as the type and number of instances.
|
| ElasticsearchClusterConfigStatus |
Specifies the configuration status for the specified Elasticsearch domain.
|
| ElasticsearchDomainConfig |
The configuration of an Elasticsearch domain.
|
| ElasticsearchDomainStatus |
The current status of an Elasticsearch domain.
|
| ElasticsearchVersionStatus |
Status of the Elasticsearch version options for the specified Elasticsearch domain.
|
| EncryptionAtRestOptions |
Specifies the Encryption At Rest Options.
|
| EncryptionAtRestOptionsStatus |
Status of the Encryption At Rest options for the specified Elasticsearch domain.
|
| ErrorDetails | |
| Filter |
A filter used to limit results when describing inbound or outbound cross-cluster search connections.
|
| GetCompatibleElasticsearchVersionsRequest |
Container for request parameters to
GetCompatibleElasticsearchVersions operation. |
| GetCompatibleElasticsearchVersionsResult |
Container for response returned by
GetCompatibleElasticsearchVersions operation. |
| GetPackageVersionHistoryRequest |
Container for request parameters to
GetPackageVersionHistory operation. |
| GetPackageVersionHistoryResult |
Container for response returned by
GetPackageVersionHistory operation. |
| GetUpgradeHistoryRequest |
Container for request parameters to
GetUpgradeHistory operation. |
| GetUpgradeHistoryResult |
Container for response returned by
GetUpgradeHistory operation. |
| GetUpgradeStatusRequest |
Container for request parameters to
GetUpgradeStatus operation. |
| GetUpgradeStatusResult |
Container for response returned by
GetUpgradeStatus operation. |
| InboundCrossClusterSearchConnection |
Specifies details of an inbound connection.
|
| InboundCrossClusterSearchConnectionStatus |
Specifies the coonection status of an inbound cross-cluster search connection.
|
| InstanceCountLimits |
InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given
InstanceType.
|
| InstanceLimits |
InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
|
| Limits |
Limits for given InstanceType and for each of it's role.
|
| ListDomainNamesRequest |
Container for the parameters to the
ListDomainNames operation. |
| ListDomainNamesResult |
The result of a
ListDomainNames operation. |
| ListDomainsForPackageRequest |
Container for request parameters to
ListDomainsForPackage operation. |
| ListDomainsForPackageResult |
Container for response parameters to
ListDomainsForPackage operation. |
| ListElasticsearchInstanceTypesRequest |
Container for the parameters to the
ListElasticsearchInstanceTypes operation. |
| ListElasticsearchInstanceTypesResult |
Container for the parameters returned by
ListElasticsearchInstanceTypes operation. |
| ListElasticsearchVersionsRequest |
Container for the parameters to the
ListElasticsearchVersions operation. |
| ListElasticsearchVersionsResult |
Container for the parameters for response received from
ListElasticsearchVersions operation. |
| ListPackagesForDomainRequest |
Container for request parameters to
ListPackagesForDomain operation. |
| ListPackagesForDomainResult |
Container for response parameters to
ListPackagesForDomain operation. |
| ListTagsRequest |
Container for the parameters to the
ListTags operation. |
| ListTagsResult |
The result of a
ListTags operation. |
| ListVpcEndpointAccessRequest |
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through
the use of an interface VPC endpoint
|
| ListVpcEndpointAccessResult |
Container for response parameters to the
ListVpcEndpointAccess operation. |
| ListVpcEndpointsForDomainRequest |
Container for request parameters to the
ListVpcEndpointsForDomain operation. |
| ListVpcEndpointsForDomainResult |
Container for response parameters to the
ListVpcEndpointsForDomain operation. |
| ListVpcEndpointsRequest |
Container for request parameters to the
ListVpcEndpoints operation. |
| ListVpcEndpointsResult |
Container for response parameters to the
ListVpcEndpoints operation. |
| LogPublishingOption |
Log Publishing option that is set for given domain.
|
| LogPublishingOptionsStatus |
The configured log publishing options for the domain and their current status.
|
| MasterUserOptions |
Credentials for the master user: username and password, ARN, or both.
|
| ModifyingProperties |
Information about the domain properties that are currently being modified.
|
| NodeToNodeEncryptionOptions |
Specifies the node-to-node encryption options.
|
| NodeToNodeEncryptionOptionsStatus |
Status of the node-to-node encryption options for the specified Elasticsearch domain.
|
| OptionStatus |
Provides the current status of the entity.
|
| OutboundCrossClusterSearchConnection |
Specifies details of an outbound connection.
|
| OutboundCrossClusterSearchConnectionStatus |
Specifies the connection status of an outbound cross-cluster search connection.
|
| PackageDetails |
Basic information about a package.
|
| PackageSource |
The S3 location for importing the package specified as
S3BucketName and S3Key |
| PackageVersionHistory |
Details of a package version.
|
| PurchaseReservedElasticsearchInstanceOfferingRequest |
Container for parameters to
PurchaseReservedElasticsearchInstanceOffering |
| PurchaseReservedElasticsearchInstanceOfferingResult |
Represents the output of a
PurchaseReservedElasticsearchInstanceOffering operation. |
| RecurringCharge |
Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a
reserved Elasticsearch instance offering.
|
| RejectInboundCrossClusterSearchConnectionRequest |
Container for the parameters to the
RejectInboundCrossClusterSearchConnection operation. |
| RejectInboundCrossClusterSearchConnectionResult |
The result of a
RejectInboundCrossClusterSearchConnection operation. |
| RemoveTagsRequest |
Container for the parameters to the
RemoveTags operation. |
| RemoveTagsResult | |
| ReservedElasticsearchInstance |
Details of a reserved Elasticsearch instance.
|
| ReservedElasticsearchInstanceOffering |
Details of a reserved Elasticsearch instance offering.
|
| RevokeVpcEndpointAccessRequest |
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
|
| RevokeVpcEndpointAccessResult |
Container for response parameters to the
RevokeVpcEndpointAccess operation. |
| SAMLIdp |
Specifies the SAML Identity Provider's information.
|
| SAMLOptionsInput |
Specifies the SAML application configuration for the domain.
|
| SAMLOptionsOutput |
Describes the SAML application configured for the domain.
|
| ScheduledAutoTuneDetails |
Specifies details of the scheduled Auto-Tune action.
|
| ServiceSoftwareOptions |
The current options of an Elasticsearch domain service software options.
|
| SnapshotOptions |
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch
domain.
|
| SnapshotOptionsStatus |
Status of a daily automated snapshot.
|
| StartElasticsearchServiceSoftwareUpdateRequest |
Container for the parameters to the
StartElasticsearchServiceSoftwareUpdate operation. |
| StartElasticsearchServiceSoftwareUpdateResult |
The result of a
StartElasticsearchServiceSoftwareUpdate operation. |
| StorageType |
StorageTypes represents the list of storage related types and their attributes that are available for given
InstanceType.
|
| StorageTypeLimit |
Limits that are applicable for given storage type.
|
| Tag |
Specifies a key value pair for a resource tag.
|
| UpdateElasticsearchDomainConfigRequest |
Container for the parameters to the
UpdateElasticsearchDomain operation. |
| UpdateElasticsearchDomainConfigResult |
The result of an
UpdateElasticsearchDomain request. |
| UpdatePackageRequest |
Container for request parameters to
UpdatePackage operation. |
| UpdatePackageResult |
Container for response returned by
UpdatePackage operation. |
| UpdateVpcEndpointRequest |
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
|
| UpdateVpcEndpointResult |
Contains the configuration and status of the VPC endpoint being updated.
|
| UpgradeElasticsearchDomainRequest |
Container for request parameters to
UpgradeElasticsearchDomain operation. |
| UpgradeElasticsearchDomainResult |
Container for response returned by
UpgradeElasticsearchDomain operation. |
| UpgradeHistory |
History of the last 10 Upgrades and Upgrade Eligibility Checks.
|
| UpgradeStepItem |
Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
|
| VPCDerivedInfo |
Options to specify the subnets and security groups for VPC endpoint.
|
| VPCDerivedInfoStatus |
Status of the VPC options for the specified Elasticsearch domain.
|
| VpcEndpoint |
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
|
| VpcEndpointError |
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
|
| VpcEndpointSummary |
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
|
| VPCOptions |
Options to specify the subnets and security groups for VPC endpoint.
|
| ZoneAwarenessConfig |
Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.
|
| Enum | Description |
|---|---|
| AutoTuneDesiredState |
Specifies the Auto-Tune desired state.
|
| AutoTuneState |
Specifies the Auto-Tune state for the Elasticsearch domain.
|
| AutoTuneType |
Specifies Auto-Tune type.
|
| ConfigChangeStatus | |
| DeploymentStatus | |
| DescribePackagesFilterName | |
| DomainPackageStatus | |
| DomainProcessingStatusType | |
| EngineType | |
| ESPartitionInstanceType | |
| ESWarmPartitionInstanceType | |
| InboundCrossClusterSearchConnectionStatusCode | |
| InitiatedBy | |
| LogType |
Type of Log File, it can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log
threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log
threshold to execute.
ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during
the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
|
| OptionState |
The state of a requested change.
|
| OutboundCrossClusterSearchConnectionStatusCode | |
| OverallChangeStatus |
The overall status value of the domain configuration change.
|
| PackageStatus | |
| PackageType | |
| PrincipalType |
Specifies the type of AWS account permitted to manage VPC endpoints.:
AWS_ACCOUNT: Indicates that the account is owned by an AWS user.
AWS_SERVICE: Indicates the the account is owned by an AWS service.
|
| PropertyValueType | |
| ReservedElasticsearchInstancePaymentOption | |
| RollbackOnDisable |
Specifies the rollback state while disabling Auto-Tune for the domain.
|
| ScheduledAutoTuneActionType |
Specifies Auto-Tune action type.
|
| ScheduledAutoTuneSeverityType |
Specifies Auto-Tune action severity.
|
| TimeUnit |
Specifies the unit of a maintenance schedule duration.
|
| TLSSecurityPolicy | |
| UpgradeStatus | |
| UpgradeStep | |
| VolumeType |
The type of EBS volume, standard, gp2, gp3 or io1.
|
| VpcEndpointErrorCode |
Specifies the error code of the failure encountered while describing the VPC endpoint:
ENDPOINT_NOT_FOUND: Indicates that the requested VPC endpoint does not exist.
SERVER_ERROR: Indicates the describe endpoint operation failed due to an internal server error.
|
| VpcEndpointStatus |
Specifies the current status of the VPC endpoint:
CREATING: Indicates that the VPC endpoint is currently being created.
CREATE_FAILED: Indicates that the VPC endpoint creation failed.
ACTIVE: Indicates that the VPC endpoint is currently active.
UPDATING: Indicates that the VPC endpoint is currently being updated.
UPDATE_FAILED: Indicates that the VPC endpoint update failed.
DELETING: Indicates that the VPC endpoint is currently being deleted.
DELETE_FAILED: Indicates that the VPC endpoint deletion failed.
|
| Exception | Description |
|---|---|
| AccessDeniedException |
An error occurred because user does not have permissions to access the resource.
|
| AWSElasticsearchException |
Base exception for all service exceptions thrown by Amazon Elasticsearch Service
|
| BaseException |
An error occurred while processing the request.
|
| ConflictException |
An error occurred because the client attempts to remove a resource that is currently in use.
|
| DisabledOperationException |
An error occured because the client wanted to access a not supported operation.
|
| InternalException |
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the
service) .
|
| InvalidPaginationTokenException |
The request processing has failed because of invalid pagination token provided by customer.
|
| InvalidTypeException |
An exception for trying to create or access sub-resource that is either invalid or not supported.
|
| LimitExceededException |
An exception for trying to create more than allowed resources or sub-resources.
|
| ResourceAlreadyExistsException |
An exception for creating a resource that already exists.
|
| ResourceNotFoundException |
An exception for accessing or deleting a resource that does not exist.
|
| ValidationException |
An exception for missing / invalid input fields.
|