MultipartyApproval / Paginator / ListApprovalTeams

ListApprovalTeams

class MultipartyApproval.Paginator.ListApprovalTeams

paginator = client.get_paginator('list_approval_teams')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MultipartyApproval.Client.list_approval_teams().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'ApprovalTeams': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'ApprovalStrategy': {
                'MofN': {
                    'MinApprovalsRequired': 123
                }
            },
            'NumberOfApprovers': 123,
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Status': 'ACTIVE'|'INACTIVE'|'DELETING'|'PENDING',
            'StatusCode': 'VALIDATING'|'PENDING_ACTIVATION'|'FAILED_VALIDATION'|'FAILED_ACTIVATION'|'UPDATE_PENDING_APPROVAL'|'UPDATE_PENDING_ACTIVATION'|'UPDATE_FAILED_APPROVAL'|'UPDATE_FAILED_ACTIVATION'|'UPDATE_FAILED_VALIDATION'|'DELETE_PENDING_APPROVAL'|'DELETE_FAILED_APPROVAL'|'DELETE_FAILED_VALIDATION',
            'StatusMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • ApprovalTeams (list) –

    An array of ListApprovalTeamsResponseApprovalTeam objects. Contains details for approval teams.

    • (dict) –

      Contains details for an approval team

      • CreationTime (datetime) –

        Timestamp when the team was created.

      • ApprovalStrategy (dict) –

        An ApprovalStrategyResponse object. Contains details for how an approval team grants approval.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: MofN. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • MofN (dict) –

          Minimum number of approvals (M) required for a total number of approvers (N).

          • MinApprovalsRequired (integer) –

            Minimum number of approvals (M) required for a total number of approvers (N).

      • NumberOfApprovers (integer) –

        Total number of approvers in the team.

      • Arn (string) –

        Amazon Resource Name (ARN) for the team.

      • Name (string) –

        Name of the team.

      • Description (string) –

        Description for the team.

      • Status (string) –

        Status for the team. For more information, see Team health in the Multi-party approval User Guide.

      • StatusCode (string) –

        Status code for the team. For more information, see Team health in the Multi-party approval User Guide.

      • StatusMessage (string) –

        Message describing the status for the team.