SSMIncidents / Paginator / GetResourcePolicies

GetResourcePolicies#

class SSMIncidents.Paginator.GetResourcePolicies#
paginator = client.get_paginator('get_resource_policies')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SSMIncidents.Client.get_resource_policies().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • resourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the response plan with the attached resource policy.

  • 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': [
        {
            'policyDocument': 'string',
            'policyId': 'string',
            'ramResourceShareRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • resourcePolicies (list) –

      Details about the resource policy attached to the response plan.

      • (dict) –

        The resource policy that allows Incident Manager to perform actions on resources on your behalf.

        • policyDocument (string) –

          The JSON blob that describes the policy.

        • policyId (string) –

          The ID of the resource policy.

        • ramResourceShareRegion (string) –

          The Amazon Web Services Region that policy allows resources to be used in.

    • NextToken (string) –

      A token to resume pagination.