MultipartyApproval / Client / create_approval_team

create_approval_team

MultipartyApproval.Client.create_approval_team(**kwargs)

Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_approval_team(
    ClientToken='string',
    ApprovalStrategy={
        'MofN': {
            'MinApprovalsRequired': 123
        }
    },
    Approvers=[
        {
            'PrimaryIdentityId': 'string',
            'PrimaryIdentitySourceArn': 'string'
        },
    ],
    Description='string',
    Policies=[
        {
            'PolicyArn': 'string'
        },
    ],
    Name='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ClientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.

    Note

    What is idempotency?

    When you make a mutating API request, the request typically returns a result before the operation’s asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.

    Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

    This field is autopopulated if not provided.

  • ApprovalStrategy (dict) –

    [REQUIRED]

    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) –

    [REQUIRED]

    An array of ApprovalTeamRequesterApprovers 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) –

    [REQUIRED]

    Description for the team.

  • Policies (list) –

    [REQUIRED]

    An array of PolicyReference 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 the Amazon Resource Name (ARN) 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.

      • PolicyArn (string) – [REQUIRED]

        Amazon Resource Name (ARN) for the policy.

  • Name (string) –

    [REQUIRED]

    Name of the team.

  • Tags (dict) –

    Tags you want to attach to the team.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CreationTime': datetime(2015, 1, 1),
    'Arn': 'string',
    'Name': 'string',
    'VersionId': 'string'
}

Response Structure

  • (dict) –

    • CreationTime (datetime) –

      Timestamp when the team was created.

    • Arn (string) –

      Amazon Resource Name (ARN) for the team that was created.

    • Name (string) –

      Name of the team that was created.

    • VersionId (string) –

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

Exceptions