SecurityIncidentResponse / Client / batch_get_member_account_details

batch_get_member_account_details

SecurityIncidentResponse.Client.batch_get_member_account_details(**kwargs)

Provides information on whether the supplied account IDs are associated with a membership.

Note

AWS account ID’s may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_member_account_details(
    membershipId='string',
    accountIds=[
        'string',
    ]
)

Parameters:

• membershipId (string) –

  [REQUIRED]

  Required element used in combination with BatchGetMemberAccountDetails to identify the membership ID to query.

• accountIds (list) –

  [REQUIRED]

  Optional element to query the membership relationship status to a provided list of account IDs.

  Note

  AWS account ID’s may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'accountId': 'string',
            'relationshipStatus': 'Associated'|'Disassociated'|'Unassociated',
            'relationshipType': 'Organization'|'Unrelated'
        },
    ],
    'errors': [
        {
            'accountId': 'string',
            'error': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • items (list) –

    The response element providing responses for requests to GetMembershipAccountDetails.

    • (dict) –

      • accountId (string) –

      • relationshipStatus (string) –

      • relationshipType (string) –

  • errors (list) –

    The response element providing error messages for requests to GetMembershipAccountDetails.

    • (dict) –

      • accountId (string) –

      • error (string) –

      • message (string) –

Exceptions

• SecurityIncidentResponse.Client.exceptions.ServiceQuotaExceededException

• SecurityIncidentResponse.Client.exceptions.AccessDeniedException

• SecurityIncidentResponse.Client.exceptions.ValidationException

• SecurityIncidentResponse.Client.exceptions.SecurityIncidentResponseNotActiveException

• SecurityIncidentResponse.Client.exceptions.InternalServerException

• SecurityIncidentResponse.Client.exceptions.ThrottlingException

• SecurityIncidentResponse.Client.exceptions.ConflictException

• SecurityIncidentResponse.Client.exceptions.ResourceNotFoundException

• SecurityIncidentResponse.Client.exceptions.InvalidTokenException