SSM / Paginator / GetResourcePolicies

GetResourcePolicies#

class SSM.Paginator.GetResourcePolicies#

paginator = client.get_paginator('get_resource_policies')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

ResourceArn (string) –
[REQUIRED]

Amazon Resource Name (ARN) of the resource to which the policies are attached.
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

{
    'Policies': [
        {
            'PolicyId': 'string',
            'PolicyHash': 'string',
            'Policy': 'string'
        },
    ]
}

Response Structure

(dict) –
- Policies (list) –
  
  An array of the Policy object.
  - (dict) –
    
    A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
    - PolicyId (string) –
      
      A policy ID.
    - PolicyHash (string) –
      
      ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.
    - Policy (string) –
      
      A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).