MultipartyApproval / Client / get_approval_team

get_approval_team

MultipartyApproval.Client.get_approval_team(**kwargs)

Returns details for an approval team.

See also: AWS API Documentation

Request Syntax

response = client.get_approval_team(
    Arn='string'
)
Parameters:

Arn (string) –

[REQUIRED]

Amazon Resource Name (ARN) for the team.

Return type:

dict

Returns:

Response Syntax

{
    'CreationTime': datetime(2015, 1, 1),
    'ApprovalStrategy': {
        'MofN': {
            'MinApprovalsRequired': 123
        }
    },
    'NumberOfApprovers': 123,
    'Approvers': [
        {
            'ApproverId': 'string',
            'ResponseTime': datetime(2015, 1, 1),
            'PrimaryIdentityId': 'string',
            'PrimaryIdentitySourceArn': 'string',
            'PrimaryIdentityStatus': 'PENDING'|'ACCEPTED'|'REJECTED'|'INVALID'
        },
    ],
    'Arn': 'string',
    'Description': 'string',
    'Name': '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',
    'UpdateSessionArn': 'string',
    'VersionId': 'string',
    'Policies': [
        {
            'PolicyArn': 'string'
        },
    ],
    'LastUpdateTime': datetime(2015, 1, 1),
    'PendingUpdate': {
        'VersionId': 'string',
        'Description': 'string',
        'ApprovalStrategy': {
            'MofN': {
                'MinApprovalsRequired': 123
            }
        },
        'NumberOfApprovers': 123,
        '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',
        'Approvers': [
            {
                'ApproverId': 'string',
                'ResponseTime': datetime(2015, 1, 1),
                'PrimaryIdentityId': 'string',
                'PrimaryIdentitySourceArn': 'string',
                'PrimaryIdentityStatus': 'PENDING'|'ACCEPTED'|'REJECTED'|'INVALID'
            },
        ],
        'UpdateInitiationTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • CreationTime (datetime) –

      Timestamp when the team was created.

    • ApprovalStrategy (dict) –

      An ApprovalStrategyResponse object. Contains details for how the 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.

    • Approvers (list) –

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

      • (dict) –

        Contains details for an approver.

        • ApproverId (string) –

          ID for the approver.

        • ResponseTime (datetime) –

          Timestamp when the approver responded to an approval team invitation.

        • PrimaryIdentityId (string) –

          ID for the user.

        • PrimaryIdentitySourceArn (string) –

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

        • PrimaryIdentityStatus (string) –

          Status for the identity source. For example, if an approver has accepted a team invitation with a user authentication method managed by the identity source.

    • Arn (string) –

      Amazon Resource Name (ARN) for the team.

    • Description (string) –

      Description for the team.

    • Name (string) –

      Name of the approval 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 approval team. For more information, see Team health in the Multi-party approval User Guide.

    • StatusMessage (string) –

      Message describing the status for the team.

    • UpdateSessionArn (string) –

      Amazon Resource Name (ARN) for the session.

    • VersionId (string) –

      Version ID for the team.

    • Policies (list) –

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

          Amazon Resource Name (ARN) for the policy.

    • LastUpdateTime (datetime) –

      Timestamp when the team was last updated.

    • PendingUpdate (dict) –

      A PendingUpdate object. Contains details for the pending updates for the team, if applicable.

      • VersionId (string) –

        Version ID for the team.

      • Description (string) –

        Description for the team.

      • ApprovalStrategy (dict) –

        An ApprovalStrategyResponse object. Contains details for how the 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.

      • 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 update. For more information, see Team health in the Multi-party approval User Guide.

      • StatusMessage (string) –

        Message describing the status for the team.

      • Approvers (list) –

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

        • (dict) –

          Contains details for an approver.

          • ApproverId (string) –

            ID for the approver.

          • ResponseTime (datetime) –

            Timestamp when the approver responded to an approval team invitation.

          • PrimaryIdentityId (string) –

            ID for the user.

          • PrimaryIdentitySourceArn (string) –

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

          • PrimaryIdentityStatus (string) –

            Status for the identity source. For example, if an approver has accepted a team invitation with a user authentication method managed by the identity source.

      • UpdateInitiationTime (datetime) –

        Timestamp when the update request was initiated.

Exceptions