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