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.
483 484 485 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 483 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.
550 551 552 553 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 550 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.
601 602 603 604 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 601 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.
652 653 654 655 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 652 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.
702 703 704 705 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 702 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.
764 765 766 767 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 764 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.
837 838 839 840 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 837 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.
898 899 900 901 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 898 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.
985 986 987 988 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 985 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.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1050 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.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1109 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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1148 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.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1197 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.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1236 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.
1274 1275 1276 1277 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1274 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.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1308 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.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1352 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.
1394 1395 1396 1397 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1394 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.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1414 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.
1443 1444 1445 1446 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1443 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.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1493 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.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1538 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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1595 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.
1655 1656 1657 1658 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1655 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.
1716 1717 1718 1719 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1716 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.
1773 1774 1775 1776 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1773 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.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1830 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.
1868 1869 1870 1871 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1868 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.
1925 1926 1927 1928 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1925 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.
1965 1966 1967 1968 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1965 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.
2000 2001 2002 2003 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2000 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.
2063 2064 2065 2066 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2063 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2108 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.
2155 2156 2157 2158 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2155 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.
2218 2219 2220 2221 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2218 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.
2305 2306 2307 2308 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2305 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.
2370 2371 2372 2373 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2370 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.
2438 2439 2440 2441 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2438 def update_vpc_endpoint(params = {}, = {}) req = build_request(:update_vpc_endpoint, params) req.send_request() end |