Class AWSElasticsearchClient

  • All Implemented Interfaces:
    AWSElasticsearch
    Direct Known Subclasses:
    AWSElasticsearchAsyncClient

    public class AWSElasticsearchClient
    extends AmazonWebServiceClient
    implements AWSElasticsearch
    Client for accessing Amazon Elasticsearch Service. All service calls made using this client are blocking, and will not return until the service call completes.

    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.

    • Field Detail

      • configFactory

        protected static final ClientConfigurationFactory configFactory
        Client configuration factory providing ClientConfigurations tailored to this client
    • Constructor Detail

      • AWSElasticsearchClient

        public AWSElasticsearchClient()
        Constructs a new client to invoke service methods on Amazon Elasticsearch Service. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain
      • AWSElasticsearchClient

        public AWSElasticsearchClient​(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon Elasticsearch Service. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain
      • AWSElasticsearchClient

        public AWSElasticsearchClient​(AWSCredentials awsCredentials)
        Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      • AWSElasticsearchClient

        public AWSElasticsearchClient​(AWSCredentials awsCredentials,
                                      ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).
      • AWSElasticsearchClient

        public AWSElasticsearchClient​(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      • AWSElasticsearchClient

        public AWSElasticsearchClient​(AWSCredentialsProvider awsCredentialsProvider,
                                      ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).
      • AWSElasticsearchClient

        public AWSElasticsearchClient​(AWSCredentialsProvider awsCredentialsProvider,
                                      ClientConfiguration clientConfiguration,
                                      RequestMetricCollector requestMetricCollector)
        Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials provider, client configuration options, and request metric collector.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).
        requestMetricCollector - optional request metric collector
    • Method Detail

      • addTags

        public AddTagsResult addTags​(AddTagsRequest 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.

        Specified by:
        addTags in interface AWSElasticsearch
        Parameters:
        addTagsRequest - Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.
        Returns:
        Result of the AddTags operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
      • createElasticsearchDomain

        public CreateElasticsearchDomainResult createElasticsearchDomain​(CreateElasticsearchDomainRequest createElasticsearchDomainRequest)

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

        Specified by:
        createElasticsearchDomain in interface AWSElasticsearch
        Parameters:
        createElasticsearchDomainRequest -
        Returns:
        Result of the CreateElasticsearchDomain operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
        InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
        LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
        ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
      • deleteElasticsearchDomain

        public DeleteElasticsearchDomainResult deleteElasticsearchDomain​(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest)

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

        Specified by:
        deleteElasticsearchDomain in interface AWSElasticsearch
        Parameters:
        deleteElasticsearchDomainRequest - Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.
        Returns:
        Result of the DeleteElasticsearchDomain operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
        ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
      • describeElasticsearchDomain

        public DescribeElasticsearchDomainResult describeElasticsearchDomain​(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest)

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

        Specified by:
        describeElasticsearchDomain in interface AWSElasticsearch
        Parameters:
        describeElasticsearchDomainRequest - Container for the parameters to the DescribeElasticsearchDomain operation.
        Returns:
        Result of the DescribeElasticsearchDomain operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
        ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
      • describeElasticsearchDomainConfig

        public DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig​(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest)

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

        Specified by:
        describeElasticsearchDomainConfig in interface AWSElasticsearch
        Parameters:
        describeElasticsearchDomainConfigRequest - Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.
        Returns:
        Result of the DescribeElasticsearchDomainConfig operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
        ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
      • describeElasticsearchDomains

        public DescribeElasticsearchDomainsResult describeElasticsearchDomains​(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest)

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

        Specified by:
        describeElasticsearchDomains in interface AWSElasticsearch
        Parameters:
        describeElasticsearchDomainsRequest - Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.
        Returns:
        Result of the DescribeElasticsearchDomains operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
      • listDomainNames

        public ListDomainNamesResult listDomainNames​(ListDomainNamesRequest listDomainNamesRequest)

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

        Specified by:
        listDomainNames in interface AWSElasticsearch
        Parameters:
        listDomainNamesRequest -
        Returns:
        Result of the ListDomainNames operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
      • listTags

        public ListTagsResult listTags​(ListTagsRequest listTagsRequest)

        Returns all tags for the given Elasticsearch domain.

        Specified by:
        listTags in interface AWSElasticsearch
        Parameters:
        listTagsRequest - 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.
        Returns:
        Result of the ListTags operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
      • removeTags

        public RemoveTagsResult removeTags​(RemoveTagsRequest removeTagsRequest)

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

        Specified by:
        removeTags in interface AWSElasticsearch
        Parameters:
        removeTagsRequest - Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.
        Returns:
        Result of the RemoveTags operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
      • updateElasticsearchDomainConfig

        public UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig​(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest)

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

        Specified by:
        updateElasticsearchDomainConfig in interface AWSElasticsearch
        Parameters:
        updateElasticsearchDomainConfigRequest - Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.
        Returns:
        Result of the UpdateElasticsearchDomainConfig operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
        InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
        LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
        ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
        ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AWSElasticsearch
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.