AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . inspector2 ]

batch-update-member-ec2-deep-inspection-status

Description

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

Synopsis

  batch-update-member-ec2-deep-inspection-status
--account-ids <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--account-ids (list)

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

(structure)

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

accountId -> (string)

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

activateDeepInspection -> (boolean)

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

Shorthand Syntax:

accountId=string,activateDeepInspection=boolean ...

JSON Syntax:

[
  {
    "accountId": "string",
    "activateDeepInspection": true|false
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

accountIds -> (list)

An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status was successfully changed for.

(structure)

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.

(structure)

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.