Class: Aws::OpenSearchService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::OpenSearchService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb
Overview
An API client for OpenSearchService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::OpenSearchService::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_connection(params = {}) ⇒ Types::AcceptInboundConnectionResponse
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
-
#add_data_source(params = {}) ⇒ Types::AddDataSourceResponse
Creates a new direct-query data source to the specified domain.
-
#add_direct_query_data_source(params = {}) ⇒ Types::AddDirectQueryDataSourceResponse
Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.
-
#add_tags(params = {}) ⇒ Struct
Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application.
-
#associate_package(params = {}) ⇒ Types::AssociatePackageResponse
Associates a package with an Amazon OpenSearch Service domain.
-
#associate_packages(params = {}) ⇒ Types::AssociatePackagesResponse
Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.
-
#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_service_software_update(params = {}) ⇒ Types::CancelServiceSoftwareUpdateResponse
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an OpenSearch Application.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates an Amazon OpenSearch Service domain.
-
#create_outbound_connection(params = {}) ⇒ Types::CreateOutboundConnectionResponse
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
-
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Creates a package for use with Amazon OpenSearch Service domains.
-
#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResponse
Creates an Amazon OpenSearch Service-managed VPC endpoint.
-
#delete_application(params = {}) ⇒ Struct
Deletes an existing OpenSearch Application.
-
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Deletes a direct-query data source.
-
#delete_direct_query_data_source(params = {}) ⇒ Struct
Deletes a previously configured direct query data source from Amazon OpenSearch Service.
-
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
Deletes an Amazon OpenSearch Service domain and all of its data.
-
#delete_inbound_connection(params = {}) ⇒ Types::DeleteInboundConnectionResponse
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
-
#delete_outbound_connection(params = {}) ⇒ Types::DeleteOutboundConnectionResponse
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
-
#delete_package(params = {}) ⇒ Types::DeletePackageResponse
Deletes an Amazon OpenSearch Service package.
-
#delete_vpc_endpoint(params = {}) ⇒ Types::DeleteVpcEndpointResponse
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
-
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
-
#describe_domain_auto_tunes(params = {}) ⇒ Types::DescribeDomainAutoTunesResponse
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
-
#describe_domain_change_progress(params = {}) ⇒ Types::DescribeDomainChangeProgressResponse
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
-
#describe_domain_config(params = {}) ⇒ Types::DescribeDomainConfigResponse
Returns the configuration of an Amazon OpenSearch Service domain.
-
#describe_domain_health(params = {}) ⇒ Types::DescribeDomainHealthResponse
Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
-
#describe_domain_nodes(params = {}) ⇒ Types::DescribeDomainNodesResponse
Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
-
#describe_domains(params = {}) ⇒ Types::DescribeDomainsResponse
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
-
#describe_dry_run_progress(params = {}) ⇒ Types::DescribeDryRunProgressResponse
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
-
#describe_inbound_connections(params = {}) ⇒ Types::DescribeInboundConnectionsResponse
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
-
#describe_instance_type_limits(params = {}) ⇒ Types::DescribeInstanceTypeLimitsResponse
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
-
#describe_outbound_connections(params = {}) ⇒ Types::DescribeOutboundConnectionsResponse
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
-
#describe_packages(params = {}) ⇒ Types::DescribePackagesResponse
Describes all packages available to OpenSearch Service.
-
#describe_reserved_instance_offerings(params = {}) ⇒ Types::DescribeReservedInstanceOfferingsResponse
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
-
#describe_reserved_instances(params = {}) ⇒ Types::DescribeReservedInstancesResponse
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
-
#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResponse
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
-
#dissociate_package(params = {}) ⇒ Types::DissociatePackageResponse
Removes a package from the specified Amazon OpenSearch Service domain.
-
#dissociate_packages(params = {}) ⇒ Types::DissociatePackagesResponse
Dissociates multiple packages from a domain simulatneously.
-
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Check the configuration and status of an existing OpenSearch Application.
-
#get_compatible_versions(params = {}) ⇒ Types::GetCompatibleVersionsResponse
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
-
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Retrieves information about a direct query data source.
-
#get_direct_query_data_source(params = {}) ⇒ Types::GetDirectQueryDataSourceResponse
Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.
-
#get_domain_maintenance_status(params = {}) ⇒ Types::GetDomainMaintenanceStatusResponse
The status of the maintenance action.
-
#get_package_version_history(params = {}) ⇒ Types::GetPackageVersionHistoryResponse
Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).
-
#get_upgrade_history(params = {}) ⇒ Types::GetUpgradeHistoryResponse
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
-
#get_upgrade_status(params = {}) ⇒ Types::GetUpgradeStatusResponse
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
List all OpenSearch Applications under your account.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists direct-query data sources for a specific domain.
-
#list_direct_query_data_sources(params = {}) ⇒ Types::ListDirectQueryDataSourcesResponse
Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.
-
#list_domain_maintenances(params = {}) ⇒ Types::ListDomainMaintenancesResponse
A list of maintenance actions for the domain.
-
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
-
#list_domains_for_package(params = {}) ⇒ Types::ListDomainsForPackageResponse
Lists all Amazon OpenSearch Service domains associated with a given package.
-
#list_instance_type_details(params = {}) ⇒ Types::ListInstanceTypeDetailsResponse
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
-
#list_packages_for_domain(params = {}) ⇒ Types::ListPackagesForDomainResponse
Lists all packages associated with an Amazon OpenSearch Service domain.
-
#list_scheduled_actions(params = {}) ⇒ Types::ListScheduledActionsResponse
Retrieves a list of configuration changes that are scheduled for a domain.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application.
-
#list_versions(params = {}) ⇒ Types::ListVersionsResponse
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
-
#list_vpc_endpoint_access(params = {}) ⇒ Types::ListVpcEndpointAccessResponse
Retrieves information about each Amazon Web Services 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 Amazon Web Services 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_instance_offering(params = {}) ⇒ Types::PurchaseReservedInstanceOfferingResponse
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
-
#reject_inbound_connection(params = {}) ⇒ Types::RejectInboundConnectionResponse
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
-
#remove_tags(params = {}) ⇒ Struct
Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application.
-
#revoke_vpc_endpoint_access(params = {}) ⇒ Struct
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
-
#start_domain_maintenance(params = {}) ⇒ Types::StartDomainMaintenanceResponse
Starts the node maintenance process on the data node.
-
#start_service_software_update(params = {}) ⇒ Types::StartServiceSoftwareUpdateResponse
Schedules a service software update for an Amazon OpenSearch Service domain.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Update the OpenSearch Application.
-
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a direct-query data source.
-
#update_direct_query_data_source(params = {}) ⇒ Types::UpdateDirectQueryDataSourceResponse
Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.
-
#update_domain_config(params = {}) ⇒ Types::UpdateDomainConfigResponse
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
-
#update_package(params = {}) ⇒ Types::UpdatePackageResponse
Updates a package for use with Amazon OpenSearch Service domains.
-
#update_package_scope(params = {}) ⇒ Types::UpdatePackageScopeResponse
Updates the scope of a package.
-
#update_scheduled_action(params = {}) ⇒ Types::UpdateScheduledActionResponse
Reschedules a planned domain configuration change for a later time.
-
#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
-
#upgrade_domain(params = {}) ⇒ Types::UpgradeDomainResponse
Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
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.
444 445 446 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#accept_inbound_connection(params = {}) ⇒ Types::AcceptInboundConnectionResponse
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
489 490 491 492 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 489 def accept_inbound_connection(params = {}, = {}) req = build_request(:accept_inbound_connection, params) req.send_request() end |
#add_data_source(params = {}) ⇒ Types::AddDataSourceResponse
Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.
539 540 541 542 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 539 def add_data_source(params = {}, = {}) req = build_request(:add_data_source, params) req.send_request() end |
#add_direct_query_data_source(params = {}) ⇒ Types::AddDirectQueryDataSourceResponse
Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.
600 601 602 603 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 600 def add_direct_query_data_source(params = {}, = {}) req = build_request(:add_direct_query_data_source, params) req.send_request() end |
#add_tags(params = {}) ⇒ Struct
Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application.
Tags are a set of case-sensitive key-value pairs. A domain, data source, or application can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service resources.
641 642 643 644 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 641 def (params = {}, = {}) req = build_request(:add_tags, params) req.send_request() end |
#associate_package(params = {}) ⇒ Types::AssociatePackageResponse
Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
708 709 710 711 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 708 def associate_package(params = {}, = {}) req = build_request(:associate_package, params) req.send_request() end |
#associate_packages(params = {}) ⇒ Types::AssociatePackagesResponse
Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.
769 770 771 772 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 769 def associate_packages(params = {}, = {}) req = build_request(:associate_packages, 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.
807 808 809 810 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 807 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.
851 852 853 854 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 851 def cancel_domain_config_change(params = {}, = {}) req = build_request(:cancel_domain_config_change, params) req.send_request() end |
#cancel_service_software_update(params = {}) ⇒ Types::CancelServiceSoftwareUpdateResponse
Cancels a scheduled service software update for an Amazon OpenSearch
Service domain. You can only perform this operation before the
AutomatedUpdateDate
and when the domain's UpdateStatus
is
PENDING_UPDATE
. For more information, see Service software updates
in Amazon OpenSearch Service.
895 896 897 898 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 895 def cancel_service_software_update(params = {}, = {}) req = build_request(:cancel_service_software_update, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an OpenSearch Application.
992 993 994 995 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 992 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1404 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#create_outbound_connection(params = {}) ⇒ Types::CreateOutboundConnectionResponse
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
1490 1491 1492 1493 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1490 def create_outbound_connection(params = {}, = {}) req = build_request(:create_outbound_connection, params) req.send_request() end |
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1593 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.
1645 1646 1647 1648 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1645 def create_vpc_endpoint(params = {}, = {}) req = build_request(:create_vpc_endpoint, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes an existing OpenSearch Application.
1668 1669 1670 1671 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1668 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1705 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_direct_query_data_source(params = {}) ⇒ Struct
Deletes a previously configured direct query data source from Amazon OpenSearch Service.
1729 1730 1731 1732 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1729 def delete_direct_query_data_source(params = {}, = {}) req = build_request(:delete_direct_query_data_source, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
1868 1869 1870 1871 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1868 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_inbound_connection(params = {}) ⇒ Types::DeleteInboundConnectionResponse
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1912 def delete_inbound_connection(params = {}, = {}) req = build_request(:delete_inbound_connection, params) req.send_request() end |
#delete_outbound_connection(params = {}) ⇒ Types::DeleteOutboundConnectionResponse
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
1959 1960 1961 1962 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1959 def delete_outbound_connection(params = {}, = {}) req = build_request(:delete_outbound_connection, params) req.send_request() end |
#delete_package(params = {}) ⇒ Types::DeletePackageResponse
Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
2018 2019 2020 2021 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2018 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.
2049 2050 2051 2052 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2049 def delete_vpc_endpoint(params = {}, = {}) req = build_request(:delete_vpc_endpoint, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
2189 2190 2191 2192 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2189 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_domain_auto_tunes(params = {}) ⇒ Types::DescribeDomainAutoTunesResponse
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2244 2245 2246 2247 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2244 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 an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
2299 2300 2301 2302 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2299 def describe_domain_change_progress(params = {}, = {}) req = build_request(:describe_domain_change_progress, params) req.send_request() end |
#describe_domain_config(params = {}) ⇒ Types::DescribeDomainConfigResponse
Returns the configuration of an Amazon OpenSearch Service domain.
2518 2519 2520 2521 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2518 def describe_domain_config(params = {}, = {}) req = build_request(:describe_domain_config, params) req.send_request() end |
#describe_domain_health(params = {}) ⇒ Types::DescribeDomainHealthResponse
Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
2579 2580 2581 2582 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2579 def describe_domain_health(params = {}, = {}) req = build_request(:describe_domain_health, params) req.send_request() end |
#describe_domain_nodes(params = {}) ⇒ Types::DescribeDomainNodesResponse
Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
2617 2618 2619 2620 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2617 def describe_domain_nodes(params = {}, = {}) req = build_request(:describe_domain_nodes, params) req.send_request() end |
#describe_domains(params = {}) ⇒ Types::DescribeDomainsResponse
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
2758 2759 2760 2761 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2758 def describe_domains(params = {}, = {}) req = build_request(:describe_domains, params) req.send_request() end |
#describe_dry_run_progress(params = {}) ⇒ Types::DescribeDryRunProgressResponse
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.
2923 2924 2925 2926 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2923 def describe_dry_run_progress(params = {}, = {}) req = build_request(:describe_dry_run_progress, params) req.send_request() end |
#describe_inbound_connections(params = {}) ⇒ Types::DescribeInboundConnectionsResponse
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2990 2991 2992 2993 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2990 def describe_inbound_connections(params = {}, = {}) req = build_request(:describe_inbound_connections, params) req.send_request() end |
#describe_instance_type_limits(params = {}) ⇒ Types::DescribeInstanceTypeLimitsResponse
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
3044 3045 3046 3047 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3044 def describe_instance_type_limits(params = {}, = {}) req = build_request(:describe_instance_type_limits, params) req.send_request() end |
#describe_outbound_connections(params = {}) ⇒ Types::DescribeOutboundConnectionsResponse
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3112 3113 3114 3115 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3112 def describe_outbound_connections(params = {}, = {}) req = build_request(:describe_outbound_connections, params) req.send_request() end |
#describe_packages(params = {}) ⇒ Types::DescribePackagesResponse
Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3193 3194 3195 3196 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3193 def describe_packages(params = {}, = {}) req = build_request(:describe_packages, params) req.send_request() end |
#describe_reserved_instance_offerings(params = {}) ⇒ Types::DescribeReservedInstanceOfferingsResponse
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3255 3256 3257 3258 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3255 def describe_reserved_instance_offerings(params = {}, = {}) req = build_request(:describe_reserved_instance_offerings, params) req.send_request() end |
#describe_reserved_instances(params = {}) ⇒ Types::DescribeReservedInstancesResponse
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3323 def describe_reserved_instances(params = {}, = {}) req = build_request(:describe_reserved_instances, params) req.send_request() end |
#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResponse
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
3368 3369 3370 3371 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3368 def describe_vpc_endpoints(params = {}, = {}) req = build_request(:describe_vpc_endpoints, params) req.send_request() end |
#dissociate_package(params = {}) ⇒ Types::DissociatePackageResponse
Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
3422 3423 3424 3425 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3422 def dissociate_package(params = {}, = {}) req = build_request(:dissociate_package, params) req.send_request() end |
#dissociate_packages(params = {}) ⇒ Types::DissociatePackagesResponse
Dissociates multiple packages from a domain simulatneously.
3470 3471 3472 3473 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3470 def dissociate_packages(params = {}, = {}) req = build_request(:dissociate_packages, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Check the configuration and status of an existing OpenSearch Application.
3524 3525 3526 3527 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3524 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_compatible_versions(params = {}) ⇒ Types::GetCompatibleVersionsResponse
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
3557 3558 3559 3560 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3557 def get_compatible_versions(params = {}, = {}) req = build_request(:get_compatible_versions, params) req.send_request() end |
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Retrieves information about a direct query data source.
3595 3596 3597 3598 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3595 def get_data_source(params = {}, = {}) req = build_request(:get_data_source, params) req.send_request() end |
#get_direct_query_data_source(params = {}) ⇒ Types::GetDirectQueryDataSourceResponse
Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.
3635 3636 3637 3638 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3635 def get_direct_query_data_source(params = {}, = {}) req = build_request(:get_direct_query_data_source, params) req.send_request() end |
#get_domain_maintenance_status(params = {}) ⇒ Types::GetDomainMaintenanceStatusResponse
The status of the maintenance action.
3677 3678 3679 3680 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3677 def get_domain_maintenance_status(params = {}, = {}) req = build_request(:get_domain_maintenance_status, params) req.send_request() end |
#get_package_version_history(params = {}) ⇒ Types::GetPackageVersionHistoryResponse
Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3742 3743 3744 3745 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3742 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 performed on an Amazon OpenSearch Service domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3796 3797 3798 3799 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3796 def get_upgrade_history(params = {}, = {}) req = build_request(:get_upgrade_history, params) req.send_request() end |
#get_upgrade_status(params = {}) ⇒ Types::GetUpgradeStatusResponse
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
3829 3830 3831 3832 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3829 def get_upgrade_status(params = {}, = {}) req = build_request(:get_upgrade_status, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
List all OpenSearch Applications under your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.