Class: Aws::OpenSearchServerless::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::OpenSearchServerless::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb
Overview
An API client for OpenSearchServerless. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::OpenSearchServerless::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
-
#batch_get_collection(params = {}) ⇒ Types::BatchGetCollectionResponse
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint.
-
#batch_get_effective_lifecycle_policy(params = {}) ⇒ Types::BatchGetEffectiveLifecyclePolicyResponse
Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.
-
#batch_get_lifecycle_policy(params = {}) ⇒ Types::BatchGetLifecyclePolicyResponse
Returns one or more configured OpenSearch Serverless lifecycle policies.
-
#batch_get_vpc_endpoint(params = {}) ⇒ Types::BatchGetVpcEndpointResponse
Returns attributes for one or more VPC endpoints associated with the current account.
-
#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse
Creates a data access policy for OpenSearch Serverless.
-
#create_collection(params = {}) ⇒ Types::CreateCollectionResponse
Creates a new OpenSearch Serverless collection.
-
#create_lifecycle_policy(params = {}) ⇒ Types::CreateLifecyclePolicyResponse
Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
-
#create_security_config(params = {}) ⇒ Types::CreateSecurityConfigResponse
Specifies a security configuration for OpenSearch Serverless.
-
#create_security_policy(params = {}) ⇒ Types::CreateSecurityPolicyResponse
Creates a security policy to be used by one or more OpenSearch Serverless collections.
-
#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResponse
Creates an OpenSearch Serverless-managed interface VPC endpoint.
-
#delete_access_policy(params = {}) ⇒ Struct
Deletes an OpenSearch Serverless access policy.
-
#delete_collection(params = {}) ⇒ Types::DeleteCollectionResponse
Deletes an OpenSearch Serverless collection.
-
#delete_lifecycle_policy(params = {}) ⇒ Struct
Deletes an OpenSearch Serverless lifecycle policy.
-
#delete_security_config(params = {}) ⇒ Struct
Deletes a security configuration for OpenSearch Serverless.
-
#delete_security_policy(params = {}) ⇒ Struct
Deletes an OpenSearch Serverless security policy.
-
#delete_vpc_endpoint(params = {}) ⇒ Types::DeleteVpcEndpointResponse
Deletes an OpenSearch Serverless-managed interface endpoint.
-
#get_access_policy(params = {}) ⇒ Types::GetAccessPolicyResponse
Returns an OpenSearch Serverless access policy.
-
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Returns account-level settings related to OpenSearch Serverless.
-
#get_policies_stats(params = {}) ⇒ Types::GetPoliciesStatsResponse
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
-
#get_security_config(params = {}) ⇒ Types::GetSecurityConfigResponse
Returns information about an OpenSearch Serverless security configuration.
-
#get_security_policy(params = {}) ⇒ Types::GetSecurityPolicyResponse
Returns information about a configured OpenSearch Serverless security policy.
-
#list_access_policies(params = {}) ⇒ Types::ListAccessPoliciesResponse
Returns information about a list of OpenSearch Serverless access policies.
-
#list_collections(params = {}) ⇒ Types::ListCollectionsResponse
Lists all OpenSearch Serverless collections.
-
#list_lifecycle_policies(params = {}) ⇒ Types::ListLifecyclePoliciesResponse
Returns a list of OpenSearch Serverless lifecycle policies.
-
#list_security_configs(params = {}) ⇒ Types::ListSecurityConfigsResponse
Returns information about configured OpenSearch Serverless security configurations.
-
#list_security_policies(params = {}) ⇒ Types::ListSecurityPoliciesResponse
Returns information about configured OpenSearch Serverless security policies.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns the tags for an OpenSearch Serverless resource.
-
#list_vpc_endpoints(params = {}) ⇒ Types::ListVpcEndpointsResponse
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
-
#tag_resource(params = {}) ⇒ Struct
Associates tags with an OpenSearch Serverless resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag or set of tags from an OpenSearch Serverless resource.
-
#update_access_policy(params = {}) ⇒ Types::UpdateAccessPolicyResponse
Updates an OpenSearch Serverless access policy.
-
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
Update the OpenSearch Serverless settings for the current Amazon Web Services account.
-
#update_collection(params = {}) ⇒ Types::UpdateCollectionResponse
Updates an OpenSearch Serverless collection.
-
#update_lifecycle_policy(params = {}) ⇒ Types::UpdateLifecyclePolicyResponse
Updates an OpenSearch Serverless access policy.
-
#update_security_config(params = {}) ⇒ Types::UpdateSecurityConfigResponse
Updates a security configuration for OpenSearch Serverless.
-
#update_security_policy(params = {}) ⇒ Types::UpdateSecurityPolicyResponse
Updates an OpenSearch Serverless security policy.
-
#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse
Updates an OpenSearch Serverless-managed interface endpoint.
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.
395 396 397 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#batch_get_collection(params = {}) ⇒ Types::BatchGetCollectionResponse
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
460 461 462 463 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 460 def batch_get_collection(params = {}, = {}) req = build_request(:batch_get_collection, params) req.send_request() end |
#batch_get_effective_lifecycle_policy(params = {}) ⇒ Types::BatchGetEffectiveLifecyclePolicyResponse
Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.
511 512 513 514 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 511 def batch_get_effective_lifecycle_policy(params = {}, = {}) req = build_request(:batch_get_effective_lifecycle_policy, params) req.send_request() end |
#batch_get_lifecycle_policy(params = {}) ⇒ Types::BatchGetLifecyclePolicyResponse
Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
562 563 564 565 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 562 def batch_get_lifecycle_policy(params = {}, = {}) req = build_request(:batch_get_lifecycle_policy, params) req.send_request() end |
#batch_get_vpc_endpoint(params = {}) ⇒ Types::BatchGetVpcEndpointResponse
Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
610 611 612 613 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 610 def batch_get_vpc_endpoint(params = {}, = {}) req = build_request(:batch_get_vpc_endpoint, params) req.send_request() end |
#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse
Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.
672 673 674 675 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 672 def create_access_policy(params = {}, = {}) req = build_request(:create_access_policy, params) req.send_request() end |
#create_collection(params = {}) ⇒ Types::CreateCollectionResponse
Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
745 746 747 748 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 745 def create_collection(params = {}, = {}) req = build_request(:create_collection, params) req.send_request() end |
#create_lifecycle_policy(params = {}) ⇒ Types::CreateLifecyclePolicyResponse
Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.
806 807 808 809 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 806 def create_lifecycle_policy(params = {}, = {}) req = build_request(:create_lifecycle_policy, params) req.send_request() end |
#create_security_config(params = {}) ⇒ Types::CreateSecurityConfigResponse
Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
875 876 877 878 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 875 def create_security_config(params = {}, = {}) req = build_request(:create_security_config, params) req.send_request() end |
#create_security_policy(params = {}) ⇒ Types::CreateSecurityPolicyResponse
Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
940 941 942 943 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 940 def create_security_policy(params = {}, = {}) req = build_request(:create_security_policy, params) req.send_request() end |
#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResponse
Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
999 1000 1001 1002 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 999 def create_vpc_endpoint(params = {}, = {}) req = build_request(:create_vpc_endpoint, params) req.send_request() end |
#delete_access_policy(params = {}) ⇒ Struct
Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
1038 1039 1040 1041 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1038 def delete_access_policy(params = {}, = {}) req = build_request(:delete_access_policy, params) req.send_request() end |
#delete_collection(params = {}) ⇒ Types::DeleteCollectionResponse
Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1087 def delete_collection(params = {}, = {}) req = build_request(:delete_collection, params) req.send_request() end |
#delete_lifecycle_policy(params = {}) ⇒ Struct
Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
1126 1127 1128 1129 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1126 def delete_lifecycle_policy(params = {}, = {}) req = build_request(:delete_lifecycle_policy, params) req.send_request() end |
#delete_security_config(params = {}) ⇒ Struct
Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1164 def delete_security_config(params = {}, = {}) req = build_request(:delete_security_config, params) req.send_request() end |
#delete_security_policy(params = {}) ⇒ Struct
Deletes an OpenSearch Serverless security policy.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1198 def delete_security_policy(params = {}, = {}) req = build_request(:delete_security_policy, params) req.send_request() end |
#delete_vpc_endpoint(params = {}) ⇒ Types::DeleteVpcEndpointResponse
Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1242 def delete_vpc_endpoint(params = {}, = {}) req = build_request(:delete_vpc_endpoint, params) req.send_request() end |
#get_access_policy(params = {}) ⇒ Types::GetAccessPolicyResponse
Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
1284 1285 1286 1287 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1284 def get_access_policy(params = {}, = {}) req = build_request(:get_access_policy, params) req.send_request() end |
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Returns account-level settings related to OpenSearch Serverless.
1304 1305 1306 1307 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1304 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, params) req.send_request() end |
#get_policies_stats(params = {}) ⇒ Types::GetPoliciesStatsResponse
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
1333 1334 1335 1336 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1333 def get_policies_stats(params = {}, = {}) req = build_request(:get_policies_stats, params) req.send_request() end |
#get_security_config(params = {}) ⇒ Types::GetSecurityConfigResponse
Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
1376 1377 1378 1379 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1376 def get_security_config(params = {}, = {}) req = build_request(:get_security_config, params) req.send_request() end |
#get_security_policy(params = {}) ⇒ Types::GetSecurityPolicyResponse
Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
1421 1422 1423 1424 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1421 def get_security_policy(params = {}, = {}) req = build_request(:get_security_policy, params) req.send_request() end |
#list_access_policies(params = {}) ⇒ Types::ListAccessPoliciesResponse
Returns information about a list of OpenSearch Serverless access policies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1478 1479 1480 1481 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1478 def list_access_policies(params = {}, = {}) req = build_request(:list_access_policies, params) req.send_request() end |
#list_collections(params = {}) ⇒ Types::ListCollectionsResponse
Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1538 def list_collections(params = {}, = {}) req = build_request(:list_collections, params) req.send_request() end |
#list_lifecycle_policies(params = {}) ⇒ Types::ListLifecyclePoliciesResponse
Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1599 def list_lifecycle_policies(params = {}, = {}) req = build_request(:list_lifecycle_policies, params) req.send_request() end |
#list_security_configs(params = {}) ⇒ Types::ListSecurityConfigsResponse
Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1656 def list_security_configs(params = {}, = {}) req = build_request(:list_security_configs, params) req.send_request() end |
#list_security_policies(params = {}) ⇒ Types::ListSecurityPoliciesResponse
Returns information about configured OpenSearch Serverless security policies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1713 1714 1715 1716 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1713 def list_security_policies(params = {}, = {}) req = build_request(:list_security_policies, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
1751 1752 1753 1754 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1751 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_vpc_endpoints(params = {}) ⇒ Types::ListVpcEndpointsResponse
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1808 1809 1810 1811 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1808 def list_vpc_endpoints(params = {}, = {}) req = build_request(:list_vpc_endpoints, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
1848 1849 1850 1851 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1848 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
1883 1884 1885 1886 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1883 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access_policy(params = {}) ⇒ Types::UpdateAccessPolicyResponse
Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1946 def update_access_policy(params = {}, = {}) req = build_request(:update_access_policy, params) req.send_request() end |
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
1991 1992 1993 1994 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1991 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, params) req.send_request() end |
#update_collection(params = {}) ⇒ Types::UpdateCollectionResponse
Updates an OpenSearch Serverless collection.
2038 2039 2040 2041 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2038 def update_collection(params = {}, = {}) req = build_request(:update_collection, params) req.send_request() end |
#update_lifecycle_policy(params = {}) ⇒ Types::UpdateLifecyclePolicyResponse
Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
2101 2102 2103 2104 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2101 def update_lifecycle_policy(params = {}, = {}) req = build_request(:update_lifecycle_policy, params) req.send_request() end |
#update_security_config(params = {}) ⇒ Types::UpdateSecurityConfigResponse
Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
2173 2174 2175 2176 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2173 def update_security_config(params = {}, = {}) req = build_request(:update_security_config, params) req.send_request() end |
#update_security_policy(params = {}) ⇒ Types::UpdateSecurityPolicyResponse
Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
2238 2239 2240 2241 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2238 def update_security_policy(params = {}, = {}) req = build_request(:update_security_policy, params) req.send_request() end |
#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse
Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
2306 2307 2308 2309 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2306 def update_vpc_endpoint(params = {}, = {}) req = build_request(:update_vpc_endpoint, params) req.send_request() end |