AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing Elasticsearch 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.

Inheritance Hierarchy

Amazon.Elasticsearch.IAmazonElasticsearch

Namespace: Amazon.Elasticsearch
Assembly: AWSSDK.Elasticsearch.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonElasticsearch
         IAmazonService, IDisposable

The IAmazonElasticsearch type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddTags(AddTagsRequest)

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.

Public Method AddTagsAsync(AddTagsRequest, CancellationToken)

Initiates the asynchronous execution of the AddTags operation.

Public Method CreateElasticsearchDomain(CreateElasticsearchDomainRequest)

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

Public Method CreateElasticsearchDomainAsync(CreateElasticsearchDomainRequest, CancellationToken)

Initiates the asynchronous execution of the CreateElasticsearchDomain operation.

Public Method DeleteElasticsearchDomain(DeleteElasticsearchDomainRequest)

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

Public Method DeleteElasticsearchDomainAsync(DeleteElasticsearchDomainRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteElasticsearchDomain operation.

Public Method DescribeElasticsearchDomain(DescribeElasticsearchDomainRequest)

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

Public Method DescribeElasticsearchDomainAsync(DescribeElasticsearchDomainRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeElasticsearchDomain operation.

Public Method DescribeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest)

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

Public Method DescribeElasticsearchDomainConfigAsync(DescribeElasticsearchDomainConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeElasticsearchDomainConfig operation.

Public Method DescribeElasticsearchDomains(DescribeElasticsearchDomainsRequest)

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

Public Method DescribeElasticsearchDomainsAsync(DescribeElasticsearchDomainsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeElasticsearchDomains operation.

Public Method DescribeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest)

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

Public Method DescribeElasticsearchInstanceTypeLimitsAsync(DescribeElasticsearchInstanceTypeLimitsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeElasticsearchInstanceTypeLimits operation.

Public Method ListDomainNames(ListDomainNamesRequest)

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

Public Method ListDomainNamesAsync(ListDomainNamesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDomainNames operation.

Public Method ListElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest)

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Public Method ListElasticsearchInstanceTypesAsync(ListElasticsearchInstanceTypesRequest, CancellationToken)

Initiates the asynchronous execution of the ListElasticsearchInstanceTypes operation.

Public Method ListElasticsearchVersions(ListElasticsearchVersionsRequest)

List all supported Elasticsearch versions

Public Method ListElasticsearchVersionsAsync(ListElasticsearchVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListElasticsearchVersions operation.

Public Method ListTags(ListTagsRequest)

Returns all tags for the given Elasticsearch domain.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTags operation.

Public Method RemoveTags(RemoveTagsRequest)

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

Public Method RemoveTagsAsync(RemoveTagsRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTags operation.

Public Method UpdateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest)

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

Public Method UpdateElasticsearchDomainConfigAsync(UpdateElasticsearchDomainConfigRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateElasticsearchDomainConfig operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms