

********************
ElasticsearchService
********************



======
Client
======



.. py:class:: ElasticsearchService.Client

  A low-level client representing Amazon Elasticsearch Service
   

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

   

  For sample code that uses the Configuration API, see the `Amazon Elasticsearch Service Developer Guide <https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html>`__. The guide also contains `sample code for sending signed HTTP requests to the Elasticsearch APIs <https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html>`__.

   

  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 <http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions>`__.

  ::

    
    import boto3
    
    client = boto3.client('es')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  es/client/accept_inbound_cross_cluster_search_connection
  es/client/add_tags
  es/client/associate_package
  es/client/authorize_vpc_endpoint_access
  es/client/can_paginate
  es/client/cancel_domain_config_change
  es/client/cancel_elasticsearch_service_software_update
  es/client/close
  es/client/create_elasticsearch_domain
  es/client/create_outbound_cross_cluster_search_connection
  es/client/create_package
  es/client/create_vpc_endpoint
  es/client/delete_elasticsearch_domain
  es/client/delete_elasticsearch_service_role
  es/client/delete_inbound_cross_cluster_search_connection
  es/client/delete_outbound_cross_cluster_search_connection
  es/client/delete_package
  es/client/delete_vpc_endpoint
  es/client/describe_domain_auto_tunes
  es/client/describe_domain_change_progress
  es/client/describe_elasticsearch_domain
  es/client/describe_elasticsearch_domain_config
  es/client/describe_elasticsearch_domains
  es/client/describe_elasticsearch_instance_type_limits
  es/client/describe_inbound_cross_cluster_search_connections
  es/client/describe_outbound_cross_cluster_search_connections
  es/client/describe_packages
  es/client/describe_reserved_elasticsearch_instance_offerings
  es/client/describe_reserved_elasticsearch_instances
  es/client/describe_vpc_endpoints
  es/client/dissociate_package
  es/client/get_compatible_elasticsearch_versions
  es/client/get_package_version_history
  es/client/get_paginator
  es/client/get_upgrade_history
  es/client/get_upgrade_status
  es/client/get_waiter
  es/client/list_domain_names
  es/client/list_domains_for_package
  es/client/list_elasticsearch_instance_types
  es/client/list_elasticsearch_versions
  es/client/list_packages_for_domain
  es/client/list_tags
  es/client/list_vpc_endpoint_access
  es/client/list_vpc_endpoints
  es/client/list_vpc_endpoints_for_domain
  es/client/purchase_reserved_elasticsearch_instance_offering
  es/client/reject_inbound_cross_cluster_search_connection
  es/client/remove_tags
  es/client/revoke_vpc_endpoint_access
  es/client/start_elasticsearch_service_software_update
  es/client/update_elasticsearch_domain_config
  es/client/update_package
  es/client/update_vpc_endpoint
  es/client/upgrade_elasticsearch_domain


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  es/paginator/DescribeReservedElasticsearchInstanceOfferings
  es/paginator/DescribeReservedElasticsearchInstances
  es/paginator/GetUpgradeHistory
  es/paginator/ListElasticsearchInstanceTypes
  es/paginator/ListElasticsearchVersions
