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.
420 421 422 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 420 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.
485 486 487 488 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 485 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.
536 537 538 539 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 536 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.
587 588 589 590 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 587 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.
635 636 637 638 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 635 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.
697 698 699 700 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 697 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.
770 771 772 773 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 770 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.
831 832 833 834 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 831 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.
900 901 902 903 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 900 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.
965 966 967 968 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 965 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.
1024 1025 1026 1027 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1024 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.
1063 1064 1065 1066 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1063 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.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1112 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.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1151 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.
1189 1190 1191 1192 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1189 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.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1223 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.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1267 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.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1309 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.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1329 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.
1358 1359 1360 1361 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1358 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.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1401 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.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1446 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1503 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.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1563 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.
1624 1625 1626 1627 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1624 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.
1681 1682 1683 1684 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1681 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.
1738 1739 1740 1741 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1738 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.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1776 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.
1833 1834 1835 1836 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1833 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.
1873 1874 1875 1876 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1873 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.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1908 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.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1971 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.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2016 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.
2063 2064 2065 2066 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2063 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.
2126 2127 2128 2129 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2126 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.
2198 2199 2200 2201 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2198 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.
2263 2264 2265 2266 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2263 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2331 def update_vpc_endpoint(params = {}, = {}) req = build_request(:update_vpc_endpoint, params) req.send_request() end |