Client — AWS SDK for Ruby V3 (original) (raw)

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

473 474 475	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 473 def initialize(*args) super end

Instance Method Details

#batch_get_collection(params = {}) ⇒ Types::BatchGetCollectionResponse

540 541 542 543	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 540 def batch_get_collection(params = {}, options = {}) req = build_request(:batch_get_collection, params) req.send_request(options) end

#batch_get_effective_lifecycle_policy(params = {}) ⇒ Types::BatchGetEffectiveLifecyclePolicyResponse

591 592 593 594	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 591 def batch_get_effective_lifecycle_policy(params = {}, options = {}) req = build_request(:batch_get_effective_lifecycle_policy, params) req.send_request(options) end

#batch_get_lifecycle_policy(params = {}) ⇒ Types::BatchGetLifecyclePolicyResponse

642 643 644 645	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 642 def batch_get_lifecycle_policy(params = {}, options = {}) req = build_request(:batch_get_lifecycle_policy, params) req.send_request(options) end

#batch_get_vpc_endpoint(params = {}) ⇒ Types::BatchGetVpcEndpointResponse

692 693 694 695	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 692 def batch_get_vpc_endpoint(params = {}, options = {}) req = build_request(:batch_get_vpc_endpoint, params) req.send_request(options) 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.

754 755 756 757	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 754 def create_access_policy(params = {}, options = {}) req = build_request(:create_access_policy, params) req.send_request(options) end

#create_collection(params = {}) ⇒ Types::CreateCollectionResponse

827 828 829 830	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 827 def create_collection(params = {}, options = {}) req = build_request(:create_collection, params) req.send_request(options) 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.

888 889 890 891	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 888 def create_lifecycle_policy(params = {}, options = {}) req = build_request(:create_lifecycle_policy, params) req.send_request(options) end

#create_security_config(params = {}) ⇒ Types::CreateSecurityConfigResponse

975 976 977 978	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 975 def create_security_config(params = {}, options = {}) req = build_request(:create_security_config, params) req.send_request(options) end

#create_security_policy(params = {}) ⇒ Types::CreateSecurityPolicyResponse

1040 1041 1042 1043	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1040 def create_security_policy(params = {}, options = {}) req = build_request(:create_security_policy, params) req.send_request(options) end

#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResponse

1099 1100 1101 1102	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1099 def create_vpc_endpoint(params = {}, options = {}) req = build_request(:create_vpc_endpoint, params) req.send_request(options) end

#delete_access_policy(params = {}) ⇒ Struct

1138 1139 1140 1141	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1138 def delete_access_policy(params = {}, options = {}) req = build_request(:delete_access_policy, params) req.send_request(options) end

#delete_collection(params = {}) ⇒ Types::DeleteCollectionResponse

1187 1188 1189 1190	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1187 def delete_collection(params = {}, options = {}) req = build_request(:delete_collection, params) req.send_request(options) end

#delete_lifecycle_policy(params = {}) ⇒ Struct

1226 1227 1228 1229	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1226 def delete_lifecycle_policy(params = {}, options = {}) req = build_request(:delete_lifecycle_policy, params) req.send_request(options) end

#delete_security_config(params = {}) ⇒ Struct

1264 1265 1266 1267	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1264 def delete_security_config(params = {}, options = {}) req = build_request(:delete_security_config, params) req.send_request(options) end

#delete_security_policy(params = {}) ⇒ Struct

Deletes an OpenSearch Serverless security policy.

1298 1299 1300 1301	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1298 def delete_security_policy(params = {}, options = {}) req = build_request(:delete_security_policy, params) req.send_request(options) end

#delete_vpc_endpoint(params = {}) ⇒ Types::DeleteVpcEndpointResponse

1342 1343 1344 1345	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1342 def delete_vpc_endpoint(params = {}, options = {}) req = build_request(:delete_vpc_endpoint, params) req.send_request(options) end

#get_access_policy(params = {}) ⇒ Types::GetAccessPolicyResponse

1384 1385 1386 1387	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1384 def get_access_policy(params = {}, options = {}) req = build_request(:get_access_policy, params) req.send_request(options) end

#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse

Returns account-level settings related to OpenSearch Serverless.

1404 1405 1406 1407	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1404 def get_account_settings(params = {}, options = {}) req = build_request(:get_account_settings, params) req.send_request(options) end

#get_policies_stats(params = {}) ⇒ Types::GetPoliciesStatsResponse

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

1433 1434 1435 1436	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1433 def get_policies_stats(params = {}, options = {}) req = build_request(:get_policies_stats, params) req.send_request(options) end

#get_security_config(params = {}) ⇒ Types::GetSecurityConfigResponse

1483 1484 1485 1486	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1483 def get_security_config(params = {}, options = {}) req = build_request(:get_security_config, params) req.send_request(options) end

#get_security_policy(params = {}) ⇒ Types::GetSecurityPolicyResponse

1528 1529 1530 1531	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1528 def get_security_policy(params = {}, options = {}) req = build_request(:get_security_policy, params) req.send_request(options) 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.

1585 1586 1587 1588	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1585 def list_access_policies(params = {}, options = {}) req = build_request(:list_access_policies, params) req.send_request(options) end

#list_collections(params = {}) ⇒ Types::ListCollectionsResponse

1645 1646 1647 1648	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1645 def list_collections(params = {}, options = {}) req = build_request(:list_collections, params) req.send_request(options) end

#list_lifecycle_policies(params = {}) ⇒ Types::ListLifecyclePoliciesResponse

1706 1707 1708 1709	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1706 def list_lifecycle_policies(params = {}, options = {}) req = build_request(:list_lifecycle_policies, params) req.send_request(options) end

#list_security_configs(params = {}) ⇒ Types::ListSecurityConfigsResponse

1763 1764 1765 1766	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1763 def list_security_configs(params = {}, options = {}) req = build_request(:list_security_configs, params) req.send_request(options) 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.

1820 1821 1822 1823	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1820 def list_security_policies(params = {}, options = {}) req = build_request(:list_security_policies, params) req.send_request(options) end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

1858 1859 1860 1861	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1858 def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end

#list_vpc_endpoints(params = {}) ⇒ Types::ListVpcEndpointsResponse

1915 1916 1917 1918	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1915 def list_vpc_endpoints(params = {}, options = {}) req = build_request(:list_vpc_endpoints, params) req.send_request(options) end

#tag_resource(params = {}) ⇒ Struct

1955 1956 1957 1958	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1955 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end

#untag_resource(params = {}) ⇒ Struct

1990 1991 1992 1993	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1990 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end

#update_access_policy(params = {}) ⇒ Types::UpdateAccessPolicyResponse

2053 2054 2055 2056	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2053 def update_access_policy(params = {}, options = {}) req = build_request(:update_access_policy, params) req.send_request(options) end

#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse

2098 2099 2100 2101	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2098 def update_account_settings(params = {}, options = {}) req = build_request(:update_account_settings, params) req.send_request(options) end

#update_collection(params = {}) ⇒ Types::UpdateCollectionResponse

Updates an OpenSearch Serverless collection.

2145 2146 2147 2148	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2145 def update_collection(params = {}, options = {}) req = build_request(:update_collection, params) req.send_request(options) end

#update_lifecycle_policy(params = {}) ⇒ Types::UpdateLifecyclePolicyResponse

2208 2209 2210 2211	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2208 def update_lifecycle_policy(params = {}, options = {}) req = build_request(:update_lifecycle_policy, params) req.send_request(options) end

#update_security_config(params = {}) ⇒ Types::UpdateSecurityConfigResponse

2295 2296 2297 2298	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2295 def update_security_config(params = {}, options = {}) req = build_request(:update_security_config, params) req.send_request(options) end

#update_security_policy(params = {}) ⇒ Types::UpdateSecurityPolicyResponse

2360 2361 2362 2363	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2360 def update_security_policy(params = {}, options = {}) req = build_request(:update_security_policy, params) req.send_request(options) end

#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse

2428 2429 2430 2431	# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2428 def update_vpc_endpoint(params = {}, options = {}) req = build_request(:update_vpc_endpoint, params) req.send_request(options) end