Class: Aws::ElasticsearchService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ElasticsearchService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb
Overview
An API client for ElasticsearchService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ElasticsearchService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::AcceptInboundCrossClusterSearchConnectionResponse
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
-
#add_tags(params = {}) ⇒ Struct
Attaches tags to an existing Elasticsearch domain.
-
#associate_package(params = {}) ⇒ Types::AssociatePackageResponse
Associates a package with an Amazon ES domain.
-
#authorize_vpc_endpoint_access(params = {}) ⇒ Types::AuthorizeVpcEndpointAccessResponse
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
-
#cancel_domain_config_change(params = {}) ⇒ Types::CancelDomainConfigChangeResponse
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
-
#cancel_elasticsearch_service_software_update(params = {}) ⇒ Types::CancelElasticsearchServiceSoftwareUpdateResponse
Cancels a scheduled service software update for an Amazon ES domain.
-
#create_elasticsearch_domain(params = {}) ⇒ Types::CreateElasticsearchDomainResponse
Creates a new Elasticsearch domain.
-
#create_outbound_cross_cluster_search_connection(params = {}) ⇒ Types::CreateOutboundCrossClusterSearchConnectionResponse
Creates a new cross-cluster search connection from a source domain to a destination domain.
-
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Create a package for use with Amazon ES domains.
-
#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResponse
Creates an Amazon OpenSearch Service-managed VPC endpoint.
-
#delete_elasticsearch_domain(params = {}) ⇒ Types::DeleteElasticsearchDomainResponse
Permanently deletes the specified Elasticsearch domain and all of its data.
-
#delete_elasticsearch_service_role(params = {}) ⇒ Struct
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
-
#delete_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::DeleteInboundCrossClusterSearchConnectionResponse
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
-
#delete_outbound_cross_cluster_search_connection(params = {}) ⇒ Types::DeleteOutboundCrossClusterSearchConnectionResponse
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
-
#delete_package(params = {}) ⇒ Types::DeletePackageResponse
Delete the package.
-
#delete_vpc_endpoint(params = {}) ⇒ Types::DeleteVpcEndpointResponse
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
-
#describe_domain_auto_tunes(params = {}) ⇒ Types::DescribeDomainAutoTunesResponse
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
-
#describe_domain_change_progress(params = {}) ⇒ Types::DescribeDomainChangeProgressResponse
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
-
#describe_elasticsearch_domain(params = {}) ⇒ Types::DescribeElasticsearchDomainResponse
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
-
#describe_elasticsearch_domain_config(params = {}) ⇒ Types::DescribeElasticsearchDomainConfigResponse
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
-
#describe_elasticsearch_domains(params = {}) ⇒ Types::DescribeElasticsearchDomainsResponse
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
-
#describe_elasticsearch_instance_type_limits(params = {}) ⇒ Types::DescribeElasticsearchInstanceTypeLimitsResponse
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
-
#describe_inbound_cross_cluster_search_connections(params = {}) ⇒ Types::DescribeInboundCrossClusterSearchConnectionsResponse
Lists all the inbound cross-cluster search connections for a destination domain.
-
#describe_outbound_cross_cluster_search_connections(params = {}) ⇒ Types::DescribeOutboundCrossClusterSearchConnectionsResponse
Lists all the outbound cross-cluster search connections for a source domain.
-
#describe_packages(params = {}) ⇒ Types::DescribePackagesResponse
Describes all packages available to Amazon ES.
-
#describe_reserved_elasticsearch_instance_offerings(params = {}) ⇒ Types::DescribeReservedElasticsearchInstanceOfferingsResponse
Lists available reserved Elasticsearch instance offerings.
-
#describe_reserved_elasticsearch_instances(params = {}) ⇒ Types::DescribeReservedElasticsearchInstancesResponse
Returns information about reserved Elasticsearch instances for this account.
-
#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResponse
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
-
#dissociate_package(params = {}) ⇒ Types::DissociatePackageResponse
Dissociates a package from the Amazon ES domain.
-
#get_compatible_elasticsearch_versions(params = {}) ⇒ Types::GetCompatibleElasticsearchVersionsResponse
Returns a list of upgrade compatible Elastisearch versions.
-
#get_package_version_history(params = {}) ⇒ Types::GetPackageVersionHistoryResponse
Returns a list of versions of the package, along with their creation time and commit message.
-
#get_upgrade_history(params = {}) ⇒ Types::GetUpgradeHistoryResponse
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
-
#get_upgrade_status(params = {}) ⇒ Types::GetUpgradeStatusResponse
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
-
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Returns the name of all Elasticsearch domains owned by the current user's account.
-
#list_domains_for_package(params = {}) ⇒ Types::ListDomainsForPackageResponse
Lists all Amazon ES domains associated with the package.
-
#list_elasticsearch_instance_types(params = {}) ⇒ Types::ListElasticsearchInstanceTypesResponse
List all Elasticsearch instance types that are supported for given ElasticsearchVersion.
-
#list_elasticsearch_versions(params = {}) ⇒ Types::ListElasticsearchVersionsResponse
List all supported Elasticsearch versions.
-
#list_packages_for_domain(params = {}) ⇒ Types::ListPackagesForDomainResponse
Lists all packages associated with the Amazon ES domain.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Returns all tags for the given Elasticsearch domain.
-
#list_vpc_endpoint_access(params = {}) ⇒ Types::ListVpcEndpointAccessResponse
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
-
#list_vpc_endpoints(params = {}) ⇒ Types::ListVpcEndpointsResponse
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
-
#list_vpc_endpoints_for_domain(params = {}) ⇒ Types::ListVpcEndpointsForDomainResponse
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
-
#purchase_reserved_elasticsearch_instance_offering(params = {}) ⇒ Types::PurchaseReservedElasticsearchInstanceOfferingResponse
Allows you to purchase reserved Elasticsearch instances.
-
#reject_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::RejectInboundCrossClusterSearchConnectionResponse
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
-
#remove_tags(params = {}) ⇒ Struct
Removes the specified set of tags from the specified Elasticsearch domain.
-
#revoke_vpc_endpoint_access(params = {}) ⇒ Struct
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
-
#start_elasticsearch_service_software_update(params = {}) ⇒ Types::StartElasticsearchServiceSoftwareUpdateResponse
Schedules a service software update for an Amazon ES domain.
-
#update_elasticsearch_domain_config(params = {}) ⇒ Types::UpdateElasticsearchDomainConfigResponse
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
-
#update_package(params = {}) ⇒ Types::UpdatePackageResponse
Updates a package for use with Amazon ES domains.
-
#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
-
#upgrade_elasticsearch_domain(params = {}) ⇒ Types::UpgradeElasticsearchDomainResponse
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#accept_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::AcceptInboundCrossClusterSearchConnectionResponse
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
446 447 448 449 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 446 def accept_inbound_cross_cluster_search_connection(params = {}, = {}) req = build_request(:accept_inbound_cross_cluster_search_connection, params) req.send_request() end |
#add_tags(params = {}) ⇒ Struct
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.
482 483 484 485 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 482 def (params = {}, = {}) req = build_request(:add_tags, params) req.send_request() end |
#associate_package(params = {}) ⇒ Types::AssociatePackageResponse
Associates a package with an Amazon ES domain.
522 523 524 525 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 522 def associate_package(params = {}, = {}) req = build_request(:associate_package, params) req.send_request() end |
#authorize_vpc_endpoint_access(params = {}) ⇒ Types::AuthorizeVpcEndpointAccessResponse
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
554 555 556 557 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 554 def (params = {}, = {}) req = build_request(:authorize_vpc_endpoint_access, params) req.send_request() end |
#cancel_domain_config_change(params = {}) ⇒ Types::CancelDomainConfigChangeResponse
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
594 595 596 597 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 594 def cancel_domain_config_change(params = {}, = {}) req = build_request(:cancel_domain_config_change, params) req.send_request() end |
#cancel_elasticsearch_service_software_update(params = {}) ⇒ Types::CancelElasticsearchServiceSoftwareUpdateResponse
Cancels a scheduled service software update for an Amazon ES domain.
You can only perform this operation before the AutomatedUpdateDate
and when the UpdateStatus
is in the PENDING_UPDATE
state.
630 631 632 633 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 630 def cancel_elasticsearch_service_software_update(params = {}, = {}) req = build_request(:cancel_elasticsearch_service_software_update, params) req.send_request() end |
#create_elasticsearch_domain(params = {}) ⇒ Types::CreateElasticsearchDomainResponse
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
929 930 931 932 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 929 def create_elasticsearch_domain(params = {}, = {}) req = build_request(:create_elasticsearch_domain, params) req.send_request() end |
#create_outbound_cross_cluster_search_connection(params = {}) ⇒ Types::CreateOutboundCrossClusterSearchConnectionResponse
Creates a new cross-cluster search connection from a source domain to a destination domain.
987 988 989 990 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 987 def create_outbound_cross_cluster_search_connection(params = {}, = {}) req = build_request(:create_outbound_cross_cluster_search_connection, params) req.send_request() end |
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Create a package for use with Amazon ES domains.
1037 1038 1039 1040 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1037 def create_package(params = {}, = {}) req = build_request(:create_package, params) req.send_request() end |
#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResponse
Creates an Amazon OpenSearch Service-managed VPC endpoint.
1086 1087 1088 1089 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1086 def create_vpc_endpoint(params = {}, = {}) req = build_request(:create_vpc_endpoint, params) req.send_request() end |
#delete_elasticsearch_domain(params = {}) ⇒ Types::DeleteElasticsearchDomainResponse
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1198 def delete_elasticsearch_domain(params = {}, = {}) req = build_request(:delete_elasticsearch_domain, params) req.send_request() end |
#delete_elasticsearch_service_role(params = {}) ⇒ Struct
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.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1218 def delete_elasticsearch_service_role(params = {}, = {}) req = build_request(:delete_elasticsearch_service_role, params) req.send_request() end |
#delete_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::DeleteInboundCrossClusterSearchConnectionResponse
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1253 def delete_inbound_cross_cluster_search_connection(params = {}, = {}) req = build_request(:delete_inbound_cross_cluster_search_connection, params) req.send_request() end |
#delete_outbound_cross_cluster_search_connection(params = {}) ⇒ Types::DeleteOutboundCrossClusterSearchConnectionResponse
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1289 def delete_outbound_cross_cluster_search_connection(params = {}, = {}) req = build_request(:delete_outbound_cross_cluster_search_connection, params) req.send_request() end |
#delete_package(params = {}) ⇒ Types::DeletePackageResponse
Delete the package.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1325 def delete_package(params = {}, = {}) req = build_request(:delete_package, params) req.send_request() end |
#delete_vpc_endpoint(params = {}) ⇒ Types::DeleteVpcEndpointResponse
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1354 def delete_vpc_endpoint(params = {}, = {}) req = build_request(:delete_vpc_endpoint, params) req.send_request() end |
#describe_domain_auto_tunes(params = {}) ⇒ Types::DescribeDomainAutoTunesResponse
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1401 def describe_domain_auto_tunes(params = {}, = {}) req = build_request(:describe_domain_auto_tunes, params) req.send_request() end |
#describe_domain_change_progress(params = {}) ⇒ Types::DescribeDomainChangeProgressResponse
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
1449 1450 1451 1452 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1449 def describe_domain_change_progress(params = {}, = {}) req = build_request(:describe_domain_change_progress, params) req.send_request() end |
#describe_elasticsearch_domain(params = {}) ⇒ Types::DescribeElasticsearchDomainResponse
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
1561 1562 1563 1564 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1561 def describe_elasticsearch_domain(params = {}, = {}) req = build_request(:describe_elasticsearch_domain, params) req.send_request() end |
#describe_elasticsearch_domain_config(params = {}) ⇒ Types::DescribeElasticsearchDomainConfigResponse
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1730 def describe_elasticsearch_domain_config(params = {}, = {}) req = build_request(:describe_elasticsearch_domain_config, params) req.send_request() end |
#describe_elasticsearch_domains(params = {}) ⇒ Types::DescribeElasticsearchDomainsResponse
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
1843 1844 1845 1846 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1843 def describe_elasticsearch_domains(params = {}, = {}) req = build_request(:describe_elasticsearch_domains, params) req.send_request() end |
#describe_elasticsearch_instance_type_limits(params = {}) ⇒ Types::DescribeElasticsearchInstanceTypeLimitsResponse
Describe Elasticsearch Limits for a given InstanceType and
ElasticsearchVersion. When modifying existing Domain, specify the
DomainName
to know what Limits are supported for modifying.
1895 1896 1897 1898 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1895 def describe_elasticsearch_instance_type_limits(params = {}, = {}) req = build_request(:describe_elasticsearch_instance_type_limits, params) req.send_request() end |
#describe_inbound_cross_cluster_search_connections(params = {}) ⇒ Types::DescribeInboundCrossClusterSearchConnectionsResponse
Lists all the inbound cross-cluster search connections for a destination domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1956 def describe_inbound_cross_cluster_search_connections(params = {}, = {}) req = build_request(:describe_inbound_cross_cluster_search_connections, params) req.send_request() end |
#describe_outbound_cross_cluster_search_connections(params = {}) ⇒ Types::DescribeOutboundCrossClusterSearchConnectionsResponse
Lists all the outbound cross-cluster search connections for a source domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2018 2019 2020 2021 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2018 def describe_outbound_cross_cluster_search_connections(params = {}, = {}) req = build_request(:describe_outbound_cross_cluster_search_connections, params) req.send_request() end |
#describe_packages(params = {}) ⇒ Types::DescribePackagesResponse
Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2075 def describe_packages(params = {}, = {}) req = build_request(:describe_packages, params) req.send_request() end |
#describe_reserved_elasticsearch_instance_offerings(params = {}) ⇒ Types::DescribeReservedElasticsearchInstanceOfferingsResponse
Lists available reserved Elasticsearch instance offerings.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2127 2128 2129 2130 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2127 def describe_reserved_elasticsearch_instance_offerings(params = {}, = {}) req = build_request(:describe_reserved_elasticsearch_instance_offerings, params) req.send_request() end |
#describe_reserved_elasticsearch_instances(params = {}) ⇒ Types::DescribeReservedElasticsearchInstancesResponse
Returns information about reserved Elasticsearch instances for this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2185 def describe_reserved_elasticsearch_instances(params = {}, = {}) req = build_request(:describe_reserved_elasticsearch_instances, params) req.send_request() end |
#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResponse
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
2228 2229 2230 2231 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2228 def describe_vpc_endpoints(params = {}, = {}) req = build_request(:describe_vpc_endpoints, params) req.send_request() end |
#dissociate_package(params = {}) ⇒ Types::DissociatePackageResponse
Dissociates a package from the Amazon ES domain.
2268 2269 2270 2271 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2268 def dissociate_package(params = {}, = {}) req = build_request(:dissociate_package, params) req.send_request() end |
#get_compatible_elasticsearch_versions(params = {}) ⇒ Types::GetCompatibleElasticsearchVersionsResponse
Returns a list of upgrade compatible Elastisearch versions. You can
optionally pass a DomainName
to get all upgrade compatible
Elasticsearch versions for that specific domain.
2302 2303 2304 2305 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2302 def get_compatible_elasticsearch_versions(params = {}, = {}) req = build_request(:get_compatible_elasticsearch_versions, params) req.send_request() end |
#get_package_version_history(params = {}) ⇒ Types::GetPackageVersionHistoryResponse
Returns a list of versions of the package, along with their creation time and commit message.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2348 2349 2350 2351 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2348 def get_package_version_history(params = {}, = {}) req = build_request(:get_package_version_history, params) req.send_request() end |
#get_upgrade_history(params = {}) ⇒ Types::GetUpgradeHistoryResponse
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2401 2402 2403 2404 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2401 def get_upgrade_history(params = {}, = {}) req = build_request(:get_upgrade_history, params) req.send_request() end |
#get_upgrade_status(params = {}) ⇒ Types::GetUpgradeStatusResponse
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
2435 2436 2437 2438 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2435 def get_upgrade_status(params = {}, = {}) req = build_request(:get_upgrade_status, params) req.send_request() end |
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Returns the name of all Elasticsearch domains owned by the current user's account.
2465 2466 2467 2468 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2465 def list_domain_names(params = {}, = {}) req = build_request(:list_domain_names, params) req.send_request() end |
#list_domains_for_package(params = {}) ⇒ Types::ListDomainsForPackageResponse
Lists all Amazon ES domains associated with the package.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2515 2516 2517 2518 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2515 def list_domains_for_package(params = {}, = {}) req = build_request(:list_domains_for_package, params) req.send_request() end |
#list_elasticsearch_instance_types(params = {}) ⇒ Types::ListElasticsearchInstanceTypesResponse
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2564 def list_elasticsearch_instance_types(params = {}, = {}) req = build_request(:list_elasticsearch_instance_types, params) req.send_request() end |
#list_elasticsearch_versions(params = {}) ⇒ Types::ListElasticsearchVersionsResponse
List all supported Elasticsearch versions
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2602 2603 2604 2605 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2602 def list_elasticsearch_versions(params = {}, = {}) req = build_request(:list_elasticsearch_versions, params) req.send_request() end |
#list_packages_for_domain(params = {}) ⇒ Types::ListPackagesForDomainResponse
Lists all packages associated with the Amazon ES domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2652 def list_packages_for_domain(params = {}, = {}) req = build_request(:list_packages_for_domain, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Returns all tags for the given Elasticsearch domain.
2681 2682 2683 2684 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2681 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#list_vpc_endpoint_access(params = {}) ⇒ Types::ListVpcEndpointAccessResponse
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
2718 2719 2720 2721 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2718 def list_vpc_endpoint_access(params = {}, = {}) req = build_request(:list_vpc_endpoint_access, params) req.send_request() end |
#list_vpc_endpoints(params = {}) ⇒ Types::ListVpcEndpointsResponse
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
2751 2752 2753 2754 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2751 def list_vpc_endpoints(params = {}, = {}) req = build_request(:list_vpc_endpoints, params) req.send_request() end |
#list_vpc_endpoints_for_domain(params = {}) ⇒ Types::ListVpcEndpointsForDomainResponse
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
2788 2789 2790 2791 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2788 def list_vpc_endpoints_for_domain(params = {}, = {}) req = build_request(:list_vpc_endpoints_for_domain, params) req.send_request() end |
#purchase_reserved_elasticsearch_instance_offering(params = {}) ⇒ Types::PurchaseReservedElasticsearchInstanceOfferingResponse
Allows you to purchase reserved Elasticsearch instances.
2824 2825 2826 2827 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2824 def purchase_reserved_elasticsearch_instance_offering(params = {}, = {}) req = build_request(:purchase_reserved_elasticsearch_instance_offering, params) req.send_request() end |
#reject_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::RejectInboundCrossClusterSearchConnectionResponse
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
2859 2860 2861 2862 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2859 def reject_inbound_cross_cluster_search_connection(params = {}, = {}) req = build_request(:reject_inbound_cross_cluster_search_connection, params) req.send_request() end |
#remove_tags(params = {}) ⇒ Struct
Removes the specified set of tags from the specified Elasticsearch domain.
2886 2887 2888 2889 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2886 def (params = {}, = {}) req = build_request(:remove_tags, params) req.send_request() end |
#revoke_vpc_endpoint_access(params = {}) ⇒ Struct
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
2911 2912 2913 2914 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2911 def revoke_vpc_endpoint_access(params = {}, = {}) req = build_request(:revoke_vpc_endpoint_access, params) req.send_request() end |
#start_elasticsearch_service_software_update(params = {}) ⇒ Types::StartElasticsearchServiceSoftwareUpdateResponse
Schedules a service software update for an Amazon ES domain.
2945 2946 2947 2948 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2945 def start_elasticsearch_service_software_update(params = {}, = {}) req = build_request(:start_elasticsearch_service_software_update, params) req.send_request() end |
#update_elasticsearch_domain_config(params = {}) ⇒ Types::UpdateElasticsearchDomainConfigResponse
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
3285 3286 3287 3288 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3285 def update_elasticsearch_domain_config(params = {}, = {}) req = build_request(:update_elasticsearch_domain_config, params) req.send_request() end |
#update_package(params = {}) ⇒ Types::UpdatePackageResponse
Updates a package for use with Amazon ES domains.
3337 3338 3339 3340 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3337 def update_package(params = {}, = {}) req = build_request(:update_package, params) req.send_request() end |
#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
3381 3382 3383 3384 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3381 def update_vpc_endpoint(params = {}, = {}) req = build_request(:update_vpc_endpoint, params) req.send_request() end |
#upgrade_elasticsearch_domain(params = {}) ⇒ Types::UpgradeElasticsearchDomainResponse
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
3432 3433 3434 3435 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3432 def upgrade_elasticsearch_domain(params = {}, = {}) req = build_request(:upgrade_elasticsearch_domain, params) req.send_request() end |