AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . inspector2 ]

update-configuration

Description

Updates the scan configuration for your Amazon Inspector account. If you don’t specify an accountId , this operation updates the delegated administrator’s configuration and propagates it to member accounts that have not been individually configured. If you specify an accountId , this operation updates that member account’s configuration. Only the delegated administrator can specify an accountId ; member accounts cannot call this operation.

See also: AWS API Documentation

Synopsis

  update-configuration
[--account-id <value>]
[--ecr-configuration <value>]
[--ec2-configuration <value>]
[--update-configuration-inheritance <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>]
[--v2-debug]

Options

--account-id (string)

The 12-digit Amazon Web Services account ID of the member account whose scan configuration you want to update. When specified, you must be the delegated administrator for this member account. If not specified, the operation updates your own configuration and propagates changes to any member accounts that have not been individually configured.

--ecr-configuration (structure)

Specifies how the ECR automated re-scan will be updated for your environment.

rescanDuration -> (string)

The rescan duration configured for image push date.

pullDateRescanDuration -> (string)

The rescan duration configured for image pull date.

pullDateRescanMode -> (string)

The pull date for the re-scan mode.

Shorthand Syntax:

rescanDuration=string,pullDateRescanDuration=string,pullDateRescanMode=string

JSON Syntax:

{
  "rescanDuration": "LIFETIME"|"DAYS_30"|"DAYS_180"|"DAYS_14"|"DAYS_60"|"DAYS_90"|"DAYS_3"|"DAYS_7",
  "pullDateRescanDuration": "DAYS_14"|"DAYS_30"|"DAYS_60"|"DAYS_90"|"DAYS_180"|"DAYS_3"|"DAYS_7",
  "pullDateRescanMode": "LAST_PULL_DATE"|"LAST_IN_USE_AT"
}

--ec2-configuration (structure)

Specifies how the Amazon EC2 automated scan will be updated for your environment.

scanMode -> (string)

The scan method that is applied to the instance.

activateVMScanner -> (boolean)

Whether to activate Amazon Inspector VM scanner for Amazon EC2 scanning.

Shorthand Syntax:

scanMode=string,activateVMScanner=boolean

JSON Syntax:

{
  "scanMode": "EC2_SSM_AGENT_BASED"|"EC2_HYBRID",
  "activateVMScanner": true|false
}

--update-configuration-inheritance (structure)

Specifies which scan-type configurations to reset to the delegated administrator’s inherited values for the targeted member account. Each member of this structure is independently optional. When specified, ec2Configuration and ecrConfiguration must be absent, and accountId must also be present. Only INHERIT_FROM_ADMIN is valid for each member. If not specified, the operation uses the ec2Configuration and ecrConfiguration parameters instead.

ec2Configuration -> (string)

The inheritance mode for Amazon EC2 scan configuration. Set to INHERIT_FROM_ADMIN to reset the member account’s Amazon EC2 scan configuration to inherit from the delegated administrator. If omitted, the member account’s existing Amazon EC2 scan configuration is not changed.

ecrConfiguration -> (string)

The inheritance mode for Amazon ECR scan configuration. Set to INHERIT_FROM_ADMIN to reset the member account’s Amazon ECR scan configuration to inherit from the delegated administrator. If omitted, the member account’s existing Amazon ECR scan configuration is not changed.

Shorthand Syntax:

ec2Configuration=string,ecrConfiguration=string

JSON Syntax:

{
  "ec2Configuration": "INHERIT_FROM_ADMIN",
  "ecrConfiguration": "INHERIT_FROM_ADMIN"
}

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

None