Inspector2 / Client / batch_get_member_ec2_deep_inspection_status

batch_get_member_ec2_deep_inspection_status#

Inspector2.Client.batch_get_member_ec2_deep_inspection_status(**kwargs)#

Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_member_ec2_deep_inspection_status(
    accountIds=[
        'string',
    ]
)
Parameters:

accountIds (list) –

The unique identifiers for the Amazon Web Services accounts to retrieve Amazon Inspector deep inspection activation status for. </p>

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'accountIds': [
        {
            'accountId': 'string',
            'errorMessage': 'string',
            'status': 'ACTIVATED'|'DEACTIVATED'|'PENDING'|'FAILED'
        },
    ],
    'failedAccountIds': [
        {
            'accountId': 'string',
            'ec2ScanStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'SUSPENDING'|'SUSPENDED',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • accountIds (list) –

      An array of objects that provide details on the activation status of Amazon Inspector deep inspection for each of the requested accounts. </p>

      • (dict) –

        An object that contains details about the state of Amazon Inspector deep inspection for a member account.

        • accountId (string) –

          The unique identifier for the Amazon Web Services account of the organization member

        • errorMessage (string) –

          The error message explaining why the account failed to activate Amazon Inspector deep inspection.

        • status (string) –

          The state of Amazon Inspector deep inspection in the member account.

    • failedAccountIds (list) –

      An array of objects that provide details on any accounts that failed to activate Amazon Inspector deep inspection and why. </p>

      • (dict) –

        An object that contains details about a member account in your organization that failed to activate Amazon Inspector deep inspection.

        • accountId (string) –

          The unique identifier for the Amazon Web Services account of the organization member that failed to activate Amazon Inspector deep inspection.

        • ec2ScanStatus (string) –

          The status of EC2 scanning in the account that failed to activate Amazon Inspector deep inspection.

        • errorMessage (string) –

          The error message explaining why the account failed to activate Amazon Inspector deep inspection.

Exceptions