Client library for Amazon Elasticsearch Service

npm install --save @datafire/amazonaws_es

let amazonaws_es = require('@datafire/amazonaws_es').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

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.

amazonaws_es.ListDomainNames({}, context)

• input object

• output ListDomainNamesResponse

amazonaws_es.ListPackagesForDomain({
  "DomainName": ""
}, context)

• input object
  • DomainName required string
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output ListPackagesForDomainResponse

amazonaws_es.DescribeInboundCrossClusterSearchConnections({}, context)

• input object
  • MaxResults string
  • NextToken string
  • Filters array: 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
    • items Filter
  • MaxResults integer: Set this value to limit the number of results returned.
  • NextToken string: Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

• output DescribeInboundCrossClusterSearchConnectionsResponse

amazonaws_es.DeleteInboundCrossClusterSearchConnection({
  "ConnectionId": ""
}, context)

• input object
  • ConnectionId required string

• output DeleteInboundCrossClusterSearchConnectionResponse

amazonaws_es.AcceptInboundCrossClusterSearchConnection({
  "ConnectionId": ""
}, context)

• input object
  • ConnectionId required string

• output AcceptInboundCrossClusterSearchConnectionResponse

amazonaws_es.RejectInboundCrossClusterSearchConnection({
  "ConnectionId": ""
}, context)

• input object
  • ConnectionId required string

• output RejectInboundCrossClusterSearchConnectionResponse

amazonaws_es.CreateOutboundCrossClusterSearchConnection({
  "SourceDomainInfo": {},
  "DestinationDomainInfo": {},
  "ConnectionAlias": ""
}, context)

• input object
  • ConnectionAlias required string: Specifies the connection alias that will be used by the customer for this connection.
  • DestinationDomainInfo required object: Specifies the DomainInformation for the destination Elasticsearch domain.
    • DomainName DomainName
    • OwnerId OwnerId
    • Region Region
  • SourceDomainInfo required object: Specifies the DomainInformation for the source Elasticsearch domain.
    • DomainName DomainName
    • OwnerId OwnerId
    • Region Region

• output CreateOutboundCrossClusterSearchConnectionResponse

amazonaws_es.DescribeOutboundCrossClusterSearchConnections({}, context)

• input object
  • MaxResults string
  • NextToken string
  • Filters array: 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
    • items Filter
  • MaxResults integer: Set this value to limit the number of results returned.
  • NextToken string: Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

• output DescribeOutboundCrossClusterSearchConnectionsResponse

amazonaws_es.DeleteOutboundCrossClusterSearchConnection({
  "ConnectionId": ""
}, context)

• input object
  • ConnectionId required string

• output DeleteOutboundCrossClusterSearchConnectionResponse

amazonaws_es.GetCompatibleElasticsearchVersions({}, context)

• input object
  • domainName string

• output GetCompatibleElasticsearchVersionsResponse

amazonaws_es.CreateElasticsearchDomain({
  "DomainName": ""
}, context)

• input object
  • AccessPolicies string: 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.
  • AdvancedOptions object:

    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.

  • AdvancedSecurityOptions object: 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).
    • Enabled
    • InternalUserDatabaseEnabled
    • MasterUserOptions
      • MasterUserARN
      • MasterUserName
      • MasterUserPassword
    • SAMLOptions
      • Enabled
      • Idp
        • EntityId required
        • MetadataContent required
      • MasterBackendRole
      • MasterUserName
      • RolesKey
      • SessionTimeoutMinutes
      • SubjectKey
  • CognitoOptions object: Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
    • Enabled
    • IdentityPoolId
    • RoleArn
    • UserPoolId
  • DomainEndpointOptions object: Options to configure endpoint for the Elasticsearch domain.
    • CustomEndpoint
    • CustomEndpointCertificateArn
    • CustomEndpointEnabled
    • EnforceHTTPS
    • TLSSecurityPolicy
  • DomainName required string: The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  • EBSOptions object: Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
    • EBSEnabled
    • Iops
    • VolumeSize
    • VolumeType
  • ElasticsearchClusterConfig object: Specifies the configuration for the domain cluster, such as the type and number of instances.
    • DedicatedMasterCount
    • DedicatedMasterEnabled
    • DedicatedMasterType
    • InstanceCount
    • InstanceType
    • WarmCount
    • WarmEnabled
    • WarmType
    • ZoneAwarenessConfig
      • AvailabilityZoneCount
    • ZoneAwarenessEnabled
  • ElasticsearchVersion string: 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.
  • EncryptionAtRestOptions object: Specifies the Encryption At Rest Options.
    • Enabled
    • KmsKeyId
  • LogPublishingOptions object: Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
  • NodeToNodeEncryptionOptions object: Specifies the node-to-node encryption options.
    • Enabled
  • SnapshotOptions object: Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
    • AutomatedSnapshotStartHour
  • VPCOptions object: Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
    • SecurityGroupIds
      • items String
    • SubnetIds
      • items String

• output CreateElasticsearchDomainResponse

amazonaws_es.DescribeElasticsearchDomains({
  "DomainNames": []
}, context)

• input object
  • DomainNames required array: A list of Elasticsearch domain names.
    • items DomainName

• output DescribeElasticsearchDomainsResponse

amazonaws_es.DeleteElasticsearchDomain({
  "DomainName": ""
}, context)

• input object
  • DomainName required string

• output DeleteElasticsearchDomainResponse

amazonaws_es.DescribeElasticsearchDomain({
  "DomainName": ""
}, context)

• input object
  • DomainName required string

• output DescribeElasticsearchDomainResponse

amazonaws_es.DescribeElasticsearchDomainConfig({
  "DomainName": ""
}, context)

• input object
  • DomainName required string

• output DescribeElasticsearchDomainConfigResponse

amazonaws_es.UpdateElasticsearchDomainConfig({
  "DomainName": ""
}, context)

• input object
  • DomainName required string
  • AccessPolicies string: 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.
  • AdvancedOptions object:

    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.

  • AdvancedSecurityOptions object: 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).
    • Enabled
    • InternalUserDatabaseEnabled
    • MasterUserOptions
      • MasterUserARN
      • MasterUserName
      • MasterUserPassword
    • SAMLOptions
      • Enabled
      • Idp
        • EntityId required
        • MetadataContent required
      • MasterBackendRole
      • MasterUserName
      • RolesKey
      • SessionTimeoutMinutes
      • SubjectKey
  • CognitoOptions object: Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
    • Enabled
    • IdentityPoolId
    • RoleArn
    • UserPoolId
  • DomainEndpointOptions object: Options to configure endpoint for the Elasticsearch domain.
    • CustomEndpoint
    • CustomEndpointCertificateArn
    • CustomEndpointEnabled
    • EnforceHTTPS
    • TLSSecurityPolicy
  • EBSOptions object: Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
    • EBSEnabled
    • Iops
    • VolumeSize
    • VolumeType
  • ElasticsearchClusterConfig object: Specifies the configuration for the domain cluster, such as the type and number of instances.
    • DedicatedMasterCount
    • DedicatedMasterEnabled
    • DedicatedMasterType
    • InstanceCount
    • InstanceType
    • WarmCount
    • WarmEnabled
    • WarmType
    • ZoneAwarenessConfig
      • AvailabilityZoneCount
    • ZoneAwarenessEnabled
  • LogPublishingOptions object: Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
  • SnapshotOptions object: Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
    • AutomatedSnapshotStartHour
  • VPCOptions object: Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
    • SecurityGroupIds
      • items String
    • SubnetIds
      • items String

• output UpdateElasticsearchDomainConfigResponse

amazonaws_es.DescribeElasticsearchInstanceTypeLimits({
  "InstanceType": "",
  "ElasticsearchVersion": ""
}, context)

• input object
  • domainName string
  • InstanceType required string
  • ElasticsearchVersion required string

• output DescribeElasticsearchInstanceTypeLimitsResponse

amazonaws_es.ListElasticsearchInstanceTypes({
  "ElasticsearchVersion": ""
}, context)

• input object
  • ElasticsearchVersion required string
  • domainName string
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output ListElasticsearchInstanceTypesResponse

amazonaws_es.PurchaseReservedElasticsearchInstanceOffering({
  "ReservedElasticsearchInstanceOfferingId": "",
  "ReservationName": ""
}, context)

• input object
  • InstanceCount integer: Specifies the number of EC2 instances in the Elasticsearch domain.
  • ReservationName required string: A customer-specified identifier to track this reservation.
  • ReservedElasticsearchInstanceOfferingId required string: The ID of the reserved Elasticsearch instance offering to purchase.

• output PurchaseReservedElasticsearchInstanceOfferingResponse

amazonaws_es.DescribeReservedElasticsearchInstanceOfferings({}, context)

• input object
  • offeringId string
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output DescribeReservedElasticsearchInstanceOfferingsResponse

amazonaws_es.DescribeReservedElasticsearchInstances({}, context)

• input object
  • reservationId string
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output DescribeReservedElasticsearchInstancesResponse

amazonaws_es.DeleteElasticsearchServiceRole({}, context)

• input object

Output schema unknown

amazonaws_es.CancelElasticsearchServiceSoftwareUpdate({
  "DomainName": ""
}, context)

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

• output CancelElasticsearchServiceSoftwareUpdateResponse

amazonaws_es.StartElasticsearchServiceSoftwareUpdate({
  "DomainName": ""
}, context)

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

• output StartElasticsearchServiceSoftwareUpdateResponse

amazonaws_es.UpgradeElasticsearchDomain({
  "DomainName": "",
  "TargetVersion": ""
}, context)

• input object
  • DomainName required string: The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  • PerformCheckOnly boolean: This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
  • TargetVersion required string: The version of Elasticsearch that you intend to upgrade the domain to.

• output UpgradeElasticsearchDomainResponse

amazonaws_es.GetUpgradeHistory({
  "DomainName": ""
}, context)

• input object
  • DomainName required string
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output GetUpgradeHistoryResponse

amazonaws_es.GetUpgradeStatus({
  "DomainName": ""
}, context)

• input object
  • DomainName required string

• output GetUpgradeStatusResponse

amazonaws_es.ListElasticsearchVersions({}, context)

• input object
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output ListElasticsearchVersionsResponse

amazonaws_es.CreatePackage({
  "PackageName": "",
  "PackageType": "",
  "PackageSource": {}
}, context)

• input object
  • PackageDescription string: Description of the package.
  • PackageName required string: Unique identifier for the package.
  • PackageSource required object: The S3 location for importing the package specified as S3BucketName and S3Key
    • S3BucketName
    • S3Key
  • PackageType required string (values: TXT-DICTIONARY): Type of package. Currently supports only TXT-DICTIONARY.

• output CreatePackageResponse

amazonaws_es.AssociatePackage({
  "PackageID": "",
  "DomainName": ""
}, context)

• input object
  • PackageID required string
  • DomainName required string

• output AssociatePackageResponse

amazonaws_es.DescribePackages({}, context)

• input object
  • MaxResults string
  • NextToken string
  • Filters array: A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
    • items DescribePackagesFilter
  • MaxResults integer: Set this value to limit the number of results returned.
  • NextToken string: Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

• output DescribePackagesResponse

amazonaws_es.DissociatePackage({
  "PackageID": "",
  "DomainName": ""
}, context)

• input object
  • PackageID required string
  • DomainName required string

• output DissociatePackageResponse

amazonaws_es.UpdatePackage({
  "PackageID": "",
  "PackageSource": {}
}, context)

• input object
  • CommitMessage string: An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.
  • PackageDescription string: New description of the package.
  • PackageID required string: Unique identifier for the package.
  • PackageSource required object: The S3 location for importing the package specified as S3BucketName and S3Key
    • S3BucketName
    • S3Key

• output UpdatePackageResponse

amazonaws_es.DeletePackage({
  "PackageID": ""
}, context)

• input object
  • PackageID required string

• output DeletePackageResponse

amazonaws_es.ListDomainsForPackage({
  "PackageID": ""
}, context)

• input object
  • PackageID required string
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output ListDomainsForPackageResponse

amazonaws_es.GetPackageVersionHistory({
  "PackageID": ""
}, context)

• input object
  • PackageID required string
  • maxResults integer
  • nextToken string
  • MaxResults string
  • NextToken string

• output GetPackageVersionHistoryResponse

amazonaws_es.AddTags({
  "ARN": "",
  "TagList": []
}, context)

• input object
  • ARN required string: The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
  • TagList required array: A list of Tag
    • items Tag

Output schema unknown

amazonaws_es.RemoveTags({
  "ARN": "",
  "TagKeys": []
}, context)

• input object
  • ARN required string: The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
  • TagKeys required array: Specifies the TagKey list which you want to remove from the Elasticsearch domain.
    • items String

Output schema unknown

amazonaws_es.ListTags({
  "arn": ""
}, context)

• input object
  • arn required string

• output ListTagsResponse

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

• AcceptInboundCrossClusterSearchConnectionRequest object: Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

• AcceptInboundCrossClusterSearchConnectionResponse object: The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection.
  • CrossClusterSearchConnection
    • ConnectionStatus
      • Message
      • StatusCode
    • CrossClusterSearchConnectionId
    • DestinationDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region
    • SourceDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region

• AccessPoliciesStatus object: The configured access rules for the domain's document and search endpoints, and the current status of those rules.
  • Options required
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• AddTagsRequest object: Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.
  • ARN required
  • TagList required
    • items Tag

• AdditionalLimit object: List of limits that are specific to a given InstanceType and for each of it's InstanceRole .
  • LimitName
  • LimitValues
    • items LimitValue

• AdditionalLimitList array
  • items AdditionalLimit

• AdvancedOptions object:

  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.

• AdvancedOptionsStatus object:

  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.

  • Options required
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• AdvancedSecurityOptions object: Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
  • Enabled
  • InternalUserDatabaseEnabled
  • SAMLOptions
    • Enabled
    • Idp
      • EntityId required
      • MetadataContent required
    • RolesKey
    • SessionTimeoutMinutes
    • SubjectKey

• AdvancedSecurityOptionsInput object: 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).
  • Enabled
  • InternalUserDatabaseEnabled
  • MasterUserOptions
    • MasterUserARN
    • MasterUserName
    • MasterUserPassword
  • SAMLOptions
    • Enabled
    • Idp
      • EntityId required
      • MetadataContent required
    • MasterBackendRole
    • MasterUserName
    • RolesKey
    • SessionTimeoutMinutes
    • SubjectKey

• AdvancedSecurityOptionsStatus object: Specifies the status of advanced security options for the specified Elasticsearch domain.
  • Options required
    • Enabled
    • InternalUserDatabaseEnabled
    • SAMLOptions
      • Enabled
      • Idp
        • EntityId required
        • MetadataContent required
      • RolesKey
      • SessionTimeoutMinutes
      • SubjectKey
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• AssociatePackageRequest object: Container for request parameters to AssociatePackage operation.

• AssociatePackageResponse object: Container for response returned by AssociatePackage operation.
  • DomainPackageDetails
    • DomainName
    • DomainPackageStatus
    • ErrorDetails
      • ErrorMessage ErrorMessage
      • ErrorType ErrorType
    • LastUpdated
    • PackageID
    • PackageName
    • PackageType
    • PackageVersion PackageVersion
    • ReferencePath

• BackendRole string

• Boolean boolean

• CancelElasticsearchServiceSoftwareUpdateRequest object: 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.
  • DomainName required

• CancelElasticsearchServiceSoftwareUpdateResponse object: The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
  • ServiceSoftwareOptions
    • AutomatedUpdateDate
    • Cancellable
    • CurrentVersion
    • Description
    • NewVersion
    • OptionalDeployment
    • UpdateAvailable
    • UpdateStatus

• CloudWatchLogsLogGroupArn string: ARN of the Cloudwatch log group to which log needs to be published.

• CognitoOptions object: Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
  • Enabled
  • IdentityPoolId
  • RoleArn
  • UserPoolId

• CognitoOptionsStatus object: Status of the Cognito options for the specified Elasticsearch domain.
  • Options required
    • Enabled
    • IdentityPoolId
    • RoleArn
    • UserPoolId
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• CommitMessage string

• CompatibleElasticsearchVersionsList array
  • items CompatibleVersionsMap

• CompatibleVersionsMap object: A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.
  • SourceVersion
  • TargetVersions ElasticsearchVersionList

• ConnectionAlias string

• CreateElasticsearchDomainRequest object
  • AccessPolicies
  • AdvancedOptions
  • AdvancedSecurityOptions
    • Enabled
    • InternalUserDatabaseEnabled
    • MasterUserOptions
      • MasterUserARN
      • MasterUserName
      • MasterUserPassword
    • SAMLOptions
      • Enabled
      • Idp
        • EntityId required
        • MetadataContent required
      • MasterBackendRole
      • MasterUserName
      • RolesKey
      • SessionTimeoutMinutes
      • SubjectKey
  • CognitoOptions
    • Enabled
    • IdentityPoolId
    • RoleArn
    • UserPoolId
  • DomainEndpointOptions
    • CustomEndpoint
    • CustomEndpointCertificateArn
    • CustomEndpointEnabled
    • EnforceHTTPS
    • TLSSecurityPolicy
  • DomainName required
  • EBSOptions
    • EBSEnabled
    • Iops
    • VolumeSize
    • VolumeType
  • ElasticsearchClusterConfig
    • DedicatedMasterCount
    • DedicatedMasterEnabled
    • DedicatedMasterType
    • InstanceCount
    • InstanceType
    • WarmCount
    • WarmEnabled
    • WarmType
    • ZoneAwarenessConfig
      • AvailabilityZoneCount
    • ZoneAwarenessEnabled
  • ElasticsearchVersion
  • EncryptionAtRestOptions
    • Enabled
    • KmsKeyId
  • LogPublishingOptions
  • NodeToNodeEncryptionOptions
    • Enabled
  • SnapshotOptions
    • AutomatedSnapshotStartHour
  • VPCOptions
    • SecurityGroupIds
      • items String
    • SubnetIds
      • items String

• CreateElasticsearchDomainResponse object: The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.
  • DomainStatus
    • ARN required
    • AccessPolicies
    • AdvancedOptions
    • AdvancedSecurityOptions
      • Enabled
      • InternalUserDatabaseEnabled
      • SAMLOptions
        • Enabled
        • Idp
          • EntityId required
          • MetadataContent required
        • RolesKey
        • SessionTimeoutMinutes
        • SubjectKey
    • CognitoOptions
      • Enabled
      • IdentityPoolId
      • RoleArn
      • UserPoolId
    • Created
    • Deleted
    • DomainEndpointOptions
      • CustomEndpoint
      • CustomEndpointCertificateArn
      • CustomEndpointEnabled
      • EnforceHTTPS
      • TLSSecurityPolicy
    • DomainId required
    • DomainName required
    • EBSOptions
      • EBSEnabled
      • Iops
      • VolumeSize
      • VolumeType
    • ElasticsearchClusterConfig required
      • DedicatedMasterCount
      • DedicatedMasterEnabled
      • DedicatedMasterType
      • InstanceCount
      • InstanceType
      • WarmCount
      • WarmEnabled
      • WarmType
      • ZoneAwarenessConfig
        • AvailabilityZoneCount
      • ZoneAwarenessEnabled
    • ElasticsearchVersion ElasticsearchVersionString
    • EncryptionAtRestOptions
      • Enabled
      • KmsKeyId
    • Endpoint
    • Endpoints
    • LogPublishingOptions
    • NodeToNodeEncryptionOptions
      • Enabled
    • Processing
    • ServiceSoftwareOptions
      • AutomatedUpdateDate
      • Cancellable
      • CurrentVersion
      • Description
      • NewVersion
      • OptionalDeployment
      • UpdateAvailable
      • UpdateStatus
    • SnapshotOptions
      • AutomatedSnapshotStartHour
    • UpgradeProcessing
    • VPCOptions
      • AvailabilityZones
        • items String
      • SecurityGroupIds
        • items String
      • SubnetIds
        • items String
      • VPCId

• CreateOutboundCrossClusterSearchConnectionRequest object: Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.
  • ConnectionAlias required
  • DestinationDomainInfo required
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region
  • SourceDomainInfo required
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region

• CreateOutboundCrossClusterSearchConnectionResponse object: The result of a CreateOutboundCrossClusterSearchConnection request. Contains the details of the newly created cross-cluster search connection.
  • ConnectionAlias
  • ConnectionStatus
    • Message
    • StatusCode
  • CrossClusterSearchConnectionId
  • DestinationDomainInfo
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region
  • SourceDomainInfo
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region

• CreatePackageRequest object: Container for request parameters to CreatePackage operation.
  • PackageDescription
  • PackageName required
  • PackageSource required
    • S3BucketName
    • S3Key
  • PackageType required

• CreatePackageResponse object: Container for response returned by CreatePackage operation.
  • PackageDetails
    • AvailablePackageVersion PackageVersion
    • CreatedAt
    • ErrorDetails
      • ErrorMessage ErrorMessage
      • ErrorType ErrorType
    • LastUpdatedAt LastUpdated
    • PackageDescription
    • PackageID
    • PackageName
    • PackageStatus
    • PackageType

• CreatedAt string

• CrossClusterSearchConnectionId string

• CrossClusterSearchConnectionStatusMessage string

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

• DeleteElasticsearchDomainResponse object: The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.
  • DomainStatus
    • ARN required
    • AccessPolicies
    • AdvancedOptions
    • AdvancedSecurityOptions
      • Enabled
      • InternalUserDatabaseEnabled
      • SAMLOptions
        • Enabled
        • Idp
          • EntityId required
          • MetadataContent required
        • RolesKey
        • SessionTimeoutMinutes
        • SubjectKey
    • CognitoOptions
      • Enabled
      • IdentityPoolId
      • RoleArn
      • UserPoolId
    • Created
    • Deleted
    • DomainEndpointOptions
      • CustomEndpoint
      • CustomEndpointCertificateArn
      • CustomEndpointEnabled
      • EnforceHTTPS
      • TLSSecurityPolicy
    • DomainId required
    • DomainName required
    • EBSOptions
      • EBSEnabled
      • Iops
      • VolumeSize
      • VolumeType
    • ElasticsearchClusterConfig required
      • DedicatedMasterCount
      • DedicatedMasterEnabled
      • DedicatedMasterType
      • InstanceCount
      • InstanceType
      • WarmCount
      • WarmEnabled
      • WarmType
      • ZoneAwarenessConfig
        • AvailabilityZoneCount
      • ZoneAwarenessEnabled
    • ElasticsearchVersion ElasticsearchVersionString
    • EncryptionAtRestOptions
      • Enabled
      • KmsKeyId
    • Endpoint
    • Endpoints
    • LogPublishingOptions
    • NodeToNodeEncryptionOptions
      • Enabled
    • Processing
    • ServiceSoftwareOptions
      • AutomatedUpdateDate
      • Cancellable
      • CurrentVersion
      • Description
      • NewVersion
      • OptionalDeployment
      • UpdateAvailable
      • UpdateStatus
    • SnapshotOptions
      • AutomatedSnapshotStartHour
    • UpgradeProcessing
    • VPCOptions
      • AvailabilityZones
        • items String
      • SecurityGroupIds
        • items String
      • SubnetIds
        • items String
      • VPCId

• DeleteInboundCrossClusterSearchConnectionRequest object: Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

• DeleteInboundCrossClusterSearchConnectionResponse object: The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection.
  • CrossClusterSearchConnection
    • ConnectionStatus
      • Message
      • StatusCode
    • CrossClusterSearchConnectionId
    • DestinationDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region
    • SourceDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region

• DeleteOutboundCrossClusterSearchConnectionRequest object: Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

• DeleteOutboundCrossClusterSearchConnectionResponse object: The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection.
  • CrossClusterSearchConnection
    • ConnectionAlias
    • ConnectionStatus
      • Message
      • StatusCode
    • CrossClusterSearchConnectionId
    • DestinationDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region
    • SourceDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region

• DeletePackageRequest object: Container for request parameters to DeletePackage operation.

• DeletePackageResponse object: Container for response parameters to DeletePackage operation.
  • PackageDetails
    • AvailablePackageVersion PackageVersion
    • CreatedAt
    • ErrorDetails
      • ErrorMessage ErrorMessage
      • ErrorType ErrorType
    • LastUpdatedAt LastUpdated
    • PackageDescription
    • PackageID
    • PackageName
    • PackageStatus
    • PackageType

• DeploymentCloseDateTimeStamp string

• DeploymentStatus string (values: PENDING_UPDATE, IN_PROGRESS, COMPLETED, NOT_ELIGIBLE, ELIGIBLE)

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

• DescribeElasticsearchDomainConfigResponse object: The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.
  • DomainConfig required
    • AccessPolicies
      • Options required
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • AdvancedOptions
      • Options required
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • AdvancedSecurityOptions
      • Options required
        • Enabled
        • InternalUserDatabaseEnabled
        • SAMLOptions
          • Enabled
          • Idp
          • RolesKey
          • SessionTimeoutMinutes
          • SubjectKey
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • CognitoOptions
      • Options required
        • Enabled
        • IdentityPoolId
        • RoleArn
        • UserPoolId
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • DomainEndpointOptions
      • Options required
        • CustomEndpoint
        • CustomEndpointCertificateArn
        • CustomEndpointEnabled
        • EnforceHTTPS
        • TLSSecurityPolicy
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • EBSOptions
      • Options required
        • EBSEnabled
        • Iops
        • VolumeSize
        • VolumeType
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • ElasticsearchClusterConfig
      • Options required
        • DedicatedMasterCount
        • DedicatedMasterEnabled
        • DedicatedMasterType
        • InstanceCount
        • InstanceType
        • WarmCount
        • WarmEnabled
        • WarmType
        • ZoneAwarenessConfig
          • AvailabilityZoneCount
        • ZoneAwarenessEnabled
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • ElasticsearchVersion
      • Options required
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • EncryptionAtRestOptions
      • Options required
        • Enabled
        • KmsKeyId
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • LogPublishingOptions
      • Options
      • Status
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • NodeToNodeEncryptionOptions
      • Options required
        • Enabled
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • SnapshotOptions
      • Options required
        • AutomatedSnapshotStartHour
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • VPCOptions
      • Options required
        • AvailabilityZones
          • items String
        • SecurityGroupIds
          • items String
        • SubnetIds
          • items String
        • VPCId
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion

• DescribeElasticsearchDomainRequest object: Container for the parameters to the DescribeElasticsearchDomain operation.

• DescribeElasticsearchDomainResponse object: The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.
  • DomainStatus required
    • ARN required
    • AccessPolicies
    • AdvancedOptions
    • AdvancedSecurityOptions
      • Enabled
      • InternalUserDatabaseEnabled
      • SAMLOptions
        • Enabled
        • Idp
          • EntityId required
          • MetadataContent required
        • RolesKey
        • SessionTimeoutMinutes
        • SubjectKey
    • CognitoOptions
      • Enabled
      • IdentityPoolId
      • RoleArn
      • UserPoolId
    • Created
    • Deleted
    • DomainEndpointOptions
      • CustomEndpoint
      • CustomEndpointCertificateArn
      • CustomEndpointEnabled
      • EnforceHTTPS
      • TLSSecurityPolicy
    • DomainId required
    • DomainName required
    • EBSOptions
      • EBSEnabled
      • Iops
      • VolumeSize
      • VolumeType
    • ElasticsearchClusterConfig required
      • DedicatedMasterCount
      • DedicatedMasterEnabled
      • DedicatedMasterType
      • InstanceCount
      • InstanceType
      • WarmCount
      • WarmEnabled
      • WarmType
      • ZoneAwarenessConfig
        • AvailabilityZoneCount
      • ZoneAwarenessEnabled
    • ElasticsearchVersion ElasticsearchVersionString
    • EncryptionAtRestOptions
      • Enabled
      • KmsKeyId
    • Endpoint
    • Endpoints
    • LogPublishingOptions
    • NodeToNodeEncryptionOptions
      • Enabled
    • Processing
    • ServiceSoftwareOptions
      • AutomatedUpdateDate
      • Cancellable
      • CurrentVersion
      • Description
      • NewVersion
      • OptionalDeployment
      • UpdateAvailable
      • UpdateStatus
    • SnapshotOptions
      • AutomatedSnapshotStartHour
    • UpgradeProcessing
    • VPCOptions
      • AvailabilityZones
        • items String
      • SecurityGroupIds
        • items String
      • SubnetIds
        • items String
      • VPCId

• DescribeElasticsearchDomainsRequest object: Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.
  • DomainNames required
    • items DomainName

• DescribeElasticsearchDomainsResponse object: The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.
  • DomainStatusList required
    • items ElasticsearchDomainStatus

• DescribeElasticsearchInstanceTypeLimitsRequest object: Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

• DescribeElasticsearchInstanceTypeLimitsResponse object: Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.
  • LimitsByRole LimitsByRole

• DescribeInboundCrossClusterSearchConnectionsRequest object: Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.
  • Filters
    • items Filter
  • MaxResults
  • NextToken

• DescribeInboundCrossClusterSearchConnectionsResponse object: The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.
  • CrossClusterSearchConnections
    • items InboundCrossClusterSearchConnection
  • NextToken

• DescribeOutboundCrossClusterSearchConnectionsRequest object: Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.
  • Filters
    • items Filter
  • MaxResults
  • NextToken

• DescribeOutboundCrossClusterSearchConnectionsResponse object: The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.
  • CrossClusterSearchConnections
    • items OutboundCrossClusterSearchConnection
  • NextToken

• DescribePackagesFilter object: Filter to apply in DescribePackage response.
  • Name
  • Value
    • items DescribePackagesFilterValue

• DescribePackagesFilterList array: A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
  • items DescribePackagesFilter

• DescribePackagesFilterName string (values: PackageID, PackageName, PackageStatus)

• DescribePackagesFilterValue string

• DescribePackagesFilterValues array
  • items DescribePackagesFilterValue

• DescribePackagesRequest object: Container for request parameters to DescribePackage operation.
  • Filters
    • items DescribePackagesFilter
  • MaxResults
  • NextToken

• DescribePackagesResponse object: Container for response returned by DescribePackages operation.
  • NextToken String
  • PackageDetailsList
    • items PackageDetails

• DescribeReservedElasticsearchInstanceOfferingsRequest object: Container for parameters to DescribeReservedElasticsearchInstanceOfferings

• DescribeReservedElasticsearchInstanceOfferingsResponse object: Container for results from DescribeReservedElasticsearchInstanceOfferings
  • NextToken
  • ReservedElasticsearchInstanceOfferings
    • items ReservedElasticsearchInstanceOffering

• DescribeReservedElasticsearchInstancesRequest object: Container for parameters to DescribeReservedElasticsearchInstances

• DescribeReservedElasticsearchInstancesResponse object: Container for results from DescribeReservedElasticsearchInstances
  • NextToken
  • ReservedElasticsearchInstances
    • items ReservedElasticsearchInstance

• DissociatePackageRequest object: Container for request parameters to DissociatePackage operation.

• DissociatePackageResponse object: Container for response returned by DissociatePackage operation.
  • DomainPackageDetails
    • DomainName
    • DomainPackageStatus
    • ErrorDetails
      • ErrorMessage ErrorMessage
      • ErrorType ErrorType
    • LastUpdated
    • PackageID
    • PackageName
    • PackageType
    • PackageVersion PackageVersion
    • ReferencePath

• DomainEndpointOptions object: Options to configure endpoint for the Elasticsearch domain.
  • CustomEndpoint
  • CustomEndpointCertificateArn
  • CustomEndpointEnabled
  • EnforceHTTPS
  • TLSSecurityPolicy

• DomainEndpointOptionsStatus object: The configured endpoint options for the domain and their current status.
  • Options required
    • CustomEndpoint
    • CustomEndpointCertificateArn
    • CustomEndpointEnabled
    • EnforceHTTPS
    • TLSSecurityPolicy
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• DomainId string: Unique identifier for an Elasticsearch domain.

• DomainInfo object
  • DomainName

• DomainInfoList array: Contains the list of Elasticsearch domain information.
  • items DomainInfo

• DomainInformation object
  • DomainName required DomainName
  • OwnerId OwnerId
  • Region Region

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

• DomainNameFqdn string

• DomainNameList array: A list of Elasticsearch domain names.
  • items DomainName

• DomainPackageDetails object: Information on a package that is associated with a domain.
  • DomainName
  • DomainPackageStatus
  • ErrorDetails
    • ErrorMessage ErrorMessage
    • ErrorType ErrorType
  • LastUpdated
  • PackageID
  • PackageName
  • PackageType
  • PackageVersion PackageVersion
  • ReferencePath

• DomainPackageDetailsList array
  • items DomainPackageDetails

• DomainPackageStatus string (values: ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, DISSOCIATION_FAILED)

• Double number

• EBSOptions object: Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
  • EBSEnabled
  • Iops
  • VolumeSize
  • VolumeType

• EBSOptionsStatus object: Status of the EBS options for the specified Elasticsearch domain.
  • Options required
    • EBSEnabled
    • Iops
    • VolumeSize
    • VolumeType
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• ESPartitionInstanceType string (values: m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch)

• ESWarmPartitionInstanceType string (values: ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch)

• ElasticsearchClusterConfig object: Specifies the configuration for the domain cluster, such as the type and number of instances.
  • DedicatedMasterCount
  • DedicatedMasterEnabled
  • DedicatedMasterType
  • InstanceCount
  • InstanceType
  • WarmCount
  • WarmEnabled
  • WarmType
  • ZoneAwarenessConfig
    • AvailabilityZoneCount
  • ZoneAwarenessEnabled

• ElasticsearchClusterConfigStatus object: Specifies the configuration status for the specified Elasticsearch domain.
  • Options required
    • DedicatedMasterCount
    • DedicatedMasterEnabled
    • DedicatedMasterType
    • InstanceCount
    • InstanceType
    • WarmCount
    • WarmEnabled
    • WarmType
    • ZoneAwarenessConfig
      • AvailabilityZoneCount
    • ZoneAwarenessEnabled
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• ElasticsearchDomainConfig object: The configuration of an Elasticsearch domain.
  • AccessPolicies
    • Options required
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • AdvancedOptions
    • Options required
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • AdvancedSecurityOptions
    • Options required
      • Enabled
      • InternalUserDatabaseEnabled
      • SAMLOptions
        • Enabled
        • Idp
          • EntityId required
          • MetadataContent required
        • RolesKey
        • SessionTimeoutMinutes
        • SubjectKey
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • CognitoOptions
    • Options required
      • Enabled
      • IdentityPoolId
      • RoleArn
      • UserPoolId
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • DomainEndpointOptions
    • Options required
      • CustomEndpoint
      • CustomEndpointCertificateArn
      • CustomEndpointEnabled
      • EnforceHTTPS
      • TLSSecurityPolicy
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • EBSOptions
    • Options required
      • EBSEnabled
      • Iops
      • VolumeSize
      • VolumeType
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • ElasticsearchClusterConfig
    • Options required
      • DedicatedMasterCount
      • DedicatedMasterEnabled
      • DedicatedMasterType
      • InstanceCount
      • InstanceType
      • WarmCount
      • WarmEnabled
      • WarmType
      • ZoneAwarenessConfig
        • AvailabilityZoneCount
      • ZoneAwarenessEnabled
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • ElasticsearchVersion
    • Options required
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • EncryptionAtRestOptions
    • Options required
      • Enabled
      • KmsKeyId
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • LogPublishingOptions
    • Options
    • Status
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • NodeToNodeEncryptionOptions
    • Options required
      • Enabled
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • SnapshotOptions
    • Options required
      • AutomatedSnapshotStartHour
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion
  • VPCOptions
    • Options required
      • AvailabilityZones
        • items String
      • SecurityGroupIds
        • items String
      • SubnetIds
        • items String
      • VPCId
    • Status required
      • CreationDate required
      • PendingDeletion
      • State required
      • UpdateDate required
      • UpdateVersion

• ElasticsearchDomainStatus object: The current status of an Elasticsearch domain.
  • ARN required
  • AccessPolicies
  • AdvancedOptions
  • AdvancedSecurityOptions
    • Enabled
    • InternalUserDatabaseEnabled
    • SAMLOptions
      • Enabled
      • Idp
        • EntityId required
        • MetadataContent required
      • RolesKey
      • SessionTimeoutMinutes
      • SubjectKey
  • CognitoOptions
    • Enabled
    • IdentityPoolId
    • RoleArn
    • UserPoolId
  • Created
  • Deleted
  • DomainEndpointOptions
    • CustomEndpoint
    • CustomEndpointCertificateArn
    • CustomEndpointEnabled
    • EnforceHTTPS
    • TLSSecurityPolicy
  • DomainId required
  • DomainName required
  • EBSOptions
    • EBSEnabled
    • Iops
    • VolumeSize
    • VolumeType
  • ElasticsearchClusterConfig required
    • DedicatedMasterCount
    • DedicatedMasterEnabled
    • DedicatedMasterType
    • InstanceCount
    • InstanceType
    • WarmCount
    • WarmEnabled
    • WarmType
    • ZoneAwarenessConfig
      • AvailabilityZoneCount
    • ZoneAwarenessEnabled
  • ElasticsearchVersion ElasticsearchVersionString
  • EncryptionAtRestOptions
    • Enabled
    • KmsKeyId
  • Endpoint
  • Endpoints
  • LogPublishingOptions
  • NodeToNodeEncryptionOptions
    • Enabled
  • Processing
  • ServiceSoftwareOptions
    • AutomatedUpdateDate
    • Cancellable
    • CurrentVersion
    • Description
    • NewVersion
    • OptionalDeployment
    • UpdateAvailable
    • UpdateStatus
  • SnapshotOptions
    • AutomatedSnapshotStartHour
  • UpgradeProcessing
  • VPCOptions
    • AvailabilityZones
      • items String
    • SecurityGroupIds
      • items String
    • SubnetIds
      • items String
    • VPCId

• ElasticsearchDomainStatusList array: A list that contains the status of each requested Elasticsearch domain.
  • items ElasticsearchDomainStatus

• ElasticsearchInstanceTypeList array: List of instance types supported by Amazon Elasticsearch service.
  • items ESPartitionInstanceType

• ElasticsearchVersionList array: List of supported elastic search versions.
  • items ElasticsearchVersionString

• ElasticsearchVersionStatus object: Status of the Elasticsearch version options for the specified Elasticsearch domain.
  • Options required
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• ElasticsearchVersionString string

• EncryptionAtRestOptions object: Specifies the Encryption At Rest Options.
  • Enabled
  • KmsKeyId

• EncryptionAtRestOptionsStatus object: Status of the Encryption At Rest options for the specified Elasticsearch domain.
  • Options required
    • Enabled
    • KmsKeyId
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• EndpointsMap object

• ErrorDetails object
  • ErrorMessage ErrorMessage
  • ErrorType ErrorType

• ErrorMessage string

• ErrorType string

• Filter object: A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
  • Name
  • Values
    • items NonEmptyString

• FilterList array
  • items Filter

• GUID string

• GetCompatibleElasticsearchVersionsRequest object: Container for request parameters to GetCompatibleElasticsearchVersions operation.

• GetCompatibleElasticsearchVersionsResponse object: Container for response returned by GetCompatibleElasticsearchVersions operation.
  • CompatibleElasticsearchVersions
    • items CompatibleVersionsMap

• GetPackageVersionHistoryRequest object: Container for request parameters to GetPackageVersionHistory operation.

• GetPackageVersionHistoryResponse object: Container for response returned by GetPackageVersionHistory operation.
  • NextToken String
  • PackageID PackageID
  • PackageVersionHistoryList
    • items PackageVersionHistory

• GetUpgradeHistoryRequest object: Container for request parameters to GetUpgradeHistory operation.

• GetUpgradeHistoryResponse object: Container for response returned by GetUpgradeHistory operation.
  • NextToken
  • UpgradeHistories
    • items UpgradeHistory

• GetUpgradeStatusRequest object: Container for request parameters to GetUpgradeStatus operation.

• GetUpgradeStatusResponse object: Container for response returned by GetUpgradeStatus operation.
  • StepStatus
  • UpgradeName
  • UpgradeStep

• IdentityPoolId string

• InboundCrossClusterSearchConnection object: Specifies details of an inbound connection.
  • ConnectionStatus
    • Message
    • StatusCode
  • CrossClusterSearchConnectionId
  • DestinationDomainInfo
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region
  • SourceDomainInfo
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region

• InboundCrossClusterSearchConnectionStatus object: Specifies the coonection status of an inbound cross-cluster search connection.
  • Message
  • StatusCode

• InboundCrossClusterSearchConnectionStatusCode string (values: PENDING_ACCEPTANCE, APPROVED, REJECTING, REJECTED, DELETING, DELETED)

• InboundCrossClusterSearchConnections array
  • items InboundCrossClusterSearchConnection

• InstanceCount integer: Specifies the number of EC2 instances in the Elasticsearch domain.

• InstanceCountLimits object: InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
  • MaximumInstanceCount MaximumInstanceCount
  • MinimumInstanceCount MinimumInstanceCount

• InstanceLimits object: InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
  • InstanceCountLimits InstanceCountLimits

• InstanceRole string

• Integer integer

• IntegerClass integer

• Issue string

• Issues array
  • items Issue

• KmsKeyId string

• LastUpdated string

• LimitName string

• LimitValue string

• LimitValueList array
  • items LimitValue

• Limits object: Limits for given InstanceType and for each of it's role.
  Limits contains following StorageTypes, InstanceLimits and AdditionalLimits
  • AdditionalLimits
    • items AdditionalLimit
  • InstanceLimits InstanceLimits
  • StorageTypes
    • items StorageType

• LimitsByRole object: Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:
  • data: If the given 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

• ListDomainNamesResponse object: The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.
  • DomainNames
    • items DomainInfo

• ListDomainsForPackageRequest object: Container for request parameters to ListDomainsForPackage operation.

• ListDomainsForPackageResponse object: Container for response parameters to ListDomainsForPackage operation.
  • DomainPackageDetailsList
    • items DomainPackageDetails
  • NextToken String

• ListElasticsearchInstanceTypesRequest object: Container for the parameters to the ListElasticsearchInstanceTypes operation.

• ListElasticsearchInstanceTypesResponse object: Container for the parameters returned by ListElasticsearchInstanceTypes operation.
  • ElasticsearchInstanceTypes
    • items ESPartitionInstanceType
  • NextToken

• ListElasticsearchVersionsRequest object:

  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.

• ListElasticsearchVersionsResponse object: Container for the parameters for response received from ListElasticsearchVersions operation.
  • ElasticsearchVersions ElasticsearchVersionList
  • NextToken NextToken

• ListPackagesForDomainRequest object: Container for request parameters to ListPackagesForDomain operation.

• ListPackagesForDomainResponse object: Container for response parameters to ListPackagesForDomain operation.
  • DomainPackageDetailsList
    • items DomainPackageDetails
  • NextToken

• ListTagsRequest object: 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.

• ListTagsResponse object: The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.
  • TagList
    • items Tag

• LogPublishingOption object: Log Publishing option that is set for given domain.
  Attributes and their details:
  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
  • Enabled: Whether the log publishing for given log type is enabled or not
  • CloudWatchLogsLogGroupArn CloudWatchLogsLogGroupArn
  • Enabled

• LogPublishingOptions object

• LogPublishingOptionsStatus object: The configured log publishing options for the domain and their current status.
  • Options
  • Status
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• LogType string (values: INDEX_SLOW_LOGS, SEARCH_SLOW_LOGS, ES_APPLICATION_LOGS, AUDIT_LOGS): 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.

• MasterUserOptions object: Credentials for the master user: username and password, ARN, or both.
  • MasterUserARN
  • MasterUserName
  • MasterUserPassword

• MaxResults integer: Set this value to limit the number of results returned.

• MaximumInstanceCount integer: Maximum number of Instances that can be instantiated for given InstanceType.

• MinimumInstanceCount integer: Minimum number of Instances that can be instantiated for given InstanceType.

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

• NodeToNodeEncryptionOptions object: Specifies the node-to-node encryption options.
  • Enabled

• NodeToNodeEncryptionOptionsStatus object: Status of the node-to-node encryption options for the specified Elasticsearch domain.
  • Options required
    • Enabled
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• NonEmptyString string

• OptionState string (values: RequiresIndexDocuments, Processing, Active):

  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.

• OptionStatus object: Provides the current status of the entity.
  • CreationDate required
  • PendingDeletion
  • State required
  • UpdateDate required
  • UpdateVersion

• OutboundCrossClusterSearchConnection object: Specifies details of an outbound connection.
  • ConnectionAlias
  • ConnectionStatus
    • Message
    • StatusCode
  • CrossClusterSearchConnectionId
  • DestinationDomainInfo
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region
  • SourceDomainInfo
    • DomainName required DomainName
    • OwnerId OwnerId
    • Region Region

• OutboundCrossClusterSearchConnectionStatus object: Specifies the connection status of an outbound cross-cluster search connection.
  • Message
  • StatusCode

• OutboundCrossClusterSearchConnectionStatusCode string (values: PENDING_ACCEPTANCE, VALIDATING, VALIDATION_FAILED, PROVISIONING, ACTIVE, REJECTED, DELETING, DELETED)

• OutboundCrossClusterSearchConnections array
  • items OutboundCrossClusterSearchConnection

• OwnerId string

• PackageDescription string

• PackageDetails object: Basic information about a package.
  • AvailablePackageVersion PackageVersion
  • CreatedAt
  • ErrorDetails
    • ErrorMessage ErrorMessage
    • ErrorType ErrorType
  • LastUpdatedAt LastUpdated
  • PackageDescription
  • PackageID
  • PackageName
  • PackageStatus
  • PackageType

• PackageDetailsList array
  • items PackageDetails

• PackageID string

• PackageName string

• PackageSource object: The S3 location for importing the package specified as S3BucketName and S3Key
  • S3BucketName
  • S3Key

• PackageStatus string (values: COPYING, COPY_FAILED, VALIDATING, VALIDATION_FAILED, AVAILABLE, DELETING, DELETED, DELETE_FAILED)

• PackageType string (values: TXT-DICTIONARY)

• PackageVersion string

• PackageVersionHistory object: Details of a package version.
  • CommitMessage
  • CreatedAt
  • PackageVersion

• PackageVersionHistoryList array
  • items PackageVersionHistory

• Password string

• PolicyDocument string: 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.

• PurchaseReservedElasticsearchInstanceOfferingRequest object: Container for parameters to PurchaseReservedElasticsearchInstanceOffering
  • InstanceCount
  • ReservationName required
  • ReservedElasticsearchInstanceOfferingId required

• PurchaseReservedElasticsearchInstanceOfferingResponse object: Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.
  • ReservationName
  • ReservedElasticsearchInstanceId

• RecurringCharge object: Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
  • RecurringChargeAmount
  • RecurringChargeFrequency

• RecurringChargeList array
  • items RecurringCharge

• ReferencePath string

• Region string

• RejectInboundCrossClusterSearchConnectionRequest object: Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

• RejectInboundCrossClusterSearchConnectionResponse object: The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection.
  • CrossClusterSearchConnection
    • ConnectionStatus
      • Message
      • StatusCode
    • CrossClusterSearchConnectionId
    • DestinationDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region
    • SourceDomainInfo
      • DomainName required DomainName
      • OwnerId OwnerId
      • Region Region

• RemoveTagsRequest object: Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.
  • ARN required
  • TagKeys required
    • items String

• ReservationToken string

• ReservedElasticsearchInstance object: Details of a reserved Elasticsearch instance.
  • CurrencyCode
  • Duration
  • ElasticsearchInstanceCount
  • ElasticsearchInstanceType
  • FixedPrice
  • PaymentOption
  • RecurringCharges
    • items RecurringCharge
  • ReservationName
  • ReservedElasticsearchInstanceId
  • ReservedElasticsearchInstanceOfferingId
  • StartTime
  • State
  • UsagePrice

• ReservedElasticsearchInstanceList array
  • items ReservedElasticsearchInstance

• ReservedElasticsearchInstanceOffering object: Details of a reserved Elasticsearch instance offering.
  • CurrencyCode
  • Duration
  • ElasticsearchInstanceType
  • FixedPrice
  • PaymentOption
  • RecurringCharges
    • items RecurringCharge
  • ReservedElasticsearchInstanceOfferingId
  • UsagePrice

• ReservedElasticsearchInstanceOfferingList array
  • items ReservedElasticsearchInstanceOffering

• ReservedElasticsearchInstancePaymentOption string (values: ALL_UPFRONT, PARTIAL_UPFRONT, NO_UPFRONT)

• RoleArn string

• S3BucketName string

• S3Key string

• SAMLEntityId string

• SAMLIdp object: Specifies the SAML Identity Provider's information.
  • EntityId required
  • MetadataContent required

• SAMLMetadata string

• SAMLOptionsInput object: Specifies the SAML application configuration for the domain.
  • Enabled
  • Idp
    • EntityId required
    • MetadataContent required
  • MasterBackendRole
  • MasterUserName
  • RolesKey
  • SessionTimeoutMinutes
  • SubjectKey

• SAMLOptionsOutput object: Describes the SAML application configured for the domain.
  • Enabled
  • Idp
    • EntityId required
    • MetadataContent required
  • RolesKey
  • SessionTimeoutMinutes
  • SubjectKey

• ServiceSoftwareOptions object: The current options of an Elasticsearch domain service software options.
  • AutomatedUpdateDate
  • Cancellable
  • CurrentVersion
  • Description
  • NewVersion
  • OptionalDeployment
  • UpdateAvailable
  • UpdateStatus

• ServiceUrl string: The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.

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

• SnapshotOptionsStatus object: Status of a daily automated snapshot.
  • Options required
    • AutomatedSnapshotStartHour
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• StartElasticsearchServiceSoftwareUpdateRequest object: 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.
  • DomainName required

• StartElasticsearchServiceSoftwareUpdateResponse object: The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
  • ServiceSoftwareOptions
    • AutomatedUpdateDate
    • Cancellable
    • CurrentVersion
    • Description
    • NewVersion
    • OptionalDeployment
    • UpdateAvailable
    • UpdateStatus

• StartTimestamp string

• StorageSubTypeName string: SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes
  1. standard
  2. gp2
  3. io1
  Refer VolumeType for more information regarding above EBS storage options.

• StorageType object: StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
  • StorageSubTypeName StorageSubTypeName
  • StorageTypeLimits
    • items StorageTypeLimit
  • StorageTypeName StorageTypeName

• StorageTypeLimit object: Limits that are applicable for given storage type.
  • LimitName
  • LimitValues
    • items LimitValue

• StorageTypeLimitList array
  • items StorageTypeLimit

• StorageTypeList array
  • items StorageType

• StorageTypeName string: Type of the storage. List of available storage options:
  1. instance
  Inbuilt storage available for the given Instance
  2. ebs
  Elastic block storage that would be attached to the given Instance

• String string

• StringList array
  • items String

• TLSSecurityPolicy string (values: Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07)

• Tag object: Specifies a key value pair for a resource tag.
  • Key required
  • Value required

• TagKey string: A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

• TagList array: A list of Tag
  • items Tag

• TagValue string: A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.

• UIntValue integer

• UpdateElasticsearchDomainConfigRequest object: Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.
  • AccessPolicies
  • AdvancedOptions
  • AdvancedSecurityOptions
    • Enabled
    • InternalUserDatabaseEnabled
    • MasterUserOptions
      • MasterUserARN
      • MasterUserName
      • MasterUserPassword
    • SAMLOptions
      • Enabled
      • Idp
        • EntityId required
        • MetadataContent required
      • MasterBackendRole
      • MasterUserName
      • RolesKey
      • SessionTimeoutMinutes
      • SubjectKey
  • CognitoOptions
    • Enabled
    • IdentityPoolId
    • RoleArn
    • UserPoolId
  • DomainEndpointOptions
    • CustomEndpoint
    • CustomEndpointCertificateArn
    • CustomEndpointEnabled
    • EnforceHTTPS
    • TLSSecurityPolicy
  • EBSOptions
    • EBSEnabled
    • Iops
    • VolumeSize
    • VolumeType
  • ElasticsearchClusterConfig
    • DedicatedMasterCount
    • DedicatedMasterEnabled
    • DedicatedMasterType
    • InstanceCount
    • InstanceType
    • WarmCount
    • WarmEnabled
    • WarmType
    • ZoneAwarenessConfig
      • AvailabilityZoneCount
    • ZoneAwarenessEnabled
  • LogPublishingOptions
  • SnapshotOptions
    • AutomatedSnapshotStartHour
  • VPCOptions
    • SecurityGroupIds
      • items String
    • SubnetIds
      • items String

• UpdateElasticsearchDomainConfigResponse object: The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.
  • DomainConfig required
    • AccessPolicies
      • Options required
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • AdvancedOptions
      • Options required
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • AdvancedSecurityOptions
      • Options required
        • Enabled
        • InternalUserDatabaseEnabled
        • SAMLOptions
          • Enabled
          • Idp
          • RolesKey
          • SessionTimeoutMinutes
          • SubjectKey
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • CognitoOptions
      • Options required
        • Enabled
        • IdentityPoolId
        • RoleArn
        • UserPoolId
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • DomainEndpointOptions
      • Options required
        • CustomEndpoint
        • CustomEndpointCertificateArn
        • CustomEndpointEnabled
        • EnforceHTTPS
        • TLSSecurityPolicy
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • EBSOptions
      • Options required
        • EBSEnabled
        • Iops
        • VolumeSize
        • VolumeType
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • ElasticsearchClusterConfig
      • Options required
        • DedicatedMasterCount
        • DedicatedMasterEnabled
        • DedicatedMasterType
        • InstanceCount
        • InstanceType
        • WarmCount
        • WarmEnabled
        • WarmType
        • ZoneAwarenessConfig
          • AvailabilityZoneCount
        • ZoneAwarenessEnabled
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • ElasticsearchVersion
      • Options required
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • EncryptionAtRestOptions
      • Options required
        • Enabled
        • KmsKeyId
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • LogPublishingOptions
      • Options
      • Status
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • NodeToNodeEncryptionOptions
      • Options required
        • Enabled
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • SnapshotOptions
      • Options required
        • AutomatedSnapshotStartHour
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion
    • VPCOptions
      • Options required
        • AvailabilityZones
          • items String
        • SecurityGroupIds
          • items String
        • SubnetIds
          • items String
        • VPCId
      • Status required
        • CreationDate required
        • PendingDeletion
        • State required
        • UpdateDate required
        • UpdateVersion

• UpdatePackageRequest object: Container for request parameters to UpdatePackage operation.
  • CommitMessage
  • PackageDescription
  • PackageID required
  • PackageSource required PackageSource

• UpdatePackageResponse object: Container for response returned by UpdatePackage operation.
  • PackageDetails
    • AvailablePackageVersion PackageVersion
    • CreatedAt
    • ErrorDetails
      • ErrorMessage ErrorMessage
      • ErrorType ErrorType
    • LastUpdatedAt LastUpdated
    • PackageDescription
    • PackageID
    • PackageName
    • PackageStatus
    • PackageType

• UpdateTimestamp string

• UpgradeElasticsearchDomainRequest object: Container for request parameters to UpgradeElasticsearchDomain operation.
  • DomainName required DomainName
  • PerformCheckOnly
  • TargetVersion required

• UpgradeElasticsearchDomainResponse object: Container for response returned by UpgradeElasticsearchDomain operation.
  • DomainName DomainName
  • PerformCheckOnly
  • TargetVersion

• UpgradeHistory object: History of the last 10 Upgrades and Upgrade Eligibility Checks.
  • StartTimestamp
  • StepsList
    • items UpgradeStepItem
  • UpgradeName
  • UpgradeStatus

• UpgradeHistoryList array
  • items UpgradeHistory

• UpgradeName string

• UpgradeStatus string (values: IN_PROGRESS, SUCCEEDED, SUCCEEDED_WITH_ISSUES, FAILED)

• UpgradeStep string (values: PRE_UPGRADE_CHECK, SNAPSHOT, UPGRADE)

• UpgradeStepItem object: Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
  • Issues
    • items Issue
  • ProgressPercent
  • UpgradeStep
  • UpgradeStepStatus

• UpgradeStepsList array
  • items UpgradeStepItem

• UserPoolId string

• Username string

• VPCDerivedInfo object: Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
  • AvailabilityZones
    • items String
  • SecurityGroupIds
    • items String
  • SubnetIds
    • items String
  • VPCId

• VPCDerivedInfoStatus object: Status of the VPC options for the specified Elasticsearch domain.
  • Options required
    • AvailabilityZones
      • items String
    • SecurityGroupIds
      • items String
    • SubnetIds
      • items String
    • VPCId
  • Status required
    • CreationDate required
    • PendingDeletion
    • State required
    • UpdateDate required
    • UpdateVersion

• VPCOptions object: Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
  • SecurityGroupIds
    • items String
  • SubnetIds
    • items String

• ValueStringList array
  • items NonEmptyString

• VolumeType string (values: standard, gp2, io1): The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.

• ZoneAwarenessConfig object: Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.
  • AvailabilityZoneCount