Inspector2 / Client / batch_update_member_ec2_deep_inspection_status

batch_update_member_ec2_deep_inspection_status#

Inspector2.Client.batch_update_member_ec2_deep_inspection_status(**kwargs)#

Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in 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_update_member_ec2_deep_inspection_status(
    accountIds=[
        {
            'accountId': 'string',
            'activateDeepInspection': True|False
        },
    ]
)
Parameters:

accountIds (list) –

[REQUIRED]

The unique identifiers for the Amazon Web Services accounts to change Amazon Inspector deep inspection status for.

  • (dict) –

    An object that contains details about the status of Amazon Inspector deep inspection for a member account in your organization.

    • accountId (string) – [REQUIRED]

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

    • activateDeepInspection (boolean) – [REQUIRED]

      Whether Amazon Inspector deep inspection is active in the account. If TRUE Amazon Inspector deep inspection is active, if FALSE it is not active.

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 for each of the accounts that Amazon Inspector deep inspection status was successfully changed for.

      • (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 for each of the accounts that Amazon Inspector deep inspection status could not be successfully changed for.

      • (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