MultipartyApproval / Client / update_approval_team

update_approval_team

MultipartyApproval.Client.update_approval_team(**kwargs)

Updates an approval team. You can request to update the team description, approval threshold, and approvers in the team.

Note

Updates require team approval

Updates to an active team must be approved by the team.

See also: AWS API Documentation

Request Syntax

response = client.update_approval_team(
    ApprovalStrategy={
        'MofN': {
            'MinApprovalsRequired': 123
        }
    },
    Approvers=[
        {
            'PrimaryIdentityId': 'string',
            'PrimaryIdentitySourceArn': 'string'
        },
    ],
    Description='string',
    Arn='string'
)
Parameters:

  • ApprovalStrategy (dict) –

    An ApprovalStrategy object. Contains details for how the team grants approval.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: MofN.

    • MofN (dict) –

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

      • MinApprovalsRequired (integer) – [REQUIRED]

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

  • Approvers (list) –

    An array of ApprovalTeamRequestApprover objects. Contains details for the approvers in the team.

    • (dict) –

      Contains details for an approver.

      • PrimaryIdentityId (string) – [REQUIRED]

        ID for the user.

      • PrimaryIdentitySourceArn (string) – [REQUIRED]

        Amazon Resource Name (ARN) for the identity source. The identity source manages the user authentication for approvers.

  • Description (string) – Description for the team.

  • Arn (string) –

    [REQUIRED]

    Amazon Resource Name (ARN) for the team.

Return type:

dict

Returns:

Response Syntax

{
    'VersionId': 'string'
}

Response Structure

  • (dict) –

    • VersionId (string) –

      Version ID for the team that was created. When an approval team is updated, the version ID changes.

Exceptions