create_access_policy

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(
    clientToken='string',
    description='string',
    name='string',
    policy='string',
    type='data'
)

Parameters

• clientToken (string) --

  Unique, case-sensitive identifier to ensure idempotency of the request.

  This field is autopopulated if not provided.

• description (string) -- A description of the policy. Typically used to store information about the permissions defined in the policy.
• name (string) --

  [REQUIRED]

  The name of the policy.

• policy (string) --

  [REQUIRED]

  The JSON policy document to use as the content for the policy.

• type (string) --

  [REQUIRED]

  The type of policy.

Return type

dict

Returns

Response Syntax

{
    'accessPolicyDetail': {
        'createdDate': 123,
        'description': 'string',
        'lastModifiedDate': 123,
        'name': 'string',
        'policy': {...}|[...]|123|123.4|'string'|True|None,
        'policyVersion': 'string',
        'type': 'data'
    }
}

Response Structure

• (dict) --

  • accessPolicyDetail (dict) --

    Details about the created access policy.

    • createdDate (integer) --

      The date the policy was created.

    • description (string) --

      The description of the policy.

    • lastModifiedDate (integer) --

      The timestamp of when the policy was last modified.

    • name (string) --

      The name of the policy.

    • policy (document) --

      The JSON policy document without any whitespaces.

    • policyVersion (string) --

      The version of the policy.

    • type (string) --

      The type of access policy.

Exceptions

• OpenSearchServiceServerless.Client.exceptions.InternalServerException
• OpenSearchServiceServerless.Client.exceptions.ConflictException
• OpenSearchServiceServerless.Client.exceptions.ValidationException