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.
466 467 468 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 466 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.
502 503 504 505 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 502 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.
538 539 540 541 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 538 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.
578 579 580 581 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 578 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.
610 611 612 613 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 610 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.
650 651 652 653 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 650 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.
686 687 688 689 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 686 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.
985 986 987 988 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 985 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.
1043 1044 1045 1046 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1043 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.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1093 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.
1142 1143 1144 1145 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1142 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.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1254 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.
1274 1275 1276 1277 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1274 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.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1309 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.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1345 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.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1381 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.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1410 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.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1457 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.
1505 1506 1507 1508 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1505 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.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1617 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.
1786 1787 1788 1789 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1786 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.
1899 1900 1901 1902 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1899 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.
1951 1952 1953 1954 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1951 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.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2012 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.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2074 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.
2131 2132 2133 2134 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2131 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.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2183 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.
2241 2242 2243 2244 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2241 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.
2284 2285 2286 2287 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2284 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.
2324 2325 2326 2327 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2324 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.
2358 2359 2360 2361 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2358 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.
2404 2405 2406 2407 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2404 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.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2457 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.
2491 2492 2493 2494 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2491 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.
2521 2522 2523 2524 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2521 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.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2571 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.
2620 2621 2622 2623 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2620 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.
2658 2659 2660 2661 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2658 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.
2708 2709 2710 2711 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2708 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.
2737 2738 2739 2740 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2737 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.
2774 2775 2776 2777 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2774 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.
2807 2808 2809 2810 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2807 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.
2844 2845 2846 2847 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2844 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.
2880 2881 2882 2883 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2880 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.
2915 2916 2917 2918 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2915 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.
2942 2943 2944 2945 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2942 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.
2967 2968 2969 2970 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2967 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.
3001 3002 3003 3004 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3001 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.
3341 3342 3343 3344 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3341 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.
3393 3394 3395 3396 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3393 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.
3437 3438 3439 3440 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3437 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.
3488 3489 3490 3491 |
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3488 def upgrade_elasticsearch_domain(params = {}, = {}) req = build_request(:upgrade_elasticsearch_domain, params) req.send_request() end |