'2.0', 'service' => 'Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

', 'operations' => [ 'AcceptInboundCrossClusterSearchConnection' => '

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

', 'AddTags' => '

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

', 'AssociatePackage' => '

Associates a package with an Amazon ES domain.

', 'AuthorizeVpcEndpointAccess' => '

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'CancelElasticsearchServiceSoftwareUpdate' => '

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

', 'CreateElasticsearchDomain' => '

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

', 'CreateOutboundCrossClusterSearchConnection' => '

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

', 'CreatePackage' => '

Create a package for use with Amazon ES domains.

', 'CreateVpcEndpoint' => '

Creates an Amazon OpenSearch Service-managed VPC endpoint.

', 'DeleteElasticsearchDomain' => '

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

', 'DeleteElasticsearchServiceRole' => '

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

', 'DeleteInboundCrossClusterSearchConnection' => '

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

', 'DeleteOutboundCrossClusterSearchConnection' => '

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

', 'DeletePackage' => '

Delete the package.

', 'DeleteVpcEndpoint' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'DescribeDomainAutoTunes' => '

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

', 'DescribeDomainChangeProgress' => '

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

', 'DescribeElasticsearchDomain' => '

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

', 'DescribeElasticsearchDomainConfig' => '

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

', 'DescribeElasticsearchDomains' => '

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

', 'DescribeElasticsearchInstanceTypeLimits' => '

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

', 'DescribeInboundCrossClusterSearchConnections' => '

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

', 'DescribeOutboundCrossClusterSearchConnections' => '

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

', 'DescribePackages' => '

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

', 'DescribeReservedElasticsearchInstanceOfferings' => '

Lists available reserved Elasticsearch instance offerings.

', 'DescribeReservedElasticsearchInstances' => '

Returns information about reserved Elasticsearch instances for this account.

', 'DescribeVpcEndpoints' => '

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

', 'DissociatePackage' => '

Dissociates a package from the Amazon ES domain.

', 'GetCompatibleElasticsearchVersions' => '

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

', 'GetPackageVersionHistory' => '

Returns a list of versions of the package, along with their creation time and commit message.

', 'GetUpgradeHistory' => '

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

', 'GetUpgradeStatus' => '

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

', 'ListDomainNames' => '

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

', 'ListDomainsForPackage' => '

Lists all Amazon ES domains associated with the package.

', 'ListElasticsearchInstanceTypes' => '

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

', 'ListElasticsearchVersions' => '

List all supported Elasticsearch versions

', 'ListPackagesForDomain' => '

Lists all packages associated with the Amazon ES domain.

', 'ListTags' => '

Returns all tags for the given Elasticsearch domain.

', 'ListVpcEndpointAccess' => '

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

', 'ListVpcEndpoints' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

', 'ListVpcEndpointsForDomain' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

', 'PurchaseReservedElasticsearchInstanceOffering' => '

Allows you to purchase reserved Elasticsearch instances.

', 'RejectInboundCrossClusterSearchConnection' => '

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

', 'RemoveTags' => '

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

', 'RevokeVpcEndpointAccess' => '

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

', 'StartElasticsearchServiceSoftwareUpdate' => '

Schedules a service software update for an Amazon ES domain.

', 'UpdateElasticsearchDomainConfig' => '

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

', 'UpdatePackage' => '

Updates a package for use with Amazon ES domains.

', 'UpdateVpcEndpoint' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'UpgradeElasticsearchDomain' => '

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

', ], 'shapes' => [ 'ARN' => [ 'base' => '

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

', 'refs' => [ 'AddTagsRequest$ARN' => '

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

', 'DomainEndpointOptions$CustomEndpointCertificateArn' => '

Specify ACM certificate ARN for your custom endpoint.

', 'ElasticsearchDomainStatus$ARN' => '

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

', 'ListTagsRequest$ARN' => '

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

', 'MasterUserOptions$MasterUserARN' => '

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

', 'RemoveTagsRequest$ARN' => '

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

', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => '

The account ID to grant access to.

', 'RevokeVpcEndpointAccessRequest$Account' => '

The account ID to revoke access from.

', 'VpcEndpoint$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'AcceptInboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

', 'refs' => [], ], 'AcceptInboundCrossClusterSearchConnectionResponse' => [ 'base' => '

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

', 'refs' => [], ], 'AccessDeniedException' => [ 'base' => '

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

', 'refs' => [], ], 'AccessPoliciesStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', ], ], 'AddTagsRequest' => [ 'base' => '

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

', 'refs' => [], ], 'AdditionalLimit' => [ 'base' => '

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

', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => '

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

', ], ], 'AdvancedOptions' => [ 'base' => '

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

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

For more information, see Configuring Advanced Options.

', 'refs' => [ 'AdvancedOptionsStatus$Options' => '

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

', 'CreateElasticsearchDomainRequest$AdvancedOptions' => '

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

', 'ElasticsearchDomainStatus$AdvancedOptions' => '

Specifies the status of the AdvancedOptions

', 'UpdateElasticsearchDomainConfigRequest$AdvancedOptions' => '

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

', ], ], 'AdvancedOptionsStatus' => [ 'base' => '

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

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

For more information, see Configuring Advanced Options.

', 'refs' => [ 'ElasticsearchDomainConfig$AdvancedOptions' => '

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

', ], ], 'AdvancedSecurityOptions' => [ 'base' => '

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

', 'refs' => [ 'AdvancedSecurityOptionsStatus$Options' => '

Specifies advanced security options for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$AdvancedSecurityOptions' => '

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

', ], ], 'AdvancedSecurityOptionsInput' => [ 'base' => '

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).

', 'refs' => [ 'CreateElasticsearchDomainRequest$AdvancedSecurityOptions' => '

Specifies advanced security options.

', 'UpdateElasticsearchDomainConfigRequest$AdvancedSecurityOptions' => '

Specifies advanced security options.

', ], ], 'AdvancedSecurityOptionsStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$AdvancedSecurityOptions' => '

Specifies AdvancedSecurityOptions for the domain.

', ], ], 'AssociatePackageRequest' => [ 'base' => '

Container for request parameters to AssociatePackage operation.

', 'refs' => [], ], 'AssociatePackageResponse' => [ 'base' => '

Container for response returned by AssociatePackage operation.

', 'refs' => [], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'base' => '

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

', 'refs' => [], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'base' => '

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

', 'refs' => [], ], 'AuthorizedPrincipal' => [ 'base' => '

Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'refs' => [ 'AuthorizeVpcEndpointAccessResponse$AuthorizedPrincipal' => '

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

', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => '

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

', ], ], 'AutoTune' => [ 'base' => '

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

', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => '

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

', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => '

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

', ], ], 'AutoTuneDesiredState' => [ 'base' => '

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

', 'refs' => [ 'AutoTuneOptions$DesiredState' => '

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

', 'AutoTuneOptionsInput$DesiredState' => '

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

', ], ], 'AutoTuneDetails' => [ 'base' => '

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

', 'refs' => [ 'AutoTune$AutoTuneDetails' => '

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

', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => '

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

', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => '

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

', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => '

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

', 'AutoTuneOptionsInput$MaintenanceSchedules' => '

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

', ], ], 'AutoTuneOptions' => [ 'base' => '

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.

', 'refs' => [ 'AutoTuneOptionsStatus$Options' => '

Specifies Auto-Tune options for the specified Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$AutoTuneOptions' => '

Specifies Auto-Tune options.

', ], ], 'AutoTuneOptionsInput' => [ 'base' => '

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

', 'refs' => [ 'CreateElasticsearchDomainRequest$AutoTuneOptions' => '

Specifies Auto-Tune options.

', ], ], 'AutoTuneOptionsOutput' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainStatus$AutoTuneOptions' => '

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

', ], ], 'AutoTuneOptionsStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$AutoTuneOptions' => '

Specifies AutoTuneOptions for the domain.

', ], ], 'AutoTuneState' => [ 'base' => '

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

', 'refs' => [ 'AutoTuneOptionsOutput$State' => '

Specifies the AutoTuneState for the Elasticsearch domain.

', 'AutoTuneStatus$State' => '

Specifies the AutoTuneState for the Elasticsearch domain.

', ], ], 'AutoTuneStatus' => [ 'base' => '

Provides the current status of the Auto-Tune options.

', 'refs' => [ 'AutoTuneOptionsStatus$Status' => '

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

', ], ], 'AutoTuneType' => [ 'base' => '

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

', 'refs' => [ 'AutoTune$AutoTuneType' => '

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => '

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

', ], ], 'BaseException' => [ 'base' => '

An error occurred while processing the request.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$Enabled' => '

True if advanced security is enabled.

', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => '

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

', 'AdvancedSecurityOptionsInput$Enabled' => '

True if advanced security is enabled.

', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => '

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

', 'AutoTuneStatus$PendingDeletion' => '

Indicates whether the Elasticsearch domain is being deleted.

', 'CognitoOptions$Enabled' => '

Specifies the option to enable Cognito for Kibana authentication.

', 'ColdStorageOptions$Enabled' => '

Enable cold storage option. Accepted values true or false

', 'DomainEndpointOptions$EnforceHTTPS' => '

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

', 'DomainEndpointOptions$CustomEndpointEnabled' => '

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

', 'EBSOptions$EBSEnabled' => '

Specifies whether EBS-based storage is enabled.

', 'ElasticsearchClusterConfig$DedicatedMasterEnabled' => '

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

', 'ElasticsearchClusterConfig$ZoneAwarenessEnabled' => '

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

', 'ElasticsearchClusterConfig$WarmEnabled' => '

True to enable warm storage.

', 'ElasticsearchDomainStatus$Created' => '

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

', 'ElasticsearchDomainStatus$Deleted' => '

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.

', 'ElasticsearchDomainStatus$Processing' => '

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

', 'ElasticsearchDomainStatus$UpgradeProcessing' => '

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

', 'EncryptionAtRestOptions$Enabled' => '

Specifies the option to enable Encryption At Rest.

', 'LogPublishingOption$Enabled' => '

Specifies whether given log publishing option is enabled or not.

', 'NodeToNodeEncryptionOptions$Enabled' => '

Specify true to enable node-to-node encryption.

', 'OptionStatus$PendingDeletion' => '

Indicates whether the Elasticsearch domain is being deleted.

', 'SAMLOptionsInput$Enabled' => '

True if SAML is enabled.

', 'SAMLOptionsOutput$Enabled' => '

True if SAML is enabled.

', 'ServiceSoftwareOptions$UpdateAvailable' => '

True if you are able to update you service software version. False if you are not able to update your service software version.

', 'ServiceSoftwareOptions$Cancellable' => '

True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

', 'ServiceSoftwareOptions$OptionalDeployment' => '

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

', 'UpgradeElasticsearchDomainRequest$PerformCheckOnly' => '

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

', 'UpgradeElasticsearchDomainResponse$PerformCheckOnly' => '

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

', ], ], 'CancelElasticsearchServiceSoftwareUpdateRequest' => [ 'base' => '

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

', 'refs' => [], ], 'CancelElasticsearchServiceSoftwareUpdateResponse' => [ 'base' => '

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

', 'refs' => [], ], 'ChangeProgressDetails' => [ 'base' => '

Specifies change details of the domain configuration change.

', 'refs' => [ 'ElasticsearchDomainConfig$ChangeProgressDetails' => '

Specifies change details of the domain configuration change.

', 'ElasticsearchDomainStatus$ChangeProgressDetails' => '

Specifies change details of the domain configuration change.

', 'UpgradeElasticsearchDomainResponse$ChangeProgressDetails' => NULL, ], ], 'ChangeProgressStage' => [ 'base' => '

A progress stage details of a specific domain configuration change.

', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => '

The list of progress stages of a specific domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$ChangeProgressStages' => '

The specific stages that the domain is going through to perform the configuration change.

', ], ], 'ChangeProgressStageName' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => '

The name of the specific progress stage.

', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The overall status of a specific progress stage.

', ], ], 'ChangeProgressStatusDetails' => [ 'base' => '

The progress details of a specific domain configuration change.

', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => '

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

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$ClientToken' => '

Unique, case-sensitive identifier to ensure idempotency of the request.

', ], ], 'CloudWatchLogsLogGroupArn' => [ 'base' => '

ARN of the Cloudwatch log group to which log needs to be published.

', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => NULL, ], ], 'CognitoOptions' => [ 'base' => '

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

', 'refs' => [ 'CognitoOptionsStatus$Options' => '

Specifies the Cognito options for the specified Elasticsearch domain.

', 'CreateElasticsearchDomainRequest$CognitoOptions' => '

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

', 'ElasticsearchDomainStatus$CognitoOptions' => '

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

', 'UpdateElasticsearchDomainConfigRequest$CognitoOptions' => '

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

', ], ], 'CognitoOptionsStatus' => [ 'base' => '

Status of the Cognito options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$CognitoOptions' => '

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

', ], ], 'ColdStorageOptions' => [ 'base' => '

Specifies the configuration for cold storage options such as enabled

', 'refs' => [ 'ElasticsearchClusterConfig$ColdStorageOptions' => '

Specifies the ColdStorageOptions config for Elasticsearch Domain

', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => '

A message associated with the version.

', 'UpdatePackageRequest$CommitMessage' => '

An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

', ], ], 'CompatibleElasticsearchVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetCompatibleElasticsearchVersionsResponse$CompatibleElasticsearchVersions' => '

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

', ], ], 'CompatibleVersionsMap' => [ 'base' => '

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

', 'refs' => [ 'CompatibleElasticsearchVersionsList$member' => NULL, ], ], 'ConflictException' => [ 'base' => '

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

', 'refs' => [], ], 'ConnectionAlias' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionRequest$ConnectionAlias' => '

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

', 'CreateOutboundCrossClusterSearchConnectionResponse$ConnectionAlias' => '

Specifies the connection alias provided during the create connection request.

', 'OutboundCrossClusterSearchConnection$ConnectionAlias' => '

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

', ], ], 'CreateElasticsearchDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateElasticsearchDomainResponse' => [ 'base' => '

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

', 'refs' => [], ], 'CreateOutboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.

', 'refs' => [], ], 'CreateOutboundCrossClusterSearchConnectionResponse' => [ 'base' => '

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

', 'refs' => [], ], 'CreatePackageRequest' => [ 'base' => '

Container for request parameters to CreatePackage operation.

', 'refs' => [], ], 'CreatePackageResponse' => [ 'base' => '

Container for response returned by CreatePackage operation.

', 'refs' => [], ], 'CreateVpcEndpointRequest' => [ 'base' => '

Container for the parameters to the CreateVpcEndpointRequest operation.

', 'refs' => [], ], 'CreateVpcEndpointResponse' => [ 'base' => '

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

', 'refs' => [], ], 'CreatedAt' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$CreatedAt' => '

Timestamp which tells creation date of the package.

', 'PackageVersionHistory$CreatedAt' => '

Timestamp which tells creation time of the package version.

', ], ], 'CrossClusterSearchConnectionId' => [ 'base' => NULL, 'refs' => [ 'AcceptInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

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

', 'CreateOutboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnectionId' => '

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

', 'DeleteInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

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

', 'DeleteOutboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

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

', 'InboundCrossClusterSearchConnection$CrossClusterSearchConnectionId' => '

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

', 'OutboundCrossClusterSearchConnection$CrossClusterSearchConnectionId' => '

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

', 'RejectInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

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

', ], ], 'CrossClusterSearchConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundCrossClusterSearchConnectionStatus$Message' => '

Specifies verbose information for the inbound connection status.

', 'OutboundCrossClusterSearchConnectionStatus$Message' => '

Specifies verbose information for the outbound connection status.

', ], ], 'DeleteElasticsearchDomainRequest' => [ 'base' => '

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

', 'refs' => [], ], 'DeleteElasticsearchDomainResponse' => [ 'base' => '

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.

', 'refs' => [], ], 'DeleteInboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

', 'refs' => [], ], 'DeleteInboundCrossClusterSearchConnectionResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DeleteOutboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

', 'refs' => [], ], 'DeleteOutboundCrossClusterSearchConnectionResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => '

Container for request parameters to DeletePackage operation.

', 'refs' => [], ], 'DeletePackageResponse' => [ 'base' => '

Container for response parameters to DeletePackage operation.

', 'refs' => [], ], 'DeleteVpcEndpointRequest' => [ 'base' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'refs' => [], ], 'DeleteVpcEndpointResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => '

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

', ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$UpdateStatus' => '

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => '

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

', ], ], 'DescribeDomainAutoTunesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainAutoTunes operation.

', 'refs' => [], ], 'DescribeDomainAutoTunesResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeDomainChangeProgressRequest' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeDomainChangeProgressResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeElasticsearchDomainConfigRequest' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeElasticsearchDomainConfigResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeElasticsearchDomainRequest' => [ 'base' => '

Container for the parameters to the DescribeElasticsearchDomain operation.

', 'refs' => [], ], 'DescribeElasticsearchDomainResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeElasticsearchDomainsRequest' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeElasticsearchDomainsResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeElasticsearchInstanceTypeLimitsRequest' => [ 'base' => '

Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

', 'refs' => [], ], 'DescribeElasticsearchInstanceTypeLimitsResponse' => [ 'base' => '

Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.

', 'refs' => [], ], 'DescribeInboundCrossClusterSearchConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

', 'refs' => [], ], 'DescribeInboundCrossClusterSearchConnectionsResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeOutboundCrossClusterSearchConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

', 'refs' => [], ], 'DescribeOutboundCrossClusterSearchConnectionsResponse' => [ 'base' => '

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

', 'refs' => [], ], 'DescribePackagesFilter' => [ 'base' => '

Filter to apply in DescribePackage response.

', 'refs' => [ 'DescribePackagesFilterList$member' => NULL, ], ], 'DescribePackagesFilterList' => [ 'base' => '

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

', 'refs' => [ 'DescribePackagesRequest$Filters' => '

Only returns packages that match the DescribePackagesFilterList values.

', ], ], 'DescribePackagesFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Name' => '

Any field from PackageDetails.

', ], ], 'DescribePackagesFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilterValues$member' => NULL, ], ], 'DescribePackagesFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Value' => '

A non-empty list of values for the specified field.

', ], ], 'DescribePackagesRequest' => [ 'base' => '

Container for request parameters to DescribePackage operation.

', 'refs' => [], ], 'DescribePackagesResponse' => [ 'base' => '

Container for response returned by DescribePackages operation.

', 'refs' => [], ], 'DescribeReservedElasticsearchInstanceOfferingsRequest' => [ 'base' => '

Container for parameters to DescribeReservedElasticsearchInstanceOfferings

', 'refs' => [], ], 'DescribeReservedElasticsearchInstanceOfferingsResponse' => [ 'base' => '

Container for results from DescribeReservedElasticsearchInstanceOfferings

', 'refs' => [], ], 'DescribeReservedElasticsearchInstancesRequest' => [ 'base' => '

Container for parameters to DescribeReservedElasticsearchInstances

', 'refs' => [], ], 'DescribeReservedElasticsearchInstancesResponse' => [ 'base' => '

Container for results from DescribeReservedElasticsearchInstances

', 'refs' => [], ], 'DescribeVpcEndpointsRequest' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeVpcEndpointsResponse' => [ 'base' => '

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

', 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Description' => '

The description of the progress stage.

', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => '

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

', ], ], 'DisabledOperationException' => [ 'base' => '

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

', 'refs' => [], ], 'DissociatePackageRequest' => [ 'base' => '

Container for request parameters to DissociatePackage operation.

', 'refs' => [], ], 'DissociatePackageResponse' => [ 'base' => '

Container for response returned by DissociatePackage operation.

', 'refs' => [], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$DomainArn' => '

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

', 'VpcEndpoint$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', 'VpcEndpointSummary$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', ], ], 'DomainEndpointOptions' => [ 'base' => '

Options to configure endpoint for the Elasticsearch domain.

', 'refs' => [ 'CreateElasticsearchDomainRequest$DomainEndpointOptions' => '

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

', 'DomainEndpointOptionsStatus$Options' => '

Options to configure endpoint for the Elasticsearch domain.

', 'ElasticsearchDomainStatus$DomainEndpointOptions' => '

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

', 'UpdateElasticsearchDomainConfigRequest$DomainEndpointOptions' => '

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

', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$DomainEndpointOptions' => '

Specifies the DomainEndpointOptions for the Elasticsearch domain.

', ], ], 'DomainId' => [ 'base' => '

Unique identifier for an Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainStatus$DomainId' => '

The unique identifier for the specified Elasticsearch domain.

', ], ], 'DomainInfo' => [ 'base' => NULL, 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => '

Contains the list of Elasticsearch domain information.

', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => '

List of domain names and respective engine types.

', ], ], 'DomainInformation' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionRequest$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionRequest$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionResponse$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionResponse$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'InboundCrossClusterSearchConnection$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'InboundCrossClusterSearchConnection$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'OutboundCrossClusterSearchConnection$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'OutboundCrossClusterSearchConnection$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', ], ], 'DomainName' => [ 'base' => '

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

', 'refs' => [ 'AssociatePackageRequest$DomainName' => '

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

', 'AuthorizeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to provide access to.

', 'CancelElasticsearchServiceSoftwareUpdateRequest$DomainName' => '

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

', 'CreateElasticsearchDomainRequest$DomainName' => '

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

', 'DeleteElasticsearchDomainRequest$DomainName' => '

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

', 'DescribeDomainAutoTunesRequest$DomainName' => '

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

', 'DescribeDomainChangeProgressRequest$DomainName' => '

The domain you want to get the progress information about.

', 'DescribeElasticsearchDomainConfigRequest$DomainName' => '

The Elasticsearch domain that you want to get information about.

', 'DescribeElasticsearchDomainRequest$DomainName' => '

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

', 'DescribeElasticsearchInstanceTypeLimitsRequest$DomainName' => '

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

', 'DissociatePackageRequest$DomainName' => '

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

', 'DomainInfo$DomainName' => '

Specifies the DomainName.

', 'DomainInformation$DomainName' => NULL, 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => '

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

', 'ElasticsearchDomainStatus$DomainName' => '

', 'GetCompatibleElasticsearchVersionsRequest$DomainName' => NULL, 'GetUpgradeHistoryRequest$DomainName' => NULL, 'GetUpgradeStatusRequest$DomainName' => NULL, 'ListElasticsearchInstanceTypesRequest$DomainName' => '

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

', 'ListPackagesForDomainRequest$DomainName' => '

The name of the domain for which you want to list associated packages.

', 'ListVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to retrieve access information for.

', 'ListVpcEndpointsForDomainRequest$DomainName' => '

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

', 'RevokeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain.

', 'StartElasticsearchServiceSoftwareUpdateRequest$DomainName' => '

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

', 'UpdateElasticsearchDomainConfigRequest$DomainName' => '

The name of the Elasticsearch domain that you are updating.

', 'UpgradeElasticsearchDomainRequest$DomainName' => NULL, 'UpgradeElasticsearchDomainResponse$DomainName' => NULL, ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => '

Specify the fully qualified domain for your custom endpoint.

', ], ], 'DomainNameList' => [ 'base' => '

A list of Elasticsearch domain names.

', 'refs' => [ 'DescribeElasticsearchDomainsRequest$DomainNames' => '

The Elasticsearch domains for which you want information.

', ], ], 'DomainPackageDetails' => [ 'base' => '

Information on a package that is associated with a domain.

', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => '

DomainPackageDetails

', 'DissociatePackageResponse$DomainPackageDetails' => '

DomainPackageDetails

', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => '

List of DomainPackageDetails objects.

', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => '

List of DomainPackageDetails objects.

', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => '

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

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => '

The monetary amount of the recurring charge.

', 'ReservedElasticsearchInstance$FixedPrice' => '

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

', 'ReservedElasticsearchInstance$UsagePrice' => '

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

', 'ReservedElasticsearchInstanceOffering$FixedPrice' => '

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

', 'ReservedElasticsearchInstanceOffering$UsagePrice' => '

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

', 'UpgradeStepItem$ProgressPercent' => '

The Floating point value representing progress percentage of a particular step.

', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'UpdateElasticsearchDomainConfigRequest$DryRun' => '

This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

', ], ], 'DryRunResults' => [ 'base' => NULL, 'refs' => [ 'UpdateElasticsearchDomainConfigResponse$DryRunResults' => '

Contains result of DryRun.

', ], ], 'Duration' => [ 'base' => '

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

', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => '

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

', ], ], 'DurationValue' => [ 'base' => '

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

', 'refs' => [ 'Duration$Value' => '

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

', ], ], 'EBSOptions' => [ 'base' => '

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

', 'refs' => [ 'CreateElasticsearchDomainRequest$EBSOptions' => '

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

', 'EBSOptionsStatus$Options' => '

Specifies the EBS options for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$EBSOptions' => '

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

', 'UpdateElasticsearchDomainConfigRequest$EBSOptions' => '

Specify the type and size of the EBS volume that you want to use.

', ], ], 'EBSOptionsStatus' => [ 'base' => '

Status of the EBS options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$EBSOptions' => '

Specifies the EBSOptions for the Elasticsearch domain.

', ], ], 'ESPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'DescribeElasticsearchInstanceTypeLimitsRequest$InstanceType' => '

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

', 'ElasticsearchClusterConfig$InstanceType' => '

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

', 'ElasticsearchClusterConfig$DedicatedMasterType' => '

The instance type for a dedicated master node.

', 'ElasticsearchInstanceTypeList$member' => NULL, 'ReservedElasticsearchInstance$ElasticsearchInstanceType' => '

The Elasticsearch instance type offered by the reserved instance offering.

', 'ReservedElasticsearchInstanceOffering$ElasticsearchInstanceType' => '

The Elasticsearch instance type offered by the reserved instance offering.

', ], ], 'ESWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchClusterConfig$WarmType' => '

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

', ], ], 'ElasticsearchClusterConfig' => [ 'base' => '

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

', 'refs' => [ 'CreateElasticsearchDomainRequest$ElasticsearchClusterConfig' => '

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

', 'ElasticsearchClusterConfigStatus$Options' => '

Specifies the cluster configuration for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$ElasticsearchClusterConfig' => '

The type and number of instances in the domain cluster.

', 'UpdateElasticsearchDomainConfigRequest$ElasticsearchClusterConfig' => '

The type and number of instances to instantiate for the domain cluster.

', ], ], 'ElasticsearchClusterConfigStatus' => [ 'base' => '

Specifies the configuration status for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$ElasticsearchClusterConfig' => '

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

', ], ], 'ElasticsearchDomainConfig' => [ 'base' => '

The configuration of an Elasticsearch domain.

', 'refs' => [ 'DescribeElasticsearchDomainConfigResponse$DomainConfig' => '

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

', 'UpdateElasticsearchDomainConfigResponse$DomainConfig' => '

The status of the updated Elasticsearch domain.

', ], ], 'ElasticsearchDomainStatus' => [ 'base' => '

The current status of an Elasticsearch domain.

', 'refs' => [ 'CreateElasticsearchDomainResponse$DomainStatus' => '

The status of the newly created Elasticsearch domain.

', 'DeleteElasticsearchDomainResponse$DomainStatus' => '

The status of the Elasticsearch domain being deleted.

', 'DescribeElasticsearchDomainResponse$DomainStatus' => '

The current status of the Elasticsearch domain.

', 'ElasticsearchDomainStatusList$member' => NULL, ], ], 'ElasticsearchDomainStatusList' => [ 'base' => '

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

', 'refs' => [ 'DescribeElasticsearchDomainsResponse$DomainStatusList' => '

The status of the domains requested in the DescribeElasticsearchDomains request.

', ], ], 'ElasticsearchInstanceTypeList' => [ 'base' => '

List of instance types supported by Amazon Elasticsearch service.

', 'refs' => [ 'ListElasticsearchInstanceTypesResponse$ElasticsearchInstanceTypes' => '

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

', ], ], 'ElasticsearchVersionList' => [ 'base' => '

List of supported elastic search versions.

', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => NULL, 'ListElasticsearchVersionsResponse$ElasticsearchVersions' => NULL, ], ], 'ElasticsearchVersionStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$ElasticsearchVersion' => '

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

', ], ], 'ElasticsearchVersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => '

The current version of Elasticsearch on which a domain is.

', 'CreateElasticsearchDomainRequest$ElasticsearchVersion' => '

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

', 'DescribeElasticsearchInstanceTypeLimitsRequest$ElasticsearchVersion' => '

Version of Elasticsearch for which Limits are needed.

', 'ElasticsearchDomainStatus$ElasticsearchVersion' => NULL, 'ElasticsearchVersionList$member' => NULL, 'ElasticsearchVersionStatus$Options' => '

Specifies the Elasticsearch version for the specified Elasticsearch domain.

', 'ListElasticsearchInstanceTypesRequest$ElasticsearchVersion' => '

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

', 'UpgradeElasticsearchDomainRequest$TargetVersion' => '

The version of Elasticsearch that you intend to upgrade the domain to.

', 'UpgradeElasticsearchDomainResponse$TargetVersion' => '

The version of Elasticsearch that you intend to upgrade the domain to.

', ], ], 'EncryptionAtRestOptions' => [ 'base' => '

Specifies the Encryption At Rest Options.

', 'refs' => [ 'CreateElasticsearchDomainRequest$EncryptionAtRestOptions' => '

Specifies the Encryption At Rest Options.

', 'ElasticsearchDomainStatus$EncryptionAtRestOptions' => '

Specifies the status of the EncryptionAtRestOptions.

', 'EncryptionAtRestOptionsStatus$Options' => '

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

', 'UpdateElasticsearchDomainConfigRequest$EncryptionAtRestOptions' => '

Specifies the Encryption At Rest Options.

', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$EncryptionAtRestOptions' => '

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Endpoint' => '

The connection endpoint ID for connecting to the domain.

', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchDomainStatus$Endpoints' => '

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

', ], ], 'EngineType' => [ 'base' => NULL, 'refs' => [ 'DomainInfo$EngineType' => '

Specifies the EngineType of the domain.

', 'ListDomainNamesRequest$EngineType' => '

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

', ], ], 'ErrorDetails' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ErrorDetails' => '

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

', 'PackageDetails$ErrorDetails' => '

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

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BaseException$message' => '

A description of the error.

', 'ErrorDetails$ErrorMessage' => NULL, ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => NULL, ], ], 'Filter' => [ 'base' => '

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.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundCrossClusterSearchConnectionsRequest$Filters' => '

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

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

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$Filters' => '

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

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

', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => '

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

', 'ChangeProgressStatusDetails$ChangeId' => '

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

', 'DescribeDomainChangeProgressRequest$ChangeId' => '

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

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$ReservedElasticsearchInstanceOfferingId' => '

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

', 'DescribeReservedElasticsearchInstancesRequest$ReservedElasticsearchInstanceId' => '

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

', 'PurchaseReservedElasticsearchInstanceOfferingRequest$ReservedElasticsearchInstanceOfferingId' => '

The ID of the reserved Elasticsearch instance offering to purchase.

', 'PurchaseReservedElasticsearchInstanceOfferingResponse$ReservedElasticsearchInstanceId' => '

Details of the reserved Elasticsearch instance which was purchased.

', 'ReservedElasticsearchInstance$ReservedElasticsearchInstanceId' => '

The unique identifier for the reservation.

', 'ReservedElasticsearchInstanceOffering$ReservedElasticsearchInstanceOfferingId' => '

The Elasticsearch reserved instance offering identifier.

', ], ], 'GetCompatibleElasticsearchVersionsRequest' => [ 'base' => '

Container for request parameters to GetCompatibleElasticsearchVersions operation.

', 'refs' => [], ], 'GetCompatibleElasticsearchVersionsResponse' => [ 'base' => '

Container for response returned by GetCompatibleElasticsearchVersions operation.

', 'refs' => [], ], 'GetPackageVersionHistoryRequest' => [ 'base' => '

Container for request parameters to GetPackageVersionHistory operation.

', 'refs' => [], ], 'GetPackageVersionHistoryResponse' => [ 'base' => '

Container for response returned by GetPackageVersionHistory operation.

', 'refs' => [], ], 'GetUpgradeHistoryRequest' => [ 'base' => '

Container for request parameters to GetUpgradeHistory operation.

', 'refs' => [], ], 'GetUpgradeHistoryResponse' => [ 'base' => '

Container for response returned by GetUpgradeHistory operation.

', 'refs' => [], ], 'GetUpgradeStatusRequest' => [ 'base' => '

Container for request parameters to GetUpgradeStatus operation.

', 'refs' => [], ], 'GetUpgradeStatusResponse' => [ 'base' => '

Container for response returned by GetUpgradeStatus operation.

', 'refs' => [], ], 'IdentityPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$IdentityPoolId' => '

Specifies the Cognito identity pool ID for Kibana authentication.

', ], ], 'InboundCrossClusterSearchConnection' => [ 'base' => '

Specifies details of an inbound connection.

', 'refs' => [ 'AcceptInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.

', 'DeleteInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.

', 'InboundCrossClusterSearchConnections$member' => NULL, 'RejectInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.

', ], ], 'InboundCrossClusterSearchConnectionStatus' => [ 'base' => '

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

', 'refs' => [ 'InboundCrossClusterSearchConnection$ConnectionStatus' => '

Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

', ], ], 'InboundCrossClusterSearchConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'InboundCrossClusterSearchConnectionStatus$StatusCode' => '

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

PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
APPROVED: Inbound connection is pending acceptance by destination domain owner.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and cannot be used further.

', ], ], 'InboundCrossClusterSearchConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundCrossClusterSearchConnectionsResponse$CrossClusterSearchConnections' => '

Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

', ], ], 'InstanceCount' => [ 'base' => '

Specifies the number of EC2 instances in the Elasticsearch domain.

', 'refs' => [ 'PurchaseReservedElasticsearchInstanceOfferingRequest$InstanceCount' => '

The number of Elasticsearch instances to reserve.

', ], ], 'InstanceCountLimits' => [ 'base' => '

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

', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => NULL, ], ], 'InstanceLimits' => [ 'base' => '

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

', 'refs' => [ 'Limits$InstanceLimits' => NULL, ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'LimitsByRole$key' => NULL, ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$Duration' => '

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

', 'ReservedElasticsearchInstance$ElasticsearchInstanceCount' => '

The number of Elasticsearch instances that have been reserved.

', 'ReservedElasticsearchInstanceOffering$Duration' => '

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

', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'EBSOptions$VolumeSize' => '

Integer to specify the size of an EBS volume.

', 'EBSOptions$Iops' => '

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

', 'EBSOptions$Throughput' => '

Specifies the Throughput for GP3 EBS volume (SSD).

', 'ElasticsearchClusterConfig$InstanceCount' => '

The number of instances in the specified domain cluster.

', 'ElasticsearchClusterConfig$DedicatedMasterCount' => '

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

', 'ElasticsearchClusterConfig$WarmCount' => '

The number of warm nodes in the cluster.

', 'SAMLOptionsInput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

', 'SAMLOptionsOutput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive.

', 'SnapshotOptions$AutomatedSnapshotStartHour' => '

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

', 'ZoneAwarenessConfig$AvailabilityZoneCount' => '

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

', ], ], 'InternalException' => [ 'base' => '

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.

', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidTypeException' => [ 'base' => '

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

', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => '

A list of strings containing detailed information about the errors encountered in a particular step.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => '

Specifies the KMS Key ID for Encryption At Rest options.

', ], ], 'LastUpdated' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdated' => '

The last updated timestamp of the progress stage.

', 'DomainPackageDetails$LastUpdated' => '

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

', 'PackageDetails$LastUpdatedAt' => NULL, ], ], 'LimitExceededException' => [ 'base' => '

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

', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => '

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

MaximumNumberOfDataNodesSupported

ESPartitionInstanceType

MaximumNumberOfDataNodesWithoutMasterNode

ESPartitionInstanceType

', 'StorageTypeLimit$LimitName' => '

Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable

MinimumVolumeSize
MaximumVolumeSize
MaximumIops
MinimumIops
MaximumThroughput
MinimumThroughput

', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'LimitValueList$member' => NULL, ], ], 'LimitValueList' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitValues' => '

Value for given AdditionalLimit$LimitName .

', 'StorageTypeLimit$LimitValues' => '

Values for the StorageTypeLimit$LimitName .

', ], ], 'Limits' => [ 'base' => '

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

', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => '

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

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

', 'refs' => [ 'DescribeElasticsearchInstanceTypeLimitsResponse$LimitsByRole' => NULL, ], ], 'ListDomainNamesRequest' => [ 'base' => '

Container for the parameters to the ListDomainNames operation.

', 'refs' => [], ], 'ListDomainNamesResponse' => [ 'base' => '

The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

', 'refs' => [], ], 'ListDomainsForPackageRequest' => [ 'base' => '

Container for request parameters to ListDomainsForPackage operation.

', 'refs' => [], ], 'ListDomainsForPackageResponse' => [ 'base' => '

Container for response parameters to ListDomainsForPackage operation.

', 'refs' => [], ], 'ListElasticsearchInstanceTypesRequest' => [ 'base' => '

Container for the parameters to the ListElasticsearchInstanceTypes operation.

', 'refs' => [], ], 'ListElasticsearchInstanceTypesResponse' => [ 'base' => '

Container for the parameters returned by ListElasticsearchInstanceTypes operation.

', 'refs' => [], ], 'ListElasticsearchVersionsRequest' => [ 'base' => '

Container for the parameters to the ListElasticsearchVersions operation.

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

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

', 'refs' => [], ], 'ListElasticsearchVersionsResponse' => [ 'base' => '

Container for the parameters for response received from ListElasticsearchVersions operation.

', 'refs' => [], ], 'ListPackagesForDomainRequest' => [ 'base' => '

Container for request parameters to ListPackagesForDomain operation.

', 'refs' => [], ], 'ListPackagesForDomainResponse' => [ 'base' => '

Container for response parameters to ListPackagesForDomain operation.

', 'refs' => [], ], 'ListTagsRequest' => [ 'base' => '

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

', 'refs' => [], ], 'ListTagsResponse' => [ 'base' => '

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

', 'refs' => [], ], 'ListVpcEndpointAccessRequest' => [ 'base' => '

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

', 'refs' => [], ], 'ListVpcEndpointAccessResponse' => [ 'base' => '

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

', 'refs' => [], ], 'ListVpcEndpointsForDomainRequest' => [ 'base' => '

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

', 'refs' => [], ], 'ListVpcEndpointsForDomainResponse' => [ 'base' => '

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

', 'refs' => [], ], 'ListVpcEndpointsRequest' => [ 'base' => '

Container for request parameters to the ListVpcEndpoints operation.

', 'refs' => [], ], 'ListVpcEndpointsResponse' => [ 'base' => '

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

', 'refs' => [], ], 'LogPublishingOption' => [ 'base' => '

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

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

', 'refs' => [ 'LogPublishingOptions$value' => NULL, ], ], 'LogPublishingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateElasticsearchDomainRequest$LogPublishingOptions' => '

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

', 'ElasticsearchDomainStatus$LogPublishingOptions' => '

Log publishing options for the given domain.

', 'LogPublishingOptionsStatus$Options' => '

The log publishing options configured for the Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$LogPublishingOptions' => '

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

', ], ], 'LogPublishingOptionsStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$LogPublishingOptions' => '

Log publishing options for the given domain.

', ], ], 'LogType' => [ 'base' => '

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.

', 'refs' => [ 'LogPublishingOptions$key' => NULL, ], ], 'MasterUserOptions' => [ 'base' => '

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

', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => '

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

', ], ], 'MaxResults' => [ 'base' => '

Set this value to limit the number of results returned.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => '

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

', 'DescribeInboundCrossClusterSearchConnectionsRequest$MaxResults' => '

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

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$MaxResults' => '

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

', 'DescribePackagesRequest$MaxResults' => '

Limits results to a maximum number of packages.

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$MaxResults' => '

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

', 'DescribeReservedElasticsearchInstancesRequest$MaxResults' => '

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

', 'GetPackageVersionHistoryRequest$MaxResults' => '

Limits results to a maximum number of versions.

', 'GetUpgradeHistoryRequest$MaxResults' => NULL, 'ListDomainsForPackageRequest$MaxResults' => '

Limits results to a maximum number of domains.

', 'ListElasticsearchInstanceTypesRequest$MaxResults' => '

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

', 'ListElasticsearchVersionsRequest$MaxResults' => '

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

', 'ListPackagesForDomainRequest$MaxResults' => '

Limits results to a maximum number of packages.

', ], ], 'MaximumInstanceCount' => [ 'base' => '

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

', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => NULL, ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => '

Contains an optional message associated with the domain configuration change.

', 'DryRunResults$Message' => '

Contains an optional message associated with the DryRunResults.

', ], ], 'MinimumInstanceCount' => [ 'base' => '

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

', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => NULL, ], ], 'NextToken' => [ 'base' => '

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

', 'refs' => [ 'DescribeDomainAutoTunesRequest$NextToken' => '

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

', 'DescribeDomainAutoTunesResponse$NextToken' => '

Specifies an identifier to allow retrieval of paginated results.

', 'DescribeInboundCrossClusterSearchConnectionsRequest$NextToken' => '

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

', 'DescribeInboundCrossClusterSearchConnectionsResponse$NextToken' => '

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.

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$NextToken' => '

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

', 'DescribeOutboundCrossClusterSearchConnectionsResponse$NextToken' => '

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.

', 'DescribePackagesRequest$NextToken' => '

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

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$NextToken' => '

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

', 'DescribeReservedElasticsearchInstanceOfferingsResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'DescribeReservedElasticsearchInstancesRequest$NextToken' => '

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

', 'GetPackageVersionHistoryRequest$NextToken' => '

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

', 'GetUpgradeHistoryRequest$NextToken' => NULL, 'ListDomainsForPackageRequest$NextToken' => '

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

', 'ListElasticsearchInstanceTypesRequest$NextToken' => '

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

', 'ListElasticsearchInstanceTypesResponse$NextToken' => '

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

', 'ListElasticsearchVersionsRequest$NextToken' => NULL, 'ListElasticsearchVersionsResponse$NextToken' => NULL, 'ListPackagesForDomainRequest$NextToken' => '

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

', 'ListVpcEndpointAccessRequest$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointAccessResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsForDomainRequest$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsForDomainResponse$NextToken' => '

Information about each endpoint associated with the domain.

', 'ListVpcEndpointsRequest$NextToken' => '

Identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => '

Specifies the node-to-node encryption options.

', 'refs' => [ 'CreateElasticsearchDomainRequest$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions.

', 'ElasticsearchDomainStatus$NodeToNodeEncryptionOptions' => '

Specifies the status of the NodeToNodeEncryptionOptions.

', 'NodeToNodeEncryptionOptionsStatus$Options' => '

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

', 'UpdateElasticsearchDomainConfigRequest$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions.

', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainConfig$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

Specifies the name of the filter.

', 'ValueStringList$member' => NULL, ], ], 'OptionState' => [ 'base' => '

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

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

', 'refs' => [ 'OptionStatus$State' => '

Provides the OptionState for the Elasticsearch domain.

', ], ], 'OptionStatus' => [ 'base' => '

Provides the current status of the entity.

', 'refs' => [ 'AccessPoliciesStatus$Status' => '

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

', 'AdvancedOptionsStatus$Status' => '

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

', 'AdvancedSecurityOptionsStatus$Status' => '

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

', 'CognitoOptionsStatus$Status' => '

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

', 'DomainEndpointOptionsStatus$Status' => '

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

', 'EBSOptionsStatus$Status' => '

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

', 'ElasticsearchClusterConfigStatus$Status' => '

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

', 'ElasticsearchVersionStatus$Status' => '

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

', 'EncryptionAtRestOptionsStatus$Status' => '

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

', 'LogPublishingOptionsStatus$Status' => '

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

', 'NodeToNodeEncryptionOptionsStatus$Status' => '

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

', 'SnapshotOptionsStatus$Status' => '

Specifies the status of a daily automated snapshot.

', 'VPCDerivedInfoStatus$Status' => '

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

', ], ], 'OutboundCrossClusterSearchConnection' => [ 'base' => '

Specifies details of an outbound connection.

', 'refs' => [ 'DeleteOutboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

', 'OutboundCrossClusterSearchConnections$member' => NULL, ], ], 'OutboundCrossClusterSearchConnectionStatus' => [ 'base' => '

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

', 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionResponse$ConnectionStatus' => '

Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.

', 'OutboundCrossClusterSearchConnection$ConnectionStatus' => '

Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

', ], ], 'OutboundCrossClusterSearchConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundCrossClusterSearchConnectionStatus$StatusCode' => '

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

VALIDATING: The outbound connection request is being validated.
VALIDATION_FAILED: Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by destination domain owner.
PROVISIONING: Outbound connection request is in process.
ACTIVE: Outbound connection is active and ready to use.
REJECTED: Outbound connection request is rejected by destination domain owner.
DELETING: Outbound connection deletion is in progress.
DELETED: Outbound connection is deleted and cannot be used further.

', ], ], 'OutboundCrossClusterSearchConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeOutboundCrossClusterSearchConnectionsResponse$CrossClusterSearchConnections' => '

Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

', ], ], 'OverallChangeStatus' => [ 'base' => '

The overall status value of the domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$Status' => '

The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'DomainInformation$OwnerId' => NULL, ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => '

Description of the package.

', 'PackageDetails$PackageDescription' => '

User-specified description of the package.

', 'UpdatePackageRequest$PackageDescription' => '

New description of the package.

', ], ], 'PackageDetails' => [ 'base' => '

Basic information about a package.

', 'refs' => [ 'CreatePackageResponse$PackageDetails' => '

Information about the package PackageDetails.

', 'DeletePackageResponse$PackageDetails' => '

PackageDetails

', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => '

Information about the package PackageDetails.

', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => '

List of PackageDetails objects.

', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => '

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

', 'DeletePackageRequest$PackageID' => '

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

', 'DissociatePackageRequest$PackageID' => '

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

', 'DomainPackageDetails$PackageID' => '

Internal ID of the package.

', 'GetPackageVersionHistoryRequest$PackageID' => '

Returns an audit history of versions of the package.

', 'GetPackageVersionHistoryResponse$PackageID' => NULL, 'ListDomainsForPackageRequest$PackageID' => '

The package for which to list domains.

', 'PackageDetails$PackageID' => '

Internal ID of the package.

', 'UpdatePackageRequest$PackageID' => '

Unique identifier for the package.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => '

Unique identifier for the package.

', 'DomainPackageDetails$PackageName' => '

User specified name of the package.

', 'PackageDetails$PackageName' => '

User specified name of the package.

', ], ], 'PackageSource' => [ 'base' => '

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

', 'refs' => [ 'CreatePackageRequest$PackageSource' => '

The customer S3 location PackageSource for importing the package.

', 'UpdatePackageRequest$PackageSource' => NULL, ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => '

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

', ], ], 'PackageType' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageType' => '

Type of package. Currently supports only TXT-DICTIONARY.

', 'DomainPackageDetails$PackageType' => '

Currently supports only TXT-DICTIONARY.

', 'PackageDetails$PackageType' => '

Currently supports only TXT-DICTIONARY.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => NULL, 'PackageDetails$AvailablePackageVersion' => NULL, 'PackageVersionHistory$PackageVersion' => '

Version of the package.

', ], ], 'PackageVersionHistory' => [ 'base' => '

Details of a package version.

', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => '

List of PackageVersionHistory objects.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => '

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

', ], ], 'PolicyDocument' => [ 'base' => '

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

', 'refs' => [ 'AccessPoliciesStatus$Options' => '

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

', 'CreateElasticsearchDomainRequest$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', 'ElasticsearchDomainStatus$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', 'UpdateElasticsearchDomainConfigRequest$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', ], ], 'PrincipalType' => [ 'base' => '

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.

', 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => '

The type of principal.

', ], ], 'PurchaseReservedElasticsearchInstanceOfferingRequest' => [ 'base' => '

Container for parameters to PurchaseReservedElasticsearchInstanceOffering

', 'refs' => [], ], 'PurchaseReservedElasticsearchInstanceOfferingResponse' => [ 'base' => '

Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

', 'refs' => [], ], 'RecurringCharge' => [ 'base' => '

Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$RecurringCharges' => '

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

', 'ReservedElasticsearchInstanceOffering$RecurringCharges' => '

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

', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => '

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

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'DomainInformation$Region' => NULL, ], ], 'RejectInboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

', 'refs' => [], ], 'RejectInboundCrossClusterSearchConnectionResponse' => [ 'base' => '

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

', 'refs' => [], ], 'RemoveTagsRequest' => [ 'base' => '

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

', 'refs' => [], ], 'ReservationToken' => [ 'base' => NULL, 'refs' => [ 'PurchaseReservedElasticsearchInstanceOfferingRequest$ReservationName' => '

A customer-specified identifier to track this reservation.

', 'PurchaseReservedElasticsearchInstanceOfferingResponse$ReservationName' => '

The customer-specified identifier used to track this reservation.

', 'ReservedElasticsearchInstance$ReservationName' => '

The customer-specified identifier to track this reservation.

', ], ], 'ReservedElasticsearchInstance' => [ 'base' => '

Details of a reserved Elasticsearch instance.

', 'refs' => [ 'ReservedElasticsearchInstanceList$member' => NULL, ], ], 'ReservedElasticsearchInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedElasticsearchInstancesResponse$ReservedElasticsearchInstances' => '

List of reserved Elasticsearch instances.

', ], ], 'ReservedElasticsearchInstanceOffering' => [ 'base' => '

Details of a reserved Elasticsearch instance offering.

', 'refs' => [ 'ReservedElasticsearchInstanceOfferingList$member' => NULL, ], ], 'ReservedElasticsearchInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedElasticsearchInstanceOfferingsResponse$ReservedElasticsearchInstanceOfferings' => '

List of reserved Elasticsearch instance offerings

', ], ], 'ReservedElasticsearchInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$PaymentOption' => '

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

', 'ReservedElasticsearchInstanceOffering$PaymentOption' => '

Payment option for the reserved Elasticsearch instance offering

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

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

', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'RevokeVpcEndpointAccessRequest' => [ 'base' => '

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

', 'refs' => [], ], 'RevokeVpcEndpointAccessResponse' => [ 'base' => '

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

', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => '

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

', ], ], 'RollbackOnDisable' => [ 'base' => '

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

', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => '

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

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3BucketName' => '

Name of the bucket containing the package.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3Key' => '

Key (file name) of the package.

', ], ], 'SAMLEntityId' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$EntityId' => '

The unique Entity ID of the application in SAML Identity Provider.

', ], ], 'SAMLIdp' => [ 'base' => '

Specifies the SAML Identity Provider\'s information.

', 'refs' => [ 'SAMLOptionsInput$Idp' => '

Specifies the SAML Identity Provider\'s information.

', 'SAMLOptionsOutput$Idp' => '

Describes the SAML Identity Provider\'s information.

', ], ], 'SAMLMetadata' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$MetadataContent' => '

The Metadata of the SAML application in xml format.

', ], ], 'SAMLOptionsInput' => [ 'base' => '

Specifies the SAML application configuration for the domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => '

Specifies the SAML application configuration for the domain.

', ], ], 'SAMLOptionsOutput' => [ 'base' => '

Describes the SAML application configured for the domain.

', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => '

Describes the SAML application configured for a domain.

', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => '

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

', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => '

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

', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => '

Specifies Auto-Tune action description.

', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => '

Specifies Auto-Tune action description.

', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => '

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

', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => NULL, ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => '

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

', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => '

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

', ], ], 'ServiceSoftwareOptions' => [ 'base' => '

The current options of an Elasticsearch domain service software options.

', 'refs' => [ 'CancelElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the Elasticsearch service software update.

', 'ElasticsearchDomainStatus$ServiceSoftwareOptions' => '

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

', 'StartElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the Elasticsearch service software update.

', ], ], 'ServiceUrl' => [ 'base' => '

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.

', 'refs' => [ 'ElasticsearchDomainStatus$Endpoint' => '

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

', 'EndpointsMap$value' => NULL, ], ], 'SnapshotOptions' => [ 'base' => '

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

', 'refs' => [ 'CreateElasticsearchDomainRequest$SnapshotOptions' => '

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

', 'ElasticsearchDomainStatus$SnapshotOptions' => '

Specifies the status of the SnapshotOptions

', 'SnapshotOptionsStatus$Options' => '

Specifies the daily snapshot options specified for the Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$SnapshotOptions' => '

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

', ], ], 'SnapshotOptionsStatus' => [ 'base' => '

Status of a daily automated snapshot.

', 'refs' => [ 'ElasticsearchDomainConfig$SnapshotOptions' => '

Specifies the SnapshotOptions for the Elasticsearch domain.

', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => '

Specifies timestamp at which Auto-Tune maintenance schedule start.

', ], ], 'StartElasticsearchServiceSoftwareUpdateRequest' => [ 'base' => '

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

', 'refs' => [], ], 'StartElasticsearchServiceSoftwareUpdateResponse' => [ 'base' => '

The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => '

UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

', ], ], 'StorageSubTypeName' => [ 'base' => '

SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes

standard
gp2
gp3
io1

Refer VolumeType for more information regarding above EBS storage options.

', 'refs' => [ 'StorageType$StorageSubTypeName' => NULL, ], ], 'StorageType' => [ 'base' => '

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

', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => '

Limits that are applicable for given storage type.

', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => '

List of limits that are applicable for given storage type.

', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => '

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

', ], ], 'StorageTypeName' => [ 'base' => '

Type of the storage. List of available storage options:

instance
ebs

', 'refs' => [ 'StorageType$StorageTypeName' => NULL, ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => '

The IAM principal that is allowed access to the domain.

', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => '

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

', 'AutoTuneOptionsOutput$ErrorMessage' => '

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

', 'AutoTuneStatus$ErrorMessage' => '

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

', 'DescribePackagesResponse$NextToken' => NULL, 'DescribeReservedElasticsearchInstancesResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => NULL, 'GetUpgradeHistoryResponse$NextToken' => '

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

', 'ListDomainsForPackageResponse$NextToken' => NULL, 'ListPackagesForDomainResponse$NextToken' => '

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

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'ReservedElasticsearchInstance$ReservedElasticsearchInstanceOfferingId' => '

The offering identifier.

', 'ReservedElasticsearchInstance$CurrencyCode' => '

The currency code for the reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstance$State' => '

The state of the reserved Elasticsearch instance.

', 'ReservedElasticsearchInstanceOffering$CurrencyCode' => '

The currency code for the reserved Elasticsearch instance offering.

', 'SAMLOptionsInput$SubjectKey' => '

The key to use for matching the SAML Subject attribute.

', 'SAMLOptionsInput$RolesKey' => '

The key to use for matching the SAML Roles attribute.

', 'SAMLOptionsOutput$SubjectKey' => '

The key used for matching the SAML Subject attribute.

', 'SAMLOptionsOutput$RolesKey' => '

The key used for matching the SAML Roles attribute.

', 'ServiceSoftwareOptions$CurrentVersion' => '

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

', 'ServiceSoftwareOptions$NewVersion' => '

The new service software version if one is available.

', 'ServiceSoftwareOptions$Description' => '

The description of the UpdateStatus.

', 'StringList$member' => NULL, 'VPCDerivedInfo$VPCId' => '

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

', 'VpcEndpointError$ErrorMessage' => '

A message describing the error.

', 'VpcEndpointSummary$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => '

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

', 'ChangeProgressStatusDetails$CompletedProperties' => '

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

', 'RemoveTagsRequest$TagKeys' => '

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

', 'VPCDerivedInfo$SubnetIds' => '

Specifies the subnets for VPC endpoint.

', 'VPCDerivedInfo$AvailabilityZones' => '

The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

', 'VPCDerivedInfo$SecurityGroupIds' => '

Specifies the security groups for VPC endpoint.

', 'VPCOptions$SubnetIds' => '

Specifies the subnets for VPC endpoint.

', 'VPCOptions$SecurityGroupIds' => '

Specifies the security groups for VPC endpoint.

', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => '

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values:

Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

', ], ], 'Tag' => [ 'base' => '

Specifies a key value pair for a resource tag.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => '

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.

', 'refs' => [ 'Tag$Key' => '

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

', ], ], 'TagList' => [ 'base' => '

A list of Tag

', 'refs' => [ 'AddTagsRequest$TagList' => '

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

', 'CreateElasticsearchDomainRequest$TagList' => '

A list of Tag added during domain creation.

', 'ListTagsResponse$TagList' => '

List of Tag for the requested Elasticsearch domain.

', ], ], 'TagValue' => [ 'base' => '

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.

', 'refs' => [ 'Tag$Value' => '

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'TimeUnit' => [ 'base' => '

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

', 'refs' => [ 'Duration$Unit' => '

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

', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => '

The total number of stages required for the configuration change.

', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => '

Specifies the Auto-Tune options latest version.

', 'OptionStatus$UpdateVersion' => '

Specifies the latest version for the entity.

', ], ], 'UpdateElasticsearchDomainConfigRequest' => [ 'base' => '

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

', 'refs' => [], ], 'UpdateElasticsearchDomainConfigResponse' => [ 'base' => '

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

', 'refs' => [], ], 'UpdatePackageRequest' => [ 'base' => '

Container for request parameters to UpdatePackage operation.

', 'refs' => [], ], 'UpdatePackageResponse' => [ 'base' => '

Container for response returned by UpdatePackage operation.

', 'refs' => [], ], 'UpdateTimestamp' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$CreationDate' => '

Timestamp which tells Auto-Tune options creation date .

', 'AutoTuneStatus$UpdateDate' => '

Timestamp which tells Auto-Tune options last updated time.

', 'ChangeProgressStatusDetails$StartTime' => '

The time at which the configuration change is made on the domain.

', 'OptionStatus$CreationDate' => '

Timestamp which tells the creation date for the entity.

', 'OptionStatus$UpdateDate' => '

Timestamp which tells the last updated time for the entity.

', 'ReservedElasticsearchInstance$StartTime' => '

The time the reservation started.

', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'refs' => [], ], 'UpdateVpcEndpointResponse' => [ 'base' => '

Contains the configuration and status of the VPC endpoint being updated.

', 'refs' => [], ], 'UpgradeElasticsearchDomainRequest' => [ 'base' => '

Container for request parameters to UpgradeElasticsearchDomain operation.

', 'refs' => [], ], 'UpgradeElasticsearchDomainResponse' => [ 'base' => '

Container for response returned by UpgradeElasticsearchDomain operation.

', 'refs' => [], ], 'UpgradeHistory' => [ 'base' => '

History of the last 10 Upgrades and Upgrade Eligibility Checks.

', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => '

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

', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => '

A string that describes the update briefly

', 'UpgradeHistory$UpgradeName' => '

A string that describes the update briefly

', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => '

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

In Progress
Succeeded
Succeeded with Issues
Failed

', 'UpgradeHistory$UpgradeStatus' => '

The overall status of the update. The status can take one of the following values:

In Progress
Succeeded
Succeeded with Issues
Failed

', 'UpgradeStepItem$UpgradeStepStatus' => '

The status of a particular step during an upgrade. The status can take one of the following values:

In Progress
Succeeded
Succeeded with Issues
Failed

', ], ], 'UpgradeStep' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeStep' => '

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

PreUpgradeCheck
Snapshot
Upgrade

', 'UpgradeStepItem$UpgradeStep' => '

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

PreUpgradeCheck
Snapshot
Upgrade

', ], ], 'UpgradeStepItem' => [ 'base' => '

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => '

A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => '

Specifies the Cognito user pool ID for Kibana authentication.

', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => '

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

', 'SAMLOptionsInput$MasterUserName' => '

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

', ], ], 'VPCDerivedInfo' => [ 'base' => '

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

', 'refs' => [ 'ElasticsearchDomainStatus$VPCOptions' => '

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

', 'VPCDerivedInfoStatus$Options' => '

Specifies the VPC options for the specified Elasticsearch domain.

', 'VpcEndpoint$VpcOptions' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

', ], ], 'VPCDerivedInfoStatus' => [ 'base' => '

Status of the VPC options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$VPCOptions' => '

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

', ], ], 'VPCOptions' => [ 'base' => '

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

', 'refs' => [ 'CreateElasticsearchDomainRequest$VPCOptions' => '

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

', 'CreateVpcEndpointRequest$VpcOptions' => '

Options to specify the subnets and security groups for the endpoint.

', 'UpdateElasticsearchDomainConfigRequest$VPCOptions' => '

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

', 'UpdateVpcEndpointRequest$VpcOptions' => '

The security groups and/or subnets to add, remove, or modify.

', ], ], 'ValidationException' => [ 'base' => '

An exception for missing / invalid input fields. Gives http status code of 400.

', 'refs' => [], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

Contains one or more values for the filter.

', ], ], 'VolumeType' => [ 'base' => '

The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.

', 'refs' => [ 'EBSOptions$VolumeType' => '

Specifies the volume type for EBS-based storage.

', ], ], 'VpcEndpoint' => [ 'base' => '

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

', 'refs' => [ 'CreateVpcEndpointResponse$VpcEndpoint' => '

Information about the newly created VPC endpoint.

', 'UpdateVpcEndpointResponse$VpcEndpoint' => '

The endpoint to be updated.

', 'VpcEndpoints$member' => NULL, ], ], 'VpcEndpointError' => [ 'base' => '

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'VpcEndpointErrorList$member' => NULL, ], ], 'VpcEndpointErrorCode' => [ 'base' => '

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.

', 'refs' => [ 'VpcEndpointError$ErrorCode' => '

The code associated with the error.

', ], ], 'VpcEndpointErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpointErrors' => '

Any errors associated with the request.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'DeleteVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint to be deleted.

', 'UpdateVpcEndpointRequest$VpcEndpointId' => '

Unique identifier of the VPC endpoint to be updated.

', 'VpcEndpoint$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointError$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointIdList$member' => NULL, 'VpcEndpointSummary$VpcEndpointId' => '

The unique identifier of the endpoint.

', ], ], 'VpcEndpointIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsRequest$VpcEndpointIds' => '

The unique identifiers of the endpoints to get information about.

', ], ], 'VpcEndpointStatus' => [ 'base' => '

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.

', 'refs' => [ 'VpcEndpoint$Status' => '

The current status of the endpoint.

', 'VpcEndpointSummary$Status' => '

The current status of the endpoint.

', ], ], 'VpcEndpointSummary' => [ 'base' => '

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => '

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

', 'VpcEndpointSummaryList$member' => NULL, ], ], 'VpcEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointsForDomainResponse$VpcEndpointSummaryList' => '

Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.

', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => '

Information about each endpoint.

', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => '

Information about each requested VPC endpoint.

', ], ], 'ZoneAwarenessConfig' => [ 'base' => '

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

', 'refs' => [ 'ElasticsearchClusterConfig$ZoneAwarenessConfig' => '

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

', ], ], ],];