ElasticsearchServiceClient Class

(QtAws::ElasticsearchService::ElasticsearchServiceClient)

The ElasticsearchServiceClient class provides access to the Amazon Elasticsearch Service service. More...

Header: #include <ElasticsearchServiceClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

ElasticsearchServiceClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
ElasticsearchServiceClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

AddTagsResponse *addTags(const AddTagsRequest &request)
CreateElasticsearchDomainResponse *createElasticsearchDomain(const CreateElasticsearchDomainRequest &request)
DeleteElasticsearchDomainResponse *deleteElasticsearchDomain(const DeleteElasticsearchDomainRequest &request)
DeleteElasticsearchServiceRoleResponse *deleteElasticsearchServiceRole()
DescribeElasticsearchDomainResponse *describeElasticsearchDomain(const DescribeElasticsearchDomainRequest &request)
DescribeElasticsearchDomainConfigResponse *describeElasticsearchDomainConfig(const DescribeElasticsearchDomainConfigRequest &request)
DescribeElasticsearchDomainsResponse *describeElasticsearchDomains(const DescribeElasticsearchDomainsRequest &request)
DescribeElasticsearchInstanceTypeLimitsResponse *describeElasticsearchInstanceTypeLimits(const DescribeElasticsearchInstanceTypeLimitsRequest &request)
DescribeReservedElasticsearchInstanceOfferingsResponse *describeReservedElasticsearchInstanceOfferings(const DescribeReservedElasticsearchInstanceOfferingsRequest &request)
DescribeReservedElasticsearchInstancesResponse *describeReservedElasticsearchInstances(const DescribeReservedElasticsearchInstancesRequest &request)
ListDomainNamesResponse *listDomainNames()
ListElasticsearchInstanceTypesResponse *listElasticsearchInstanceTypes(const ListElasticsearchInstanceTypesRequest &request)
ListElasticsearchVersionsResponse *listElasticsearchVersions(const ListElasticsearchVersionsRequest &request)
ListTagsResponse *listTags(const ListTagsRequest &request)
PurchaseReservedElasticsearchInstanceOfferingResponse *purchaseReservedElasticsearchInstanceOffering(const PurchaseReservedElasticsearchInstanceOfferingRequest &request)
RemoveTagsResponse *removeTags(const RemoveTagsRequest &request)
UpdateElasticsearchDomainConfigResponse *updateElasticsearchDomainConfig(const UpdateElasticsearchDomainConfigRequest &request)

Additional Inherited Members

Detailed Description

The ElasticsearchServiceClient class provides access to the Amazon Elasticsearch Service service.

<fullname>Amazon Elasticsearch Configuration Service</fullname>

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

domains>

The endpoint for configuration service requests is region-specific: es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions" target="_blank">Regions and

Member Function Documentation

ElasticsearchServiceClient::ElasticsearchServiceClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a ElasticsearchServiceClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

ElasticsearchServiceClient::ElasticsearchServiceClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads ElasticsearchServiceClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddTagsResponse *ElasticsearchServiceClient::addTags(const AddTagsRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an AddTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging" target="_blank"> Tagging Amazon Elasticsearch Service Domains for more

[slot] CreateElasticsearchDomainResponse *ElasticsearchServiceClient::createElasticsearchDomain(const CreateElasticsearchDomainRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an CreateElasticsearchDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new Elasticsearch domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains" target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer

[slot] DeleteElasticsearchDomainResponse *ElasticsearchServiceClient::deleteElasticsearchDomain(const DeleteElasticsearchDomainRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an DeleteElasticsearchDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteElasticsearchServiceRoleResponse *ElasticsearchServiceClient::deleteElasticsearchServiceRole()

Sends a DeleteElasticsearchServiceRole request to the ElasticsearchServiceClient service, and returns a pointer to an DeleteElasticsearchServiceRoleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr" target="_blank">Deleting Elasticsearch Service Role</a> in <i>VPC Endpoints for Amazon Elasticsearch Service

[slot] DescribeElasticsearchDomainResponse *ElasticsearchServiceClient::describeElasticsearchDomain(const DescribeElasticsearchDomainRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an DescribeElasticsearchDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeElasticsearchDomainConfigResponse *ElasticsearchServiceClient::describeElasticsearchDomainConfig(const DescribeElasticsearchDomainConfigRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an DescribeElasticsearchDomainConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeElasticsearchDomainsResponse *ElasticsearchServiceClient::describeElasticsearchDomains(const DescribeElasticsearchDomainsRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an DescribeElasticsearchDomainsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeElasticsearchInstanceTypeLimitsResponse *ElasticsearchServiceClient::describeElasticsearchInstanceTypeLimits(const DescribeElasticsearchInstanceTypeLimitsRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an DescribeElasticsearchInstanceTypeLimitsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeReservedElasticsearchInstanceOfferingsResponse *ElasticsearchServiceClient::describeReservedElasticsearchInstanceOfferings(const DescribeReservedElasticsearchInstanceOfferingsRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an DescribeReservedElasticsearchInstanceOfferingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists available reserved Elasticsearch instance

[slot] DescribeReservedElasticsearchInstancesResponse *ElasticsearchServiceClient::describeReservedElasticsearchInstances(const DescribeReservedElasticsearchInstancesRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an DescribeReservedElasticsearchInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about reserved Elasticsearch instances for this

[slot] ListDomainNamesResponse *ElasticsearchServiceClient::listDomainNames()

Sends a ListDomainNames request to the ElasticsearchServiceClient service, and returns a pointer to an ListDomainNamesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListElasticsearchInstanceTypesResponse *ElasticsearchServiceClient::listElasticsearchInstanceTypes(const ListElasticsearchInstanceTypesRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an ListElasticsearchInstanceTypesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

List all Elasticsearch instance types that are supported for given

[slot] ListElasticsearchVersionsResponse *ElasticsearchServiceClient::listElasticsearchVersions(const ListElasticsearchVersionsRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an ListElasticsearchVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

List all supported Elasticsearch

[slot] ListTagsResponse *ElasticsearchServiceClient::listTags(const ListTagsRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an ListTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns all tags for the given Elasticsearch

[slot] PurchaseReservedElasticsearchInstanceOfferingResponse *ElasticsearchServiceClient::purchaseReservedElasticsearchInstanceOffering(const PurchaseReservedElasticsearchInstanceOfferingRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an PurchaseReservedElasticsearchInstanceOfferingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows you to purchase reserved Elasticsearch

[slot] RemoveTagsResponse *ElasticsearchServiceClient::removeTags(const RemoveTagsRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an RemoveTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the specified set of tags from the specified Elasticsearch

[slot] UpdateElasticsearchDomainConfigResponse *ElasticsearchServiceClient::updateElasticsearchDomainConfig(const UpdateElasticsearchDomainConfigRequest &request)

Sends request to the ElasticsearchServiceClient service, and returns a pointer to an UpdateElasticsearchDomainConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.