MultipartyApproval / Client / list_policies

list_policies

MultipartyApproval.Client.list_policies(**kwargs)

Returns a list of policies. Policies define the permissions for team resources.

The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_policies(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • NextToken (string) – If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Policies': [
        {
            'Arn': 'string',
            'DefaultVersion': 123,
            'PolicyType': 'AWS_MANAGED'|'AWS_RAM',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

    • Policies (list) –

      An array of Policy objects. Contains a list of policies that define the permissions for team resources.

      The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.

      • (dict) –

        Contains details for a policy. Policies define what operations a team that define the permissions for team resources.

        The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.

        • Arn (string) –

          Amazon Resource Name (ARN) for the policy.

        • DefaultVersion (integer) –

          Determines if the specified policy is the default for the team.

        • PolicyType (string) –

          The type of policy.

        • Name (string) –

          Name of the policy.

Exceptions