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.

Classes

NameDescription
Class AccessPoliciesStatus

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

Class AdditionalLimit

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

InstanceRole 
.

Class AddTagsRequest

Container for the parameters to the 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.

Class AddTagsResponse

This is the response object from the AddTags operation.

Class AdvancedOptionsStatus

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.

Class BaseException

Elasticsearch exception

Class CreateElasticsearchDomainRequest

Container for the parameters to the CreateElasticsearchDomain operation. Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Class CreateElasticsearchDomainResponse

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

Class DeleteElasticsearchDomainRequest

Container for the parameters to the DeleteElasticsearchDomain operation. Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

Class DeleteElasticsearchDomainResponse

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.

Class DeleteElasticsearchServiceRoleRequest

Container for the parameters to the 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.

Class DeleteElasticsearchServiceRoleResponse

This is the response object from the DeleteElasticsearchServiceRole operation.

Class DescribeElasticsearchDomainConfigRequest

Container for the parameters to the 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.

Class DescribeElasticsearchDomainConfigResponse

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

Class DescribeElasticsearchDomainRequest

Container for the parameters to the DescribeElasticsearchDomain operation. Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Class DescribeElasticsearchDomainResponse

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

Class DescribeElasticsearchDomainsRequest

Container for the parameters to the DescribeElasticsearchDomains operation. Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Class DescribeElasticsearchDomainsResponse

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

Class DescribeElasticsearchInstanceTypeLimitsRequest

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

Class DescribeElasticsearchInstanceTypeLimitsResponse

Container for the parameters received from

DescribeElasticsearchInstanceTypeLimits
            
operation.

Class DisabledOperationException

Elasticsearch exception

Class DomainInfo

Class EBSOptions

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

Class EBSOptionsStatus

Status of the EBS options for the specified Elasticsearch domain.

Class ElasticsearchClusterConfig

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

Class ElasticsearchClusterConfigStatus

Specifies the configuration status for the specified Elasticsearch domain.

Class ElasticsearchDomainConfig

The configuration of an Elasticsearch domain.

Class ElasticsearchDomainStatus

The current status of an Elasticsearch domain.

Class ElasticsearchVersionStatus

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

Class EncryptionAtRestOptions

Specifies the Encryption At Rest Options.

Class EncryptionAtRestOptionsStatus

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

Class InstanceCountLimits

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

Class InstanceLimits

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

Class InternalException

Elasticsearch exception

Class InvalidTypeException

Elasticsearch exception

Class LimitExceededException

Elasticsearch exception

Class Limits

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

AdditionalLimits 

Class ListDomainNamesRequest

Container for the parameters to the ListDomainNames operation. Returns the name of all Elasticsearch domains owned by the current user's account.

Class ListDomainNamesResponse

The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.

Class ListElasticsearchInstanceTypesRequest

Container for the parameters to the ListElasticsearchInstanceTypes operation. List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Class ListElasticsearchInstanceTypesResponse

Container for the parameters returned by

ListElasticsearchInstanceTypes
            
operation.

Class ListElasticsearchVersionsRequest

Container for the parameters to the ListElasticsearchVersions operation. List all supported Elasticsearch versions

Class ListElasticsearchVersionsResponse

Container for the parameters for response received from

ListElasticsearchVersions
            
operation.

Class ListTagsRequest

Container for the parameters to the ListTags operation. Returns all tags for the given Elasticsearch domain.

Class ListTagsResponse

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

Class LogPublishingOption

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

Class LogPublishingOptionsStatus

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

Class OptionStatus

Provides the current status of the entity.

Class RemoveTagsRequest

Container for the parameters to the RemoveTags operation. Removes the specified set of tags from the specified Elasticsearch domain.

Class RemoveTagsResponse

This is the response object from the RemoveTags operation.

Class ResourceAlreadyExistsException

Elasticsearch exception

Class ResourceNotFoundException

Elasticsearch exception

Class SnapshotOptions

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

Class SnapshotOptionsStatus

Status of a daily automated snapshot.

Class StorageType

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

Class StorageTypeLimit

Limits that are applicable for given storage type.

Class Tag

Specifies a key value pair for a resource tag.

Class UpdateElasticsearchDomainConfigRequest

Container for the parameters to the UpdateElasticsearchDomainConfig operation. Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Class UpdateElasticsearchDomainConfigResponse

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

Class ValidationException

Elasticsearch exception

Class VPCDerivedInfo

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

Class VPCDerivedInfoStatus

Status of the VPC options for the specified Elasticsearch domain.

Class VPCOptions

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