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 ]

enable

Description

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

See also: AWS API Documentation

Synopsis

  enable
[--account-ids <value>]
[--client-token <value>]
--resource-types <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)

A list of account IDs you want to enable Amazon Inspector scans for.

(string)

Syntax:

"string" "string" ...

--client-token (string)

The idempotency token for the request.

--resource-types (list)

The resource scan types you want to enable.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  EC2
  ECR

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

accounts -> (list)

Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.

(structure)

An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.

accountId -> (string)

The ID of the Amazon Web Services account.

resourceStatus -> (structure)

Details of the status of Amazon Inspector scans by resource type.

ec2 -> (string)

The status of Amazon Inspector scanning for Amazon EC2 resources.

ecr -> (string)

The status of Amazon Inspector scanning for Amazon ECR resources.

status -> (string)

The status of Amazon Inspector for the account.

failedAccounts -> (list)

Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.

(structure)

An object with details on why an account failed to enable Amazon Inspector.

accountId -> (string)

The Amazon Web Services account ID.

errorCode -> (string)

The error code explaining why the account failed to enable Amazon Inspector.

errorMessage -> (string)

The error message received when the account failed to enable Amazon Inspector.

resourceStatus -> (structure)

An object detailing which resources Amazon Inspector is enabled to scan for the account.

ec2 -> (string)

The status of Amazon Inspector scanning for Amazon EC2 resources.

ecr -> (string)

The status of Amazon Inspector scanning for Amazon ECR resources.

status -> (string)

The status of Amazon Inspector for the account.