SecretsManager / Paginator / ListResourcePolicies

ListResourcePolicies¶

class SecretsManager.Paginator.ListResourcePolicies¶

paginator = client.get_paginator('list_resource_policies')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SecretsManager.Client.list_resource_policies().

Request Syntax

response_iterator = paginator.paginate(
    SecretId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

SecretId (string) –
[REQUIRED]

The ARN or name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ResourcePolicies': [
        {
            'PolicyName': 'string'
        },
    ],

}

Response Structure

(dict) –
- ResourcePolicies (list) –
  
  A list of the resource policies attached to the secret.
  - (dict) –
    
    A structure that contains details about a resource policy attached to a secret. It does not contain the contents of the resource policy. To view the contents of the policy, use GetResourcePolicy .
    - PolicyName (string) –
      
      The name of the resource policy.