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_tags(params = {}) ⇒ Struct
Attaches tags to an existing Amazon OpenSearch Service domain.
-
#associate_package(params = {}) ⇒ Types::AssociatePackageResponse
Associates a package with an Amazon OpenSearch Service 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_service_software_update(params = {}) ⇒ Types::CancelServiceSoftwareUpdateResponse
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
-
#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_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Deletes a direct-query data source.
-
#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.
-
#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_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_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists direct-query data sources for a specific domain.
-
#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.
-
#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.
-
#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_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a direct-query data source.
-
#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_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.
422 423 424 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 422 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.
467 468 469 470 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 467 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.
517 518 519 520 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 517 def add_data_source(params = {}, = {}) req = build_request(:add_data_source, params) req.send_request() end |
#add_tags(params = {}) ⇒ Struct
Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
556 557 558 559 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 556 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.
604 605 606 607 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 604 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.
638 639 640 641 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 638 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.
682 683 684 685 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 682 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.
726 727 728 729 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 726 def cancel_service_software_update(params = {}, = {}) req = build_request(:cancel_service_software_update, 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.
1108 1109 1110 1111 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1108 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.
1194 1195 1196 1197 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1194 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.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1258 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.
1310 1311 1312 1313 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1310 def create_vpc_endpoint(params = {}, = {}) req = build_request(:create_vpc_endpoint, 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.
1347 1348 1349 1350 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1347 def delete_data_source(params = {}, = {}) req = build_request(:delete_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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1475 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.
1519 1520 1521 1522 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1519 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.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1566 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.
1615 1616 1617 1618 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1615 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.
1646 1647 1648 1649 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1646 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.
1775 1776 1777 1778 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1775 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.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1830 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.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1885 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.
2088 2089 2090 2091 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2088 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.
2149 2150 2151 2152 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2149 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.
2187 2188 2189 2190 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2187 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.
2317 2318 2319 2320 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2317 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.
2471 2472 2473 2474 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2471 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.
2538 2539 2540 2541 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2538 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.
2592 2593 2594 2595 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2592 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.
2660 2661 2662 2663 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2660 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.
2731 2732 2733 2734 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2731 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.
2793 2794 2795 2796 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2793 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.
2861 2862 2863 2864 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2861 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.
2906 2907 2908 2909 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2906 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.
2956 2957 2958 2959 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2956 def dissociate_package(params = {}, = {}) req = build_request(:dissociate_package, 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.
2989 2990 2991 2992 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2989 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.
3027 3028 3029 3030 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3027 def get_data_source(params = {}, = {}) req = build_request(:get_data_source, params) req.send_request() end |
#get_domain_maintenance_status(params = {}) ⇒ Types::GetDomainMaintenanceStatusResponse
The status of the maintenance action.
3069 3070 3071 3072 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3069 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.
3130 3131 3132 3133 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3130 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.
3184 3185 3186 3187 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3184 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.
3217 3218 3219 3220 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3217 def get_upgrade_status(params = {}, = {}) req = build_request(:get_upgrade_status, params) req.send_request() end |
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
3255 3256 3257 3258 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3255 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_domain_maintenances(params = {}) ⇒ Types::ListDomainMaintenancesResponse
A list of maintenance actions for the domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3315 3316 3317 3318 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3315 def list_domain_maintenances(params = {}, = {}) req = build_request(:list_domain_maintenances, params) req.send_request() end |
#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
3346 3347 3348 3349 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3346 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 OpenSearch Service domains associated with a given 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.
3407 3408 3409 3410 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3407 def list_domains_for_package(params = {}, = {}) req = build_request(:list_domains_for_package, params) req.send_request() end |
#list_instance_type_details(params = {}) ⇒ Types::ListInstanceTypeDetailsResponse
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3478 def list_instance_type_details(params = {}, = {}) req = build_request(:list_instance_type_details, params) req.send_request() end |
#list_packages_for_domain(params = {}) ⇒ Types::ListPackagesForDomainResponse
Lists all packages associated with an Amazon OpenSearch Service domain. 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.
3538 3539 3540 3541 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3538 def list_packages_for_domain(params = {}, = {}) req = build_request(:list_packages_for_domain, params) req.send_request() end |
#list_scheduled_actions(params = {}) ⇒ Types::ListScheduledActionsResponse
Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3598 3599 3600 3601 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3598 def list_scheduled_actions(params = {}, = {}) req = build_request(:list_scheduled_actions, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
3633 3634 3635 3636 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3633 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#list_versions(params = {}) ⇒ Types::ListVersionsResponse
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3674 3675 3676 3677 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3674 def list_versions(params = {}, = {}) req = build_request(:list_versions, params) req.send_request() end |
#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.
3716 3717 3718 3719 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3716 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 Amazon Web Services account and Region.
3753 3754 3755 3756 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3753 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.
3795 3796 3797 3798 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3795 def list_vpc_endpoints_for_domain(params = {}, = {}) req = build_request(:list_vpc_endpoints_for_domain, params) req.send_request() end |
#purchase_reserved_instance_offering(params = {}) ⇒ Types::PurchaseReservedInstanceOfferingResponse
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
3833 3834 3835 3836 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3833 def purchase_reserved_instance_offering(params = {}, = {}) req = build_request(:purchase_reserved_instance_offering, params) req.send_request() end |
#reject_inbound_connection(params = {}) ⇒ Types::RejectInboundConnectionResponse
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
3871 3872 3873 3874 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3871 def reject_inbound_connection(params = {}, = {}) req = build_request(:reject_inbound_connection, params) req.send_request() end |
#remove_tags(params = {}) ⇒ Struct
Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
3904 3905 3906 3907 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3904 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.
3931 3932 3933 3934 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3931 def revoke_vpc_endpoint_access(params = {}, = {}) req = build_request(:revoke_vpc_endpoint_access, params) req.send_request() end |
#start_domain_maintenance(params = {}) ⇒ Types::StartDomainMaintenanceResponse
Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.
3969 3970 3971 3972 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3969 def start_domain_maintenance(params = {}, = {}) req = build_request(:start_domain_maintenance, params) req.send_request() end |
#start_service_software_update(params = {}) ⇒ Types::StartServiceSoftwareUpdateResponse
Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
4036 4037 4038 4039 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 4036 def start_service_software_update(params = {}, = {}) req = build_request(:start_service_software_update, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.
4090 4091 4092 4093 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 4090 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_domain_config(params = {}) ⇒ Types::UpdateDomainConfigResponse
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
4538 4539 4540 4541 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 4538 def update_domain_config(params = {}, = {}) req = build_request(:update_domain_config, params) req.send_request() end |
#update_package(params = {}) ⇒ Types::UpdatePackageResponse
Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
4603 4604 4605 4606 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 4603 def update_package(params = {}, = {}) req = build_request(:update_package, params) req.send_request() end |
#update_scheduled_action(params = {}) ⇒ Types::UpdateScheduledActionResponse
Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.
4687 4688 4689 4690 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 4687 def update_scheduled_action(params = {}, = {}) req = build_request(:update_scheduled_action, params) req.send_request() end |
#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
4733 4734 4735 4736 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 4733 def update_vpc_endpoint(params = {}, = {}) req = build_request(:update_vpc_endpoint, params) req.send_request() end |
#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.
4799 4800 4801 4802 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 4799 def upgrade_domain(params = {}, = {}) req = build_request(:upgrade_domain, params) req.send_request() end |