AWSSDK.ES.jl

AWSSDK.ES

Amazon Elasticsearch Configuration Service

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

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.

This document is generated from apis/es-2015-01-01.normal.json. See JuliaCloud/AWSCore.jl.

AWSSDK.ES.add_tagsFunction.
using AWSSDK.ES.add_tags
add_tags([::AWSConfig], arguments::Dict)
add_tags([::AWSConfig]; ARN=, TagList=)

using AWSCore.Services.es
es([::AWSConfig], "POST", "/2015-01-01/tags", arguments::Dict)
es([::AWSConfig], "POST", "/2015-01-01/tags", ARN=, TagList=)

AddTags Operation

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.

Arguments

ARN = ::StringRequired

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

TagList = [[ ... ], ...]Required

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

 TagList = [[
        "Key" => <required> ::String,
        "Value" => <required> ::String
    ], ...]

Exceptions

BaseException, LimitExceededException, ValidationException or InternalException.

See also: AWS API Documentation

using AWSSDK.ES.create_elasticsearch_domain
create_elasticsearch_domain([::AWSConfig], arguments::Dict)
create_elasticsearch_domain([::AWSConfig]; DomainName=, <keyword arguments>)

using AWSCore.Services.es
es([::AWSConfig], "POST", "/2015-01-01/es/domain", arguments::Dict)
es([::AWSConfig], "POST", "/2015-01-01/es/domain", DomainName=, <keyword arguments>)

CreateElasticsearchDomain Operation

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

Arguments

DomainName = ::StringRequired

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 letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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.

ElasticsearchClusterConfig = [ ... ]

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

 ElasticsearchClusterConfig = [
        "InstanceType" =>  "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", "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" or "i3.16xlarge.elasticsearch",
        "InstanceCount" =>  ::Int,
        "DedicatedMasterEnabled" =>  ::Bool,
        "ZoneAwarenessEnabled" =>  ::Bool,
        "DedicatedMasterType" =>  "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", "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" or "i3.16xlarge.elasticsearch",
        "DedicatedMasterCount" =>  ::Int
    ]

EBSOptions = [ ... ]

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

 EBSOptions = [
        "EBSEnabled" =>  ::Bool,
        "VolumeType" =>  "standard", "gp2" or "io1",
        "VolumeSize" =>  ::Int,
        "Iops" =>  ::Int
    ]

AccessPolicies = ::String

IAM access policy as a JSON-formatted string.

SnapshotOptions = ["AutomatedSnapshotStartHour" => ::Int]

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

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

 VPCOptions = [
        "SubnetIds" =>  [::String, ...],
        "SecurityGroupIds" =>  [::String, ...]
    ]

AdvancedOptions = ::Dict{String,String}

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.

LogPublishingOptions = ::Dict{String,String}

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

Returns

CreateElasticsearchDomainResponse

Exceptions

BaseException, DisabledOperationException, InternalException, InvalidTypeException, LimitExceededException, ResourceAlreadyExistsException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.delete_elasticsearch_domain
delete_elasticsearch_domain([::AWSConfig], arguments::Dict)
delete_elasticsearch_domain([::AWSConfig]; DomainName=)

using AWSCore.Services.es
es([::AWSConfig], "DELETE", "/2015-01-01/es/domain/{DomainName}", arguments::Dict)
es([::AWSConfig], "DELETE", "/2015-01-01/es/domain/{DomainName}", DomainName=)

DeleteElasticsearchDomain Operation

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

Arguments

DomainName = ::StringRequired

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

Returns

DeleteElasticsearchDomainResponse

Exceptions

BaseException, InternalException, ResourceNotFoundException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.delete_elasticsearch_service_role
delete_elasticsearch_service_role([::AWSConfig])


using AWSCore.Services.es
es([::AWSConfig], "DELETE", "/2015-01-01/es/role",)

DeleteElasticsearchServiceRole Operation

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.

Exceptions

BaseException, InternalException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.describe_elasticsearch_domain
describe_elasticsearch_domain([::AWSConfig], arguments::Dict)
describe_elasticsearch_domain([::AWSConfig]; DomainName=)

using AWSCore.Services.es
es([::AWSConfig], "GET", "/2015-01-01/es/domain/{DomainName}", arguments::Dict)
es([::AWSConfig], "GET", "/2015-01-01/es/domain/{DomainName}", DomainName=)

DescribeElasticsearchDomain Operation

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

Arguments

DomainName = ::StringRequired

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

Returns

DescribeElasticsearchDomainResponse

Exceptions

BaseException, InternalException, ResourceNotFoundException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.describe_elasticsearch_domain_config
describe_elasticsearch_domain_config([::AWSConfig], arguments::Dict)
describe_elasticsearch_domain_config([::AWSConfig]; DomainName=)

using AWSCore.Services.es
es([::AWSConfig], "GET", "/2015-01-01/es/domain/{DomainName}/config", arguments::Dict)
es([::AWSConfig], "GET", "/2015-01-01/es/domain/{DomainName}/config", DomainName=)

DescribeElasticsearchDomainConfig Operation

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

Arguments

DomainName = ::StringRequired

The Elasticsearch domain that you want to get information about.

Returns

DescribeElasticsearchDomainConfigResponse

Exceptions

BaseException, InternalException, ResourceNotFoundException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.describe_elasticsearch_domains
describe_elasticsearch_domains([::AWSConfig], arguments::Dict)
describe_elasticsearch_domains([::AWSConfig]; DomainNames=)

using AWSCore.Services.es
es([::AWSConfig], "POST", "/2015-01-01/es/domain-info", arguments::Dict)
es([::AWSConfig], "POST", "/2015-01-01/es/domain-info", DomainNames=)

DescribeElasticsearchDomains Operation

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

Arguments

DomainNames = [::String, ...]Required

The Elasticsearch domains for which you want information.

Returns

DescribeElasticsearchDomainsResponse

Exceptions

BaseException, InternalException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.describe_elasticsearch_instance_type_limits
describe_elasticsearch_instance_type_limits([::AWSConfig], arguments::Dict)
describe_elasticsearch_instance_type_limits([::AWSConfig]; InstanceType=, ElasticsearchVersion=, <keyword arguments>)

using AWSCore.Services.es
es([::AWSConfig], "GET", "/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}", arguments::Dict)
es([::AWSConfig], "GET", "/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}", InstanceType=, ElasticsearchVersion=, <keyword arguments>)

DescribeElasticsearchInstanceTypeLimits Operation

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the [DomainName](@ref) to know what Limits are supported for modifying.

Arguments

domainName = ::String

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](@ref) for existing domain.

InstanceType = "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", "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" or "i3.16xlarge.elasticsearch"Required

The instance type for an Elasticsearch cluster for which Elasticsearch [Limits](@ref) are needed.

ElasticsearchVersion = ::StringRequired

Version of Elasticsearch for which [Limits](@ref) are needed.

Returns

DescribeElasticsearchInstanceTypeLimitsResponse

Exceptions

BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.list_domain_names
list_domain_names([::AWSConfig])


using AWSCore.Services.es
es([::AWSConfig], "GET", "/2015-01-01/domain",)

ListDomainNames Operation

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

Returns

ListDomainNamesResponse

Exceptions

BaseException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.list_elasticsearch_instance_types
list_elasticsearch_instance_types([::AWSConfig], arguments::Dict)
list_elasticsearch_instance_types([::AWSConfig]; ElasticsearchVersion=, <keyword arguments>)

using AWSCore.Services.es
es([::AWSConfig], "GET", "/2015-01-01/es/instanceTypes/{ElasticsearchVersion}", arguments::Dict)
es([::AWSConfig], "GET", "/2015-01-01/es/instanceTypes/{ElasticsearchVersion}", ElasticsearchVersion=, <keyword arguments>)

ListElasticsearchInstanceTypes Operation

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Arguments

ElasticsearchVersion = ::StringRequired

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

domainName = ::String

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.

maxResults = ::Int

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

nextToken = ::String

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

Returns

ListElasticsearchInstanceTypesResponse

Exceptions

BaseException, InternalException, ResourceNotFoundException or ValidationException.

See also: AWS API Documentation

using AWSSDK.ES.list_elasticsearch_versions
list_elasticsearch_versions([::AWSConfig], arguments::Dict)
list_elasticsearch_versions([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.es
es([::AWSConfig], "GET", "/2015-01-01/es/versions", arguments::Dict)
es([::AWSConfig], "GET", "/2015-01-01/es/versions", <keyword arguments>)

ListElasticsearchVersions Operation

List all supported Elasticsearch versions

Arguments

maxResults = ::Int

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

nextToken = ::String

Returns

ListElasticsearchVersionsResponse

Exceptions

BaseException, InternalException, ResourceNotFoundException or ValidationException.

See also: AWS API Documentation

AWSSDK.ES.list_tagsFunction.
using AWSSDK.ES.list_tags
list_tags([::AWSConfig], arguments::Dict)
list_tags([::AWSConfig]; arn=)

using AWSCore.Services.es
es([::AWSConfig], "GET", "/2015-01-01/tags/", arguments::Dict)
es([::AWSConfig], "GET", "/2015-01-01/tags/", arn=)

ListTags Operation

Returns all tags for the given Elasticsearch domain.

Arguments

arn = ::StringRequired

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

Returns

ListTagsResponse

Exceptions

BaseException, ResourceNotFoundException, ValidationException or InternalException.

See also: AWS API Documentation

AWSSDK.ES.remove_tagsFunction.
using AWSSDK.ES.remove_tags
remove_tags([::AWSConfig], arguments::Dict)
remove_tags([::AWSConfig]; ARN=, TagKeys=)

using AWSCore.Services.es
es([::AWSConfig], "POST", "/2015-01-01/tags-removal", arguments::Dict)
es([::AWSConfig], "POST", "/2015-01-01/tags-removal", ARN=, TagKeys=)

RemoveTags Operation

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

Arguments

ARN = ::StringRequired

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

TagKeys = [::String, ...]Required

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

Exceptions

BaseException, ValidationException or InternalException.

See also: AWS API Documentation

using AWSSDK.ES.update_elasticsearch_domain_config
update_elasticsearch_domain_config([::AWSConfig], arguments::Dict)
update_elasticsearch_domain_config([::AWSConfig]; DomainName=, <keyword arguments>)

using AWSCore.Services.es
es([::AWSConfig], "POST", "/2015-01-01/es/domain/{DomainName}/config", arguments::Dict)
es([::AWSConfig], "POST", "/2015-01-01/es/domain/{DomainName}/config", DomainName=, <keyword arguments>)

UpdateElasticsearchDomainConfig Operation

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

Arguments

DomainName = ::StringRequired

The name of the Elasticsearch domain that you are updating.

ElasticsearchClusterConfig = [ ... ]

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

 ElasticsearchClusterConfig = [
        "InstanceType" =>  "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", "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" or "i3.16xlarge.elasticsearch",
        "InstanceCount" =>  ::Int,
        "DedicatedMasterEnabled" =>  ::Bool,
        "ZoneAwarenessEnabled" =>  ::Bool,
        "DedicatedMasterType" =>  "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", "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" or "i3.16xlarge.elasticsearch",
        "DedicatedMasterCount" =>  ::Int
    ]

EBSOptions = [ ... ]

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

 EBSOptions = [
        "EBSEnabled" =>  ::Bool,
        "VolumeType" =>  "standard", "gp2" or "io1",
        "VolumeSize" =>  ::Int,
        "Iops" =>  ::Int
    ]

SnapshotOptions = ["AutomatedSnapshotStartHour" => ::Int]

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

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

 VPCOptions = [
        "SubnetIds" =>  [::String, ...],
        "SecurityGroupIds" =>  [::String, ...]
    ]

AdvancedOptions = ::Dict{String,String}

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.

AccessPolicies = ::String

IAM access policy as a JSON-formatted string.

LogPublishingOptions = ::Dict{String,String}

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

Returns

UpdateElasticsearchDomainConfigResponse

Exceptions

BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException or ValidationException.

See also: AWS API Documentation