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.
385 386 387 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 385 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.
3438 3439 3440 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3438 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.
3441 3442 3443 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3441 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.
421 422 423 424 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 421 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.]
457 458 459 460 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 457 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.
497 498 499 500 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 497 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.
529 530 531 532 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 529 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.
3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3416 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.82.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.
569 570 571 572 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 569 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.
605 606 607 608 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 605 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*.
904 905 906 907 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 904 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.
962 963 964 965 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 962 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.
1012 1013 1014 1015 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1012 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.
1061 1062 1063 1064 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1061 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.
1173 1174 1175 1176 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1173 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
1193 1194 1195 1196 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1193 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.
1228 1229 1230 1231 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1228 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.
1264 1265 1266 1267 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1264 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.
1300 1301 1302 1303 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1300 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.
1329 1330 1331 1332 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1329 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.
1376 1377 1378 1379 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1376 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.
1424 1425 1426 1427 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1424 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.
1536 1537 1538 1539 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1536 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.
1705 1706 1707 1708 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1705 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.
1818 1819 1820 1821 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1818 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.
1870 1871 1872 1873 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1870 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.
1931 1932 1933 1934 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1931 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.
1993 1994 1995 1996 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 1993 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.
2050 2051 2052 2053 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2050 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.
2102 2103 2104 2105 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2102 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.
2160 2161 2162 2163 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2160 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.
2203 2204 2205 2206 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2203 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.
2243 2244 2245 2246 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2243 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.
2277 2278 2279 2280 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2277 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.
2323 2324 2325 2326 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2323 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.
2376 2377 2378 2379 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2376 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.
2410 2411 2412 2413 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2410 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.
2440 2441 2442 2443 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2440 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.
2490 2491 2492 2493 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2490 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.
2539 2540 2541 2542 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2539 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.
2577 2578 2579 2580 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2577 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.
2627 2628 2629 2630 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2627 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.
2656 2657 2658 2659 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2656 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.
2693 2694 2695 2696 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2693 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.
2726 2727 2728 2729 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2726 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.
2763 2764 2765 2766 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2763 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.
2799 2800 2801 2802 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2799 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.
2834 2835 2836 2837 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2834 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.
2861 2862 2863 2864 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2861 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.
2886 2887 2888 2889 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2886 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.
2920 2921 2922 2923 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 2920 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.
3260 3261 3262 3263 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3260 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.
3312 3313 3314 3315 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3312 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.
3356 3357 3358 3359 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3356 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.
3407 3408 3409 3410 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3407 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.
3431 3432 3433 |
# File 'lib/aws-sdk-elasticsearchservice/client.rb', line 3431 def waiter_names [] end |