OpenSearchServiceServerless *************************** Client ====== class OpenSearchServiceServerless.Client A low-level client representing OpenSearch Service Serverless Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies. OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management. To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless? import boto3 client = boto3.client('opensearchserverless') These are the available methods: * batch_get_collection * batch_get_effective_lifecycle_policy * batch_get_lifecycle_policy * batch_get_vpc_endpoint * can_paginate * close * create_access_policy * create_collection * create_index * create_lifecycle_policy * create_security_config * create_security_policy * create_vpc_endpoint * delete_access_policy * delete_collection * delete_index * delete_lifecycle_policy * delete_security_config * delete_security_policy * delete_vpc_endpoint * get_access_policy * get_account_settings * get_index * get_paginator * get_policies_stats * get_security_config * get_security_policy * get_waiter * list_access_policies * list_collections * list_lifecycle_policies * list_security_configs * list_security_policies * list_tags_for_resource * list_vpc_endpoints * tag_resource * untag_resource * update_access_policy * update_account_settings * update_collection * update_index * update_lifecycle_policy * update_security_config * update_security_policy * update_vpc_endpoint OpenSearchServiceServerless / Client / delete_collection delete_collection ***************** OpenSearchServiceServerless.Client.delete_collection(**kwargs) Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections. See also: AWS API Documentation **Request Syntax** response = client.delete_collection( id='string', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier of the collection. For example, "1iu5usc406kd". The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API. * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'deleteCollectionDetail': { 'id': 'string', 'name': 'string', 'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED' } } **Response Structure** * *(dict) --* * **deleteCollectionDetail** *(dict) --* Details of the deleted collection. * **id** *(string) --* The unique identifier of the collection. * **name** *(string) --* The name of the collection. * **status** *(string) --* The current status of the collection. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / get_paginator get_paginator ************* OpenSearchServiceServerless.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. OpenSearchServiceServerless / Client / list_security_policies list_security_policies ********************** OpenSearchServiceServerless.Client.list_security_policies(**kwargs) Returns information about configured OpenSearch Serverless security policies. See also: AWS API Documentation **Request Syntax** response = client.list_security_policies( type='encryption'|'network', resource=[ 'string', ], nextToken='string', maxResults=123 ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of policy. * **resource** (*list*) -- Resource filters (can be collection or indexes) that policies can apply to. * *(string) --* * **nextToken** (*string*) -- If your initial "ListSecurityPolicies" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListSecurityPolicies" operations, which returns results in the next page. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. The default is 20. Return type: dict Returns: **Response Syntax** { 'securityPolicySummaries': [ { 'type': 'encryption'|'network', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'createdDate': 123, 'lastModifiedDate': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **securityPolicySummaries** *(list) --* Details about the security policies in your account. * *(dict) --* A summary of a security policy for OpenSearch Serverless. * **type** *(string) --* The type of security policy. * **name** *(string) --* The name of the policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the security policy. * **createdDate** *(integer) --* The date the policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the policy was last modified. * **nextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / can_paginate can_paginate ************ OpenSearchServiceServerless.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. OpenSearchServiceServerless / Client / batch_get_lifecycle_policy batch_get_lifecycle_policy ************************** OpenSearchServiceServerless.Client.batch_get_lifecycle_policy(**kwargs) Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies. See also: AWS API Documentation **Request Syntax** response = client.batch_get_lifecycle_policy( identifiers=[ { 'type': 'retention', 'name': 'string' }, ] ) Parameters: **identifiers** (*list*) -- **[REQUIRED]** The unique identifiers of policy types and policy names. * *(dict) --* The unique identifiers of policy types and policy names. * **type** *(string) --* **[REQUIRED]** The type of lifecycle policy. * **name** *(string) --* **[REQUIRED]** The name of the lifecycle policy. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicyDetails': [ { 'type': 'retention', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 }, ], 'lifecyclePolicyErrorDetails': [ { 'type': 'retention', 'name': 'string', 'errorMessage': 'string', 'errorCode': 'string' }, ] } **Response Structure** * *(dict) --* * **lifecyclePolicyDetails** *(list) --* A list of lifecycle policies matched to the input policy name and policy type. * *(dict) --* Details about an OpenSearch Serverless lifecycle policy. * **type** *(string) --* The type of lifecycle policy. * **name** *(string) --* The name of the lifecycle policy. * **policyVersion** *(string) --* The version of the lifecycle policy. * **description** *(string) --* The description of the lifecycle policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the lifecycle policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the lifecycle policy was last modified. * **lifecyclePolicyErrorDetails** *(list) --* A list of lifecycle policy names and policy types for which retrieval failed. * *(dict) --* Error information for an OpenSearch Serverless request. * **type** *(string) --* The type of lifecycle policy. * **name** *(string) --* The name of the lifecycle policy. * **errorMessage** *(string) --* A description of the error. For example, "The specified Lifecycle Policy is not found". * **errorCode** *(string) --* The error code for the request. For example, "NOT_FOUND". **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / list_lifecycle_policies list_lifecycle_policies *********************** OpenSearchServiceServerless.Client.list_lifecycle_policies(**kwargs) Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies. See also: AWS API Documentation **Request Syntax** response = client.list_lifecycle_policies( type='retention', resources=[ 'string', ], nextToken='string', maxResults=123 ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of lifecycle policy. * **resources** (*list*) -- Resource filters that policies can apply to. Currently, the only supported resource type is "index". * *(string) --* * **nextToken** (*string*) -- If your initial "ListLifecyclePolicies" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListLifecyclePolicies" operations, which returns results in the next page. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use use "nextToken" to get the next page of results. The default is 10. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicySummaries': [ { 'type': 'retention', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'createdDate': 123, 'lastModifiedDate': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **lifecyclePolicySummaries** *(list) --* Details about the requested lifecycle policies. * *(dict) --* A summary of the lifecycle policy. * **type** *(string) --* The type of lifecycle policy. * **name** *(string) --* The name of the lifecycle policy. * **policyVersion** *(string) --* The version of the lifecycle policy. * **description** *(string) --* The description of the lifecycle policy. * **createdDate** *(integer) --* The Epoch time when the lifecycle policy was created. * **lastModifiedDate** *(integer) --* The date and time when the lifecycle policy was last modified. * **nextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / update_collection update_collection ***************** OpenSearchServiceServerless.Client.update_collection(**kwargs) Updates an OpenSearch Serverless collection. See also: AWS API Documentation **Request Syntax** response = client.update_collection( id='string', description='string', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier of the collection. * **description** (*string*) -- A description of the collection. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'updateCollectionDetail': { 'id': 'string', 'name': 'string', 'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED', 'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH', 'description': 'string', 'arn': 'string', 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **updateCollectionDetail** *(dict) --* Details about the updated collection. * **id** *(string) --* The unique identifier of the collection. * **name** *(string) --* The name of the collection. * **status** *(string) --* The current status of the collection. * **type** *(string) --* The collection type. * **description** *(string) --* The description of the collection. * **arn** *(string) --* The Amazon Resource Name (ARN) of the collection. * **createdDate** *(integer) --* The date and time when the collection was created. * **lastModifiedDate** *(integer) --* The date and time when the collection was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / get_account_settings get_account_settings ******************** OpenSearchServiceServerless.Client.get_account_settings() Returns account-level settings related to OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.get_account_settings() Return type: dict Returns: **Response Syntax** { 'accountSettingsDetail': { 'capacityLimits': { 'maxIndexingCapacityInOCU': 123, 'maxSearchCapacityInOCU': 123 } } } **Response Structure** * *(dict) --* * **accountSettingsDetail** *(dict) --* OpenSearch Serverless-related details for the current account. * **capacityLimits** *(dict) --* The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless. * **maxIndexingCapacityInOCU** *(integer) --* The maximum indexing capacity for collections. * **maxSearchCapacityInOCU** *(integer) --* The maximum search capacity for collections. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / delete_vpc_endpoint delete_vpc_endpoint ******************* OpenSearchServiceServerless.Client.delete_vpc_endpoint(**kwargs) Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_endpoint( id='string', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The VPC endpoint identifier. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'deleteVpcEndpointDetail': { 'id': 'string', 'name': 'string', 'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED' } } **Response Structure** * *(dict) --* * **deleteVpcEndpointDetail** *(dict) --* Details about the deleted endpoint. * **id** *(string) --* The unique identifier of the endpoint. * **name** *(string) --* The name of the endpoint. * **status** *(string) --* The current status of the endpoint deletion process. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / update_account_settings update_account_settings *********************** OpenSearchServiceServerless.Client.update_account_settings(**kwargs) Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.update_account_settings( capacityLimits={ 'maxIndexingCapacityInOCU': 123, 'maxSearchCapacityInOCU': 123 } ) Parameters: **capacityLimits** (*dict*) -- The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless. * **maxIndexingCapacityInOCU** *(integer) --* The maximum indexing capacity for collections. * **maxSearchCapacityInOCU** *(integer) --* The maximum search capacity for collections. Return type: dict Returns: **Response Syntax** { 'accountSettingsDetail': { 'capacityLimits': { 'maxIndexingCapacityInOCU': 123, 'maxSearchCapacityInOCU': 123 } } } **Response Structure** * *(dict) --* * **accountSettingsDetail** *(dict) --* OpenSearch Serverless-related settings for the current Amazon Web Services account. * **capacityLimits** *(dict) --* The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless. * **maxIndexingCapacityInOCU** *(integer) --* The maximum indexing capacity for collections. * **maxSearchCapacityInOCU** *(integer) --* The maximum search capacity for collections. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / delete_index delete_index ************ OpenSearchServiceServerless.Client.delete_index(**kwargs) Deletes an index from an OpenSearch Serverless collection. Be aware that the index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment. See also: AWS API Documentation **Request Syntax** response = client.delete_index( id='string', indexName='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier of the collection containing the index to delete. * **indexName** (*string*) -- **[REQUIRED]** The name of the index to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / list_tags_for_resource list_tags_for_resource ********************** OpenSearchServiceServerless.Client.list_tags_for_resource(**kwargs) Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the "DELETING" state), and must be owned by the account ID included in the request. Return type: dict Returns: **Response Syntax** { 'tags': [ { 'key': 'string', 'value': 'string' }, ] } **Response Structure** * *(dict) --* * **tags** *(list) --* The tags associated with the resource. * *(dict) --* A map of key-value pairs associated to an OpenSearch Serverless resource. * **key** *(string) --* The key to use in the tag. * **value** *(string) --* The value of the tag. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / untag_resource untag_resource ************** OpenSearchServiceServerless.Client.untag_resource(**kwargs) Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the "DELETING" state), and must be owned by the account ID included in the request. * **tagKeys** (*list*) -- **[REQUIRED]** The tag or set of tags to remove from the resource. All tag keys in the request must be unique. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / get_waiter get_waiter ********** OpenSearchServiceServerless.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" OpenSearchServiceServerless / Client / get_policies_stats get_policies_stats ****************** OpenSearchServiceServerless.Client.get_policies_stats() Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies. See also: AWS API Documentation **Request Syntax** response = client.get_policies_stats() Return type: dict Returns: **Response Syntax** { 'AccessPolicyStats': { 'DataPolicyCount': 123 }, 'SecurityPolicyStats': { 'EncryptionPolicyCount': 123, 'NetworkPolicyCount': 123 }, 'SecurityConfigStats': { 'SamlConfigCount': 123 }, 'LifecyclePolicyStats': { 'RetentionPolicyCount': 123 }, 'TotalPolicyCount': 123 } **Response Structure** * *(dict) --* * **AccessPolicyStats** *(dict) --* Information about the data access policies in your account. * **DataPolicyCount** *(integer) --* The number of data access policies in the current account. * **SecurityPolicyStats** *(dict) --* Information about the security policies in your account. * **EncryptionPolicyCount** *(integer) --* The number of encryption policies in the current account. * **NetworkPolicyCount** *(integer) --* The number of network policies in the current account. * **SecurityConfigStats** *(dict) --* Information about the security configurations in your account. * **SamlConfigCount** *(integer) --* The number of security configurations in the current account. * **LifecyclePolicyStats** *(dict) --* Information about the lifecycle policies in your account. * **RetentionPolicyCount** *(integer) --* The number of retention lifecycle policies in the current account. * **TotalPolicyCount** *(integer) --* The total number of OpenSearch Serverless security policies and configurations in your account. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" OpenSearchServiceServerless / Client / list_collections list_collections **************** OpenSearchServiceServerless.Client.list_collections(**kwargs) Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections. Note: Make sure to include an empty request body {} if you don't include any collection filters in the request. See also: AWS API Documentation **Request Syntax** response = client.list_collections( collectionFilters={ 'name': 'string', 'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED' }, nextToken='string', maxResults=123 ) Parameters: * **collectionFilters** (*dict*) -- A list of filter names and values that you can use for requests. * **name** *(string) --* The name of the collection. * **status** *(string) --* The current status of the collection. * **nextToken** (*string*) -- If your initial "ListCollections" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListCollections" operations, which returns results in the next page. * **maxResults** (*integer*) -- The maximum number of results to return. Default is 20. You can use "nextToken" to get the next page of results. Return type: dict Returns: **Response Syntax** { 'collectionSummaries': [ { 'id': 'string', 'name': 'string', 'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED', 'arn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **collectionSummaries** *(list) --* Details about each collection. * *(dict) --* Details about each OpenSearch Serverless collection. * **id** *(string) --* The unique identifier of the collection. * **name** *(string) --* The name of the collection. * **status** *(string) --* The current status of the collection. * **arn** *(string) --* The Amazon Resource Name (ARN) of the collection. * **nextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / create_access_policy create_access_policy ******************** OpenSearchServiceServerless.Client.create_access_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_access_policy( type='data', name='string', description='string', policy='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy. * **description** (*string*) -- A description of the policy. Typically used to store information about the permissions defined in the policy. * **policy** (*string*) -- **[REQUIRED]** The JSON policy document to use as the content for the policy. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'accessPolicyDetail': { 'type': 'data', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **accessPolicyDetail** *(dict) --* Details about the created access policy. * **type** *(string) --* The type of access policy. * **name** *(string) --* The name of the policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / batch_get_vpc_endpoint batch_get_vpc_endpoint ********************** OpenSearchServiceServerless.Client.batch_get_vpc_endpoint(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_get_vpc_endpoint( ids=[ 'string', ] ) Parameters: **ids** (*list*) -- **[REQUIRED]** A list of VPC endpoint identifiers. * *(string) --* Return type: dict Returns: **Response Syntax** { 'vpcEndpointDetails': [ { 'id': 'string', 'name': 'string', 'vpcId': 'string', 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ], 'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED', 'createdDate': 123, 'failureCode': 'string', 'failureMessage': 'string' }, ], 'vpcEndpointErrorDetails': [ { 'id': 'string', 'errorMessage': 'string', 'errorCode': 'string' }, ] } **Response Structure** * *(dict) --* * **vpcEndpointDetails** *(list) --* Details about the specified VPC endpoint. * *(dict) --* Details about an OpenSearch Serverless-managed interface endpoint. * **id** *(string) --* The unique identifier of the endpoint. * **name** *(string) --* The name of the endpoint. * **vpcId** *(string) --* The ID of the VPC from which you access OpenSearch Serverless. * **subnetIds** *(list) --* The ID of the subnets from which you access OpenSearch Serverless. * *(string) --* * **securityGroupIds** *(list) --* The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. * *(string) --* * **status** *(string) --* The current status of the endpoint. * **createdDate** *(integer) --* The date the endpoint was created. * **failureCode** *(string) --* A failure code associated with the request. * **failureMessage** *(string) --* A message associated with the failure code. * **vpcEndpointErrorDetails** *(list) --* Error information for a failed request. * *(dict) --* Error information for a failed "BatchGetVpcEndpoint" request. * **id** *(string) --* The unique identifier of the VPC endpoint. * **errorMessage** *(string) --* An error message describing the reason for the failure. * **errorCode** *(string) --* The error code for the failed request. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / list_vpc_endpoints list_vpc_endpoints ****************** OpenSearchServiceServerless.Client.list_vpc_endpoints(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_vpc_endpoints( vpcEndpointFilters={ 'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED' }, nextToken='string', maxResults=123 ) Parameters: * **vpcEndpointFilters** (*dict*) -- Filter the results according to the current status of the VPC endpoint. Possible statuses are "CREATING", "DELETING", "UPDATING", "ACTIVE", and "FAILED". * **status** *(string) --* The current status of the endpoint. * **nextToken** (*string*) -- If your initial "ListVpcEndpoints" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListVpcEndpoints" operations, which returns results in the next page. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. The default is 20. Return type: dict Returns: **Response Syntax** { 'vpcEndpointSummaries': [ { 'id': 'string', 'name': 'string', 'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **vpcEndpointSummaries** *(list) --* Details about each VPC endpoint, including the name and current status. * *(dict) --* The VPC endpoint object. * **id** *(string) --* The unique identifier of the endpoint. * **name** *(string) --* The name of the endpoint. * **status** *(string) --* The current status of the endpoint. * **nextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / get_access_policy get_access_policy ***************** OpenSearchServiceServerless.Client.get_access_policy(**kwargs) Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.get_access_policy( type='data', name='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** Tye type of policy. Currently, the only supported value is "data". * **name** (*string*) -- **[REQUIRED]** The name of the access policy. Return type: dict Returns: **Response Syntax** { 'accessPolicyDetail': { 'type': 'data', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **accessPolicyDetail** *(dict) --* Details about the requested access policy. * **type** *(string) --* The type of access policy. * **name** *(string) --* The name of the policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / list_access_policies list_access_policies ******************** OpenSearchServiceServerless.Client.list_access_policies(**kwargs) Returns information about a list of OpenSearch Serverless access policies. See also: AWS API Documentation **Request Syntax** response = client.list_access_policies( type='data', resource=[ 'string', ], nextToken='string', maxResults=123 ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of access policy. * **resource** (*list*) -- Resource filters (can be collections or indexes) that policies can apply to. * *(string) --* * **nextToken** (*string*) -- If your initial "ListAccessPolicies" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListAccessPolicies" operations, which returns results in the next page. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. The default is 20. Return type: dict Returns: **Response Syntax** { 'accessPolicySummaries': [ { 'type': 'data', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'createdDate': 123, 'lastModifiedDate': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **accessPolicySummaries** *(list) --* Details about the requested access policies. * *(dict) --* A summary of the data access policy. * **type** *(string) --* The type of access policy. Currently, the only available type is "data". * **name** *(string) --* The name of the access policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the access policy. * **createdDate** *(integer) --* The Epoch time when the access policy was created. * **lastModifiedDate** *(integer) --* The date and time when the collection was last modified. * **nextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / update_security_policy update_security_policy ********************** OpenSearchServiceServerless.Client.update_security_policy(**kwargs) Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.update_security_policy( type='encryption'|'network', name='string', policyVersion='string', description='string', policy='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of access policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy. * **policyVersion** (*string*) -- **[REQUIRED]** The version of the policy being updated. * **description** (*string*) -- A description of the policy. Typically used to store information about the permissions defined in the policy. * **policy** (*string*) -- The JSON policy document to use as the content for the new policy. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'securityPolicyDetail': { 'type': 'encryption'|'network', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **securityPolicyDetail** *(dict) --* Details about the updated security policy. * **type** *(string) --* The type of security policy. * **name** *(string) --* The name of the policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the security policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / create_security_config create_security_config ********************** OpenSearchServiceServerless.Client.create_security_config(**kwargs) Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.create_security_config( type='saml'|'iamidentitycenter'|'iamfederation', name='string', description='string', samlOptions={ 'metadata': 'string', 'userAttribute': 'string', 'groupAttribute': 'string', 'openSearchServerlessEntityId': 'string', 'sessionTimeout': 123 }, iamIdentityCenterOptions={ 'instanceArn': 'string', 'userAttribute': 'UserId'|'UserName'|'Email', 'groupAttribute': 'GroupId'|'GroupName' }, iamFederationOptions={ 'groupAttribute': 'string', 'userAttribute': 'string' }, clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of security configuration. * **name** (*string*) -- **[REQUIRED]** The name of the security configuration. * **description** (*string*) -- A description of the security configuration. * **samlOptions** (*dict*) -- Describes SAML options in in the form of a key-value map. This field is required if you specify "SAML" for the "type" parameter. * **metadata** *(string) --* **[REQUIRED]** The XML IdP metadata file generated from your identity provider. * **userAttribute** *(string) --* A user attribute for this SAML integration. * **groupAttribute** *(string) --* The group attribute for this SAML integration. * **openSearchServerlessEntityId** *(string) --* Custom entity ID attribute to override the default entity ID for this SAML integration. * **sessionTimeout** *(integer) --* The session timeout, in minutes. Default is 60 minutes (12 hours). * **iamIdentityCenterOptions** (*dict*) -- Describes IAM Identity Center options in the form of a key- value map. This field is required if you specify iamidentitycenter for the type parameter. * **instanceArn** *(string) --* **[REQUIRED]** The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless. * **userAttribute** *(string) --* The user attribute for this IAM Identity Center integration. Defaults to "UserId". * **groupAttribute** *(string) --* The group attribute for this IAM Identity Center integration. Defaults to "GroupId". * **iamFederationOptions** (*dict*) -- Describes IAM federation options in the form of a key-value map. This field is required if you specify "iamFederation" for the "type" parameter. * **groupAttribute** *(string) --* The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions. * **userAttribute** *(string) --* The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'securityConfigDetail': { 'id': 'string', 'type': 'saml'|'iamidentitycenter'|'iamfederation', 'configVersion': 'string', 'description': 'string', 'samlOptions': { 'metadata': 'string', 'userAttribute': 'string', 'groupAttribute': 'string', 'openSearchServerlessEntityId': 'string', 'sessionTimeout': 123 }, 'iamIdentityCenterOptions': { 'instanceArn': 'string', 'applicationArn': 'string', 'applicationName': 'string', 'applicationDescription': 'string', 'userAttribute': 'UserId'|'UserName'|'Email', 'groupAttribute': 'GroupId'|'GroupName' }, 'iamFederationOptions': { 'groupAttribute': 'string', 'userAttribute': 'string' }, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **securityConfigDetail** *(dict) --* Details about the created security configuration. * **id** *(string) --* The unique identifier of the security configuration. * **type** *(string) --* The type of security configuration. * **configVersion** *(string) --* The version of the security configuration. * **description** *(string) --* The description of the security configuration. * **samlOptions** *(dict) --* SAML options for the security configuration in the form of a key-value map. * **metadata** *(string) --* The XML IdP metadata file generated from your identity provider. * **userAttribute** *(string) --* A user attribute for this SAML integration. * **groupAttribute** *(string) --* The group attribute for this SAML integration. * **openSearchServerlessEntityId** *(string) --* Custom entity ID attribute to override the default entity ID for this SAML integration. * **sessionTimeout** *(integer) --* The session timeout, in minutes. Default is 60 minutes (12 hours). * **iamIdentityCenterOptions** *(dict) --* Describes IAM Identity Center options in the form of a key-value map. * **instanceArn** *(string) --* The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless. * **applicationArn** *(string) --* The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **applicationName** *(string) --* The name of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **applicationDescription** *(string) --* The description of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **userAttribute** *(string) --* The user attribute for this IAM Identity Center integration. Defaults to "UserId" * **groupAttribute** *(string) --* The group attribute for this IAM Identity Center integration. Defaults to "GroupId". * **iamFederationOptions** *(dict) --* Describes IAM federation options in the form of a key- value map. Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation. * **groupAttribute** *(string) --* The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions. * **userAttribute** *(string) --* The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process. * **createdDate** *(integer) --* The date the configuration was created. * **lastModifiedDate** *(integer) --* The timestamp of when the configuration was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / delete_lifecycle_policy delete_lifecycle_policy *********************** OpenSearchServiceServerless.Client.delete_lifecycle_policy(**kwargs) Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies. See also: AWS API Documentation **Request Syntax** response = client.delete_lifecycle_policy( type='retention', name='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of lifecycle policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy to delete. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / get_index get_index ********* OpenSearchServiceServerless.Client.get_index(**kwargs) Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment. See also: AWS API Documentation **Request Syntax** response = client.get_index( id='string', indexName='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier of the collection containing the index. * **indexName** (*string*) -- **[REQUIRED]** The name of the index to retrieve information about. Return type: dict Returns: **Response Syntax** { 'indexSchema': {...}|[...]|123|123.4|'string'|True|None } **Response Structure** * *(dict) --* * **indexSchema** (*document*) -- The JSON schema definition for the index, including field mappings and settings. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / create_index create_index ************ OpenSearchServiceServerless.Client.create_index(**kwargs) Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment in the *OpenSearch User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_index( id='string', indexName='string', indexSchema={...}|[...]|123|123.4|'string'|True|None ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier of the collection in which to create the index. * **indexName** (*string*) -- **[REQUIRED]** The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-). * **indexSchema** (*document*) -- The JSON schema definition for the index, including field mappings and settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / update_vpc_endpoint update_vpc_endpoint ******************* OpenSearchServiceServerless.Client.update_vpc_endpoint(**kwargs) Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint. See also: AWS API Documentation **Request Syntax** response = client.update_vpc_endpoint( id='string', addSubnetIds=[ 'string', ], removeSubnetIds=[ 'string', ], addSecurityGroupIds=[ 'string', ], removeSecurityGroupIds=[ 'string', ], clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier of the interface endpoint to update. * **addSubnetIds** (*list*) -- The ID of one or more subnets to add to the endpoint. * *(string) --* * **removeSubnetIds** (*list*) -- The unique identifiers of the subnets to remove from the endpoint. * *(string) --* * **addSecurityGroupIds** (*list*) -- The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. * *(string) --* * **removeSecurityGroupIds** (*list*) -- The unique identifiers of the security groups to remove from the endpoint. * *(string) --* * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'UpdateVpcEndpointDetail': { 'id': 'string', 'name': 'string', 'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED', 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ], 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **UpdateVpcEndpointDetail** *(dict) --* Details about the updated VPC endpoint. * **id** *(string) --* The unique identifier of the endpoint. * **name** *(string) --* The name of the endpoint. * **status** *(string) --* The current status of the endpoint update process. * **subnetIds** *(list) --* The ID of the subnets from which you access OpenSearch Serverless. * *(string) --* * **securityGroupIds** *(list) --* The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. * *(string) --* * **lastModifiedDate** *(integer) --* The timestamp of when the endpoint was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / close close ***** OpenSearchServiceServerless.Client.close() Closes underlying endpoint connections. OpenSearchServiceServerless / Client / delete_security_config delete_security_config ********************** OpenSearchServiceServerless.Client.delete_security_config(**kwargs) Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.delete_security_config( id='string', clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The security configuration identifier. For SAML the ID will be "saml//". For example, "saml/123456789123/OKTADev". * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / get_security_policy get_security_policy ******************* OpenSearchServiceServerless.Client.get_security_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_security_policy( type='encryption'|'network', name='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of security policy. * **name** (*string*) -- **[REQUIRED]** The name of the security policy. Return type: dict Returns: **Response Syntax** { 'securityPolicyDetail': { 'type': 'encryption'|'network', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **securityPolicyDetail** *(dict) --* Details about the requested security policy. * **type** *(string) --* The type of security policy. * **name** *(string) --* The name of the policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the security policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / update_index update_index ************ OpenSearchServiceServerless.Client.update_index(**kwargs) Updates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or changing field mappings. You can also enable automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment. See also: AWS API Documentation **Request Syntax** response = client.update_index( id='string', indexName='string', indexSchema={...}|[...]|123|123.4|'string'|True|None ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier of the collection containing the index to update. * **indexName** (*string*) -- **[REQUIRED]** The name of the index to update. * **indexSchema** (*document*) -- The updated JSON schema definition for the index, including field mappings and settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / create_security_policy create_security_policy ********************** OpenSearchServiceServerless.Client.create_security_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_security_policy( type='encryption'|'network', name='string', description='string', policy='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of security policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy. * **description** (*string*) -- A description of the policy. Typically used to store information about the permissions defined in the policy. * **policy** (*string*) -- **[REQUIRED]** The JSON policy document to use as the content for the new policy. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'securityPolicyDetail': { 'type': 'encryption'|'network', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **securityPolicyDetail** *(dict) --* Details about the created security policy. * **type** *(string) --* The type of security policy. * **name** *(string) --* The name of the policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the security policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / batch_get_collection batch_get_collection ******************** OpenSearchServiceServerless.Client.batch_get_collection(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_get_collection( ids=[ 'string', ], names=[ 'string', ] ) Parameters: * **ids** (*list*) -- A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API. * *(string) --* * **names** (*list*) -- A list of collection names. You can't provide names and IDs in the same request. * *(string) --* Return type: dict Returns: **Response Syntax** { 'collectionDetails': [ { 'id': 'string', 'name': 'string', 'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED', 'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH', 'description': 'string', 'arn': 'string', 'kmsKeyArn': 'string', 'standbyReplicas': 'ENABLED'|'DISABLED', 'createdDate': 123, 'lastModifiedDate': 123, 'collectionEndpoint': 'string', 'dashboardEndpoint': 'string', 'failureCode': 'string', 'failureMessage': 'string' }, ], 'collectionErrorDetails': [ { 'id': 'string', 'name': 'string', 'errorMessage': 'string', 'errorCode': 'string' }, ] } **Response Structure** * *(dict) --* * **collectionDetails** *(list) --* Details about each collection. * *(dict) --* Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint. * **id** *(string) --* A unique identifier for the collection. * **name** *(string) --* The name of the collection. * **status** *(string) --* The current status of the collection. * **type** *(string) --* The type of collection. * **description** *(string) --* A description of the collection. * **arn** *(string) --* The Amazon Resource Name (ARN) of the collection. * **kmsKeyArn** *(string) --* The ARN of the Amazon Web Services KMS key used to encrypt the collection. * **standbyReplicas** *(string) --* Details about an OpenSearch Serverless collection. * **createdDate** *(integer) --* The Epoch time when the collection was created. * **lastModifiedDate** *(integer) --* The date and time when the collection was last modified. * **collectionEndpoint** *(string) --* Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. * **dashboardEndpoint** *(string) --* Collection-specific endpoint used to access OpenSearch Dashboards. * **failureCode** *(string) --* A failure code associated with the request. * **failureMessage** *(string) --* A message associated with the failure code. * **collectionErrorDetails** *(list) --* Error information for the request. * *(dict) --* Error information for an OpenSearch Serverless request. * **id** *(string) --* If the request contains collection IDs, the response includes the IDs provided in the request. * **name** *(string) --* If the request contains collection names, the response includes the names provided in the request. * **errorMessage** *(string) --* A description of the error. For example, "The specified Collection is not found." * **errorCode** *(string) --* The error code for the request. For example, "NOT_FOUND". **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / update_security_config update_security_config ********************** OpenSearchServiceServerless.Client.update_security_config(**kwargs) Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.update_security_config( id='string', configVersion='string', description='string', samlOptions={ 'metadata': 'string', 'userAttribute': 'string', 'groupAttribute': 'string', 'openSearchServerlessEntityId': 'string', 'sessionTimeout': 123 }, iamIdentityCenterOptionsUpdates={ 'userAttribute': 'UserId'|'UserName'|'Email', 'groupAttribute': 'GroupId'|'GroupName' }, iamFederationOptions={ 'groupAttribute': 'string', 'userAttribute': 'string' }, clientToken='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** The security configuration identifier. For SAML the ID will be "saml//". For example, "saml/123456789123/OKTADev". * **configVersion** (*string*) -- **[REQUIRED]** The version of the security configuration to be updated. You can find the most recent version of a security configuration using the "GetSecurityPolicy" command. * **description** (*string*) -- A description of the security configuration. * **samlOptions** (*dict*) -- SAML options in in the form of a key-value map. * **metadata** *(string) --* **[REQUIRED]** The XML IdP metadata file generated from your identity provider. * **userAttribute** *(string) --* A user attribute for this SAML integration. * **groupAttribute** *(string) --* The group attribute for this SAML integration. * **openSearchServerlessEntityId** *(string) --* Custom entity ID attribute to override the default entity ID for this SAML integration. * **sessionTimeout** *(integer) --* The session timeout, in minutes. Default is 60 minutes (12 hours). * **iamIdentityCenterOptionsUpdates** (*dict*) -- Describes IAM Identity Center options in the form of a key- value map. * **userAttribute** *(string) --* The user attribute for this IAM Identity Center integration. Defaults to "UserId". * **groupAttribute** *(string) --* The group attribute for this IAM Identity Center integration. Defaults to "GroupId". * **iamFederationOptions** (*dict*) -- Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration. * **groupAttribute** *(string) --* The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions. * **userAttribute** *(string) --* The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'securityConfigDetail': { 'id': 'string', 'type': 'saml'|'iamidentitycenter'|'iamfederation', 'configVersion': 'string', 'description': 'string', 'samlOptions': { 'metadata': 'string', 'userAttribute': 'string', 'groupAttribute': 'string', 'openSearchServerlessEntityId': 'string', 'sessionTimeout': 123 }, 'iamIdentityCenterOptions': { 'instanceArn': 'string', 'applicationArn': 'string', 'applicationName': 'string', 'applicationDescription': 'string', 'userAttribute': 'UserId'|'UserName'|'Email', 'groupAttribute': 'GroupId'|'GroupName' }, 'iamFederationOptions': { 'groupAttribute': 'string', 'userAttribute': 'string' }, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **securityConfigDetail** *(dict) --* Details about the updated security configuration. * **id** *(string) --* The unique identifier of the security configuration. * **type** *(string) --* The type of security configuration. * **configVersion** *(string) --* The version of the security configuration. * **description** *(string) --* The description of the security configuration. * **samlOptions** *(dict) --* SAML options for the security configuration in the form of a key-value map. * **metadata** *(string) --* The XML IdP metadata file generated from your identity provider. * **userAttribute** *(string) --* A user attribute for this SAML integration. * **groupAttribute** *(string) --* The group attribute for this SAML integration. * **openSearchServerlessEntityId** *(string) --* Custom entity ID attribute to override the default entity ID for this SAML integration. * **sessionTimeout** *(integer) --* The session timeout, in minutes. Default is 60 minutes (12 hours). * **iamIdentityCenterOptions** *(dict) --* Describes IAM Identity Center options in the form of a key-value map. * **instanceArn** *(string) --* The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless. * **applicationArn** *(string) --* The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **applicationName** *(string) --* The name of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **applicationDescription** *(string) --* The description of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **userAttribute** *(string) --* The user attribute for this IAM Identity Center integration. Defaults to "UserId" * **groupAttribute** *(string) --* The group attribute for this IAM Identity Center integration. Defaults to "GroupId". * **iamFederationOptions** *(dict) --* Describes IAM federation options in the form of a key- value map. Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation. * **groupAttribute** *(string) --* The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions. * **userAttribute** *(string) --* The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process. * **createdDate** *(integer) --* The date the configuration was created. * **lastModifiedDate** *(integer) --* The timestamp of when the configuration was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / delete_access_policy delete_access_policy ******************** OpenSearchServiceServerless.Client.delete_access_policy(**kwargs) Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.delete_access_policy( type='data', name='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy to delete. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / tag_resource tag_resource ************ OpenSearchServiceServerless.Client.tag_resource(**kwargs) Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the "DELETING" state), and must be owned by the account ID included in the request. * **tags** (*list*) -- **[REQUIRED]** A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique. * *(dict) --* A map of key-value pairs associated to an OpenSearch Serverless resource. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / get_security_config get_security_config ******************* OpenSearchServiceServerless.Client.get_security_config(**kwargs) Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.get_security_config( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The unique identifier of the security configuration. Return type: dict Returns: **Response Syntax** { 'securityConfigDetail': { 'id': 'string', 'type': 'saml'|'iamidentitycenter'|'iamfederation', 'configVersion': 'string', 'description': 'string', 'samlOptions': { 'metadata': 'string', 'userAttribute': 'string', 'groupAttribute': 'string', 'openSearchServerlessEntityId': 'string', 'sessionTimeout': 123 }, 'iamIdentityCenterOptions': { 'instanceArn': 'string', 'applicationArn': 'string', 'applicationName': 'string', 'applicationDescription': 'string', 'userAttribute': 'UserId'|'UserName'|'Email', 'groupAttribute': 'GroupId'|'GroupName' }, 'iamFederationOptions': { 'groupAttribute': 'string', 'userAttribute': 'string' }, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **securityConfigDetail** *(dict) --* Details of the requested security configuration. * **id** *(string) --* The unique identifier of the security configuration. * **type** *(string) --* The type of security configuration. * **configVersion** *(string) --* The version of the security configuration. * **description** *(string) --* The description of the security configuration. * **samlOptions** *(dict) --* SAML options for the security configuration in the form of a key-value map. * **metadata** *(string) --* The XML IdP metadata file generated from your identity provider. * **userAttribute** *(string) --* A user attribute for this SAML integration. * **groupAttribute** *(string) --* The group attribute for this SAML integration. * **openSearchServerlessEntityId** *(string) --* Custom entity ID attribute to override the default entity ID for this SAML integration. * **sessionTimeout** *(integer) --* The session timeout, in minutes. Default is 60 minutes (12 hours). * **iamIdentityCenterOptions** *(dict) --* Describes IAM Identity Center options in the form of a key-value map. * **instanceArn** *(string) --* The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless. * **applicationArn** *(string) --* The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **applicationName** *(string) --* The name of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **applicationDescription** *(string) --* The description of the IAM Identity Center application used to integrate with OpenSearch Serverless. * **userAttribute** *(string) --* The user attribute for this IAM Identity Center integration. Defaults to "UserId" * **groupAttribute** *(string) --* The group attribute for this IAM Identity Center integration. Defaults to "GroupId". * **iamFederationOptions** *(dict) --* Describes IAM federation options in the form of a key- value map. Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation. * **groupAttribute** *(string) --* The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions. * **userAttribute** *(string) --* The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process. * **createdDate** *(integer) --* The date the configuration was created. * **lastModifiedDate** *(integer) --* The timestamp of when the configuration was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / create_vpc_endpoint create_vpc_endpoint ******************* OpenSearchServiceServerless.Client.create_vpc_endpoint(**kwargs) Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint. See also: AWS API Documentation **Request Syntax** response = client.create_vpc_endpoint( name='string', vpcId='string', subnetIds=[ 'string', ], securityGroupIds=[ 'string', ], clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the interface endpoint. * **vpcId** (*string*) -- **[REQUIRED]** The ID of the VPC from which you'll access OpenSearch Serverless. * **subnetIds** (*list*) -- **[REQUIRED]** The ID of one or more subnets from which you'll access OpenSearch Serverless. * *(string) --* * **securityGroupIds** (*list*) -- The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. * *(string) --* * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'createVpcEndpointDetail': { 'id': 'string', 'name': 'string', 'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED' } } **Response Structure** * *(dict) --* * **createVpcEndpointDetail** *(dict) --* Details about the created interface VPC endpoint. * **id** *(string) --* The unique identifier of the endpoint. * **name** *(string) --* The name of the endpoint. * **status** *(string) --* The current status in the endpoint creation process. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / create_lifecycle_policy create_lifecycle_policy *********************** OpenSearchServiceServerless.Client.create_lifecycle_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_lifecycle_policy( type='retention', name='string', description='string', policy='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of lifecycle policy. * **name** (*string*) -- **[REQUIRED]** The name of the lifecycle policy. * **description** (*string*) -- A description of the lifecycle policy. * **policy** (*string*) -- **[REQUIRED]** The JSON policy document to use as the content for the lifecycle policy. * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicyDetail': { 'type': 'retention', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **lifecyclePolicyDetail** *(dict) --* Details about the created lifecycle policy. * **type** *(string) --* The type of lifecycle policy. * **name** *(string) --* The name of the lifecycle policy. * **policyVersion** *(string) --* The version of the lifecycle policy. * **description** *(string) --* The description of the lifecycle policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the lifecycle policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the lifecycle policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / update_access_policy update_access_policy ******************** OpenSearchServiceServerless.Client.update_access_policy(**kwargs) Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.update_access_policy( type='data', name='string', policyVersion='string', description='string', policy='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy. * **policyVersion** (*string*) -- **[REQUIRED]** The version of the policy being updated. * **description** (*string*) -- A description of the policy. Typically used to store information about the permissions defined in the policy. * **policy** (*string*) -- The JSON policy document to use as the content for the policy. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'accessPolicyDetail': { 'type': 'data', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **accessPolicyDetail** *(dict) --* Details about the updated access policy. * **type** *(string) --* The type of access policy. * **name** *(string) --* The name of the policy. * **policyVersion** *(string) --* The version of the policy. * **description** *(string) --* The description of the policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / list_security_configs list_security_configs ********************* OpenSearchServiceServerless.Client.list_security_configs(**kwargs) Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless. See also: AWS API Documentation **Request Syntax** response = client.list_security_configs( type='saml'|'iamidentitycenter'|'iamfederation', nextToken='string', maxResults=123 ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of security configuration. * **nextToken** (*string*) -- If your initial "ListSecurityConfigs" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListSecurityConfigs" operations, which returns results in the next page. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. The default is 20. Return type: dict Returns: **Response Syntax** { 'securityConfigSummaries': [ { 'id': 'string', 'type': 'saml'|'iamidentitycenter'|'iamfederation', 'configVersion': 'string', 'description': 'string', 'createdDate': 123, 'lastModifiedDate': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **securityConfigSummaries** *(list) --* Details about the security configurations in your account. * *(dict) --* A summary of a security configuration for OpenSearch Serverless. * **id** *(string) --* The unique identifier of the security configuration. * **type** *(string) --* The type of security configuration. * **configVersion** *(string) --* The version of the security configuration. * **description** *(string) --* The description of the security configuration. * **createdDate** *(integer) --* The Epoch time when the security configuration was created. * **lastModifiedDate** *(integer) --* The timestamp of when the configuration was last modified. * **nextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / update_lifecycle_policy update_lifecycle_policy *********************** OpenSearchServiceServerless.Client.update_lifecycle_policy(**kwargs) Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies. See also: AWS API Documentation **Request Syntax** response = client.update_lifecycle_policy( type='retention', name='string', policyVersion='string', description='string', policy='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of lifecycle policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy. * **policyVersion** (*string*) -- **[REQUIRED]** The version of the policy being updated. * **description** (*string*) -- A description of the lifecycle policy. * **policy** (*string*) -- The JSON policy document to use as the content for the lifecycle policy. * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'lifecyclePolicyDetail': { 'type': 'retention', 'name': 'string', 'policyVersion': 'string', 'description': 'string', 'policy': {...}|[...]|123|123.4|'string'|True|None, 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **lifecyclePolicyDetail** *(dict) --* Details about the updated lifecycle policy. * **type** *(string) --* The type of lifecycle policy. * **name** *(string) --* The name of the lifecycle policy. * **policyVersion** *(string) --* The version of the lifecycle policy. * **description** *(string) --* The description of the lifecycle policy. * **policy** (*document*) -- The JSON policy document without any whitespaces. * **createdDate** *(integer) --* The date the lifecycle policy was created. * **lastModifiedDate** *(integer) --* The timestamp of when the lifecycle policy was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / create_collection create_collection ***************** OpenSearchServiceServerless.Client.create_collection(**kwargs) Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections. See also: AWS API Documentation **Request Syntax** response = client.create_collection( name='string', type='SEARCH'|'TIMESERIES'|'VECTORSEARCH', description='string', tags=[ { 'key': 'string', 'value': 'string' }, ], standbyReplicas='ENABLED'|'DISABLED', clientToken='string' ) Parameters: * **name** (*string*) -- **[REQUIRED]** Name of the collection. * **type** (*string*) -- The type of collection. * **description** (*string*) -- Description of the collection. * **tags** (*list*) -- An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection. * *(dict) --* A map of key-value pairs associated to an OpenSearch Serverless resource. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. * **standbyReplicas** (*string*) -- Indicates whether standby replicas should be used for a collection. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'createCollectionDetail': { 'id': 'string', 'name': 'string', 'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED', 'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH', 'description': 'string', 'arn': 'string', 'kmsKeyArn': 'string', 'standbyReplicas': 'ENABLED'|'DISABLED', 'createdDate': 123, 'lastModifiedDate': 123 } } **Response Structure** * *(dict) --* * **createCollectionDetail** *(dict) --* Details about the collection. * **id** *(string) --* The unique identifier of the collection. * **name** *(string) --* The name of the collection. * **status** *(string) --* The current status of the collection. * **type** *(string) --* The type of collection. * **description** *(string) --* A description of the collection. * **arn** *(string) --* The Amazon Resource Name (ARN) of the collection. * **kmsKeyArn** *(string) --* The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection. * **standbyReplicas** *(string) --* Creates details about an OpenSearch Serverless collection. * **createdDate** *(integer) --* The Epoch time when the collection was created. * **lastModifiedDate** *(integer) --* The date and time when the collection was last modified. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.OcuLimitExceededE xception" * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" * "OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExcee dedException" OpenSearchServiceServerless / Client / delete_security_policy delete_security_policy ********************** OpenSearchServiceServerless.Client.delete_security_policy(**kwargs) Deletes an OpenSearch Serverless security policy. See also: AWS API Documentation **Request Syntax** response = client.delete_security_policy( type='encryption'|'network', name='string', clientToken='string' ) Parameters: * **type** (*string*) -- **[REQUIRED]** The type of policy. * **name** (*string*) -- **[REQUIRED]** The name of the policy to delete. * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundE xception" * "OpenSearchServiceServerless.Client.exceptions.ConflictException" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on" OpenSearchServiceServerless / Client / batch_get_effective_lifecycle_policy batch_get_effective_lifecycle_policy ************************************ OpenSearchServiceServerless.Client.batch_get_effective_lifecycle_policy(**kwargs) Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies. See also: AWS API Documentation **Request Syntax** response = client.batch_get_effective_lifecycle_policy( resourceIdentifiers=[ { 'type': 'retention', 'resource': 'string' }, ] ) Parameters: **resourceIdentifiers** (*list*) -- **[REQUIRED]** The unique identifiers of policy types and resource names. * *(dict) --* The unique identifiers of policy types and resource names. * **type** *(string) --* **[REQUIRED]** The type of lifecycle policy. * **resource** *(string) --* **[REQUIRED]** The name of the OpenSearch Serverless ilndex resource. Return type: dict Returns: **Response Syntax** { 'effectiveLifecyclePolicyDetails': [ { 'type': 'retention', 'resource': 'string', 'policyName': 'string', 'resourceType': 'index', 'retentionPeriod': 'string', 'noMinRetentionPeriod': True|False }, ], 'effectiveLifecyclePolicyErrorDetails': [ { 'type': 'retention', 'resource': 'string', 'errorMessage': 'string', 'errorCode': 'string' }, ] } **Response Structure** * *(dict) --* * **effectiveLifecyclePolicyDetails** *(list) --* A list of lifecycle policies applied to the OpenSearch Serverless indexes. * *(dict) --* Error information for an OpenSearch Serverless request. * **type** *(string) --* The type of lifecycle policy. * **resource** *(string) --* The name of the OpenSearch Serverless index resource. * **policyName** *(string) --* The name of the lifecycle policy. * **resourceType** *(string) --* The type of OpenSearch Serverless resource. Currently, the only supported resource is "index". * **retentionPeriod** *(string) --* The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set. * **noMinRetentionPeriod** *(boolean) --* The minimum number of index retention days set. That is an optional param that will return as "true" if the minimum number of days or hours is not set to a index resource. * **effectiveLifecyclePolicyErrorDetails** *(list) --* A list of resources for which retrieval failed. * *(dict) --* Error information for an OpenSearch Serverless request. * **type** *(string) --* The type of lifecycle policy. * **resource** *(string) --* The name of OpenSearch Serverless index resource. * **errorMessage** *(string) --* A description of the error. For example, "The specified Index resource is not found". * **errorCode** *(string) --* The error code for the request. **Exceptions** * "OpenSearchServiceServerless.Client.exceptions.InternalServerExc eption" * "OpenSearchServiceServerless.Client.exceptions.ValidationExcepti on"