Class: Aws::ElasticsearchService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ElasticsearchService::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 422 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3475 3476 3477 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3475 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3478 3479 3480 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3478 def errors_module Errors 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.
458 459 460 461 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 458 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.]
494 495 496 497 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 494 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.
534 535 536 537 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 534 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.
566 567 568 569 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 566 def (params = {}, = {}) req = build_request(:authorize_vpc_endpoint_access, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3453 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-elasticsearchservice' context[:gem_version] = '1.89.0' Seahorse::Client::Request.new(handlers, context) end |
#cancel_domain_config_change(params = {}) ⇒ Types::CancelDomainConfigChangeResponse
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
606 607 608 609 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 606 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.
642 643 644 645 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 642 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][1
-
in the *Amazon Elasticsearch
Service Developer Guide*.
941 942 943 944 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 941 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.
999 1000 1001 1002 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 999 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.
1049 1050 1051 1052 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1049 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.
1098 1099 1100 1101 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1098 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.
1210 1211 1212 1213 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1210 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*.
[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr
1230 1231 1232 1233 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1230 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.
1265 1266 1267 1268 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1265 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.
1301 1302 1303 1304 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1301 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.
1337 1338 1339 1340 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1337 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.
1366 1367 1368 1369 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1366 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.
1413 1414 1415 1416 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1413 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.
1461 1462 1463 1464 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1461 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.
1573 1574 1575 1576 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1573 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.
1742 1743 1744 1745 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1742 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.
1855 1856 1857 1858 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1855 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.
1907 1908 1909 1910 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1907 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.
1968 1969 1970 1971 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1968 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.
2030 2031 2032 2033 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2030 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.
2087 2088 2089 2090 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2087 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.
2139 2140 2141 2142 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2139 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.
2197 2198 2199 2200 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2197 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.
2240 2241 2242 2243 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2240 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.
2280 2281 2282 2283 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2280 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.
2314 2315 2316 2317 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2314 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.
2360 2361 2362 2363 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2360 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.
2413 2414 2415 2416 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2413 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.
2447 2448 2449 2450 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2447 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.
2477 2478 2479 2480 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2477 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.
2527 2528 2529 2530 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2527 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.
2576 2577 2578 2579 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2576 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.
2614 2615 2616 2617 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2614 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.
2664 2665 2666 2667 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2664 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.
2693 2694 2695 2696 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2693 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.
2730 2731 2732 2733 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2730 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.
2763 2764 2765 2766 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2763 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.
2800 2801 2802 2803 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2800 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.
2836 2837 2838 2839 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2836 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.
2871 2872 2873 2874 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2871 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.
2898 2899 2900 2901 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2898 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.
2923 2924 2925 2926 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2923 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.
2957 2958 2959 2960 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2957 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.
3297 3298 3299 3300 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3297 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.
3349 3350 3351 3352 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3349 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.
3393 3394 3395 3396 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3393 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.
3444 3445 3446 3447 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3444 def upgrade_elasticsearch_domain(params = {}, = {}) req = build_request(:upgrade_elasticsearch_domain, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3468 3469 3470 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3468 def waiter_names [] end |