<a id="cli-aws-inspector2-get-configuration"></a>

# get-configuration

## Description

Retrieves setting configurations for Amazon Inspector scans. If you specify an `accountId` , this operation returns the scan configuration for that member account. You must be the delegated administrator for the specified member account. If you do not specify an `accountId` , this operation returns your own scan configuration.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/inspector2-2020-06-08/GetConfiguration)

## Synopsis

```
  get-configuration
[--account-id <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--account-id` (string)

> The 12-digit Amazon Web Services account ID of the member account whose scan configuration you want to retrieve. When specified, you must be the delegated administrator for this member account. If not specified, the operation returns your own configuration.

> Constraints:

> * min: `12`
> * max: `12`
> * pattern: `\d{12}`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those 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. This may not be specified along with `--cli-input-yaml`.

`--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`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## 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
* yaml
* yaml-stream
* off

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

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**To get the setting configuration for Inspector scans**

The following `get-configuration` example gets the setting configuration for Inspector scans.

```bash
aws inspector2 get-configuration
```

Output:

```json
{
    "ec2Configuration": {
        "scanModeState": {
            "scanMode": "EC2_HYBRID",
            "scanModeStatus": "SUCCESS"
        }
    },
    "ecrConfiguration": {
        "rescanDurationState": {
            "pullDateRescanDuration": "DAYS_90",
            "rescanDuration": "DAYS_30",
            "status": "SUCCESS",
            "updatedAt": "2024-05-14T21:16:20.237000+00:00"
        }
    }
}
```

For more information, see [Automated resource scanning with Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/scanning-resources.html) in the *Amazon Inspector User Guide*.

## Output

ecrConfiguration -> (structure)

> Specifies how the ECR automated re-scan duration is currently configured for your environment.

> rescanDurationState -> (structure)

> > An object that contains details about the state of the ECR re-scan settings.

> > rescanDuration -> (string)

> > > The rescan duration configured for image push date.

> > > Possible values:

> > > * `LIFETIME`
> > > * `DAYS_30`
> > > * `DAYS_180`
> > > * `DAYS_14`
> > > * `DAYS_60`
> > > * `DAYS_90`
> > > * `DAYS_3`
> > > * `DAYS_7`

> > status -> (string)

> > > The status of changes to the ECR automated re-scan duration.

> > > Possible values:

> > > * `SUCCESS`
> > > * `PENDING`
> > > * `FAILED`

> > updatedAt -> (timestamp)

> > > A timestamp representing when the last time the ECR scan duration setting was changed.

> > pullDateRescanDuration -> (string)

> > > The rescan duration configured for image pull date.

> > > Possible values:

> > > * `DAYS_14`
> > > * `DAYS_30`
> > > * `DAYS_60`
> > > * `DAYS_90`
> > > * `DAYS_180`
> > > * `DAYS_3`
> > > * `DAYS_7`

> > pullDateRescanMode -> (string)

> > > The pull date for the re-scan mode.

> > > Possible values:

> > > * `LAST_PULL_DATE`
> > > * `LAST_IN_USE_AT`

ec2Configuration -> (structure)

> Specifies how the Amazon EC2 automated scan mode is currently configured for your environment.

> scanModeState -> (structure)

> > An object that contains details about the state of the Amazon EC2 scan mode.

> > scanMode -> (string)

> > > The scan method that is applied to the instance.

> > > Possible values:

> > > * `EC2_SSM_AGENT_BASED`
> > > * `EC2_HYBRID`

> > scanModeStatus -> (string)

> > > The status of the Amazon EC2 scan mode setting.

> > > Possible values:

> > > * `SUCCESS`
> > > * `PENDING`

> vmScannerState -> (structure)

> > An object that contains details about the state of the Amazon Inspector VM scanner.

> > activated -> (boolean)

> > > Whether the VM scanner is activated.

> > activatedAt -> (timestamp)

> > > The date and time the VM scanner was activated.

> > status -> (string)

> > > The status of the VM scanner.

> > > Possible values:

> > > * `SUCCESS`
> > > * `PENDING`
> > > * `FAILED`

amiConfiguration -> (structure)

> The current state of the Amazon Machine Image (AMI) scan configuration for the account.

> lastLaunchedWithin -> (string)

> > Restricts scanning to AMIs that were last launched within the specified duration.

> > Possible values:

> > * `DAYS_180`
> > * `DAYS_90`
> > * `DAYS_60`
> > * `DAYS_30`
> > * `DAYS_14`
> > * `DAYS_7`

> createdWithin -> (string)

> > Restricts scanning to AMIs that were created within the specified duration.

> > Possible values:

> > * `DAYS_180`
> > * `DAYS_90`
> > * `DAYS_60`
> > * `DAYS_30`
> > * `DAYS_14`
> > * `DAYS_7`

> scanModeConfiguration -> (structure)

> > The scan mode configuration that determines which AMIs are scanned.

> > scanMode -> (string) [required]

> > > The scan mode that determines whether all AMIs are scanned or only those matching the specified tags.

> > > Possible values:

> > > * `SCAN_ALL`
> > > * `TARGET_SCANNING`

> > tags -> (list)

> > > The tag filters used to select which AMIs are scanned when using targeted scanning.

> > > Constraints:

> > > * min: `0`
> > > * max: `1`

> > > (structure)

> > > > A filter that matches Amazon Machine Images (AMIs) by tag key and, optionally, tag value.

> > > > key -> (string) [required]

> > > > > The tag key to match against an AMI’s tags.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `128`

> > > > value -> (string)

> > > > > The tag value to match against an AMI’s tags. If omitted, the filter matches on the tag key alone.

> > > > > Constraints:

> > > > > * min: `0`
> > > > > * max: `256`

> > excludeCopiedAmis -> (boolean)

> > > Whether to exclude AMIs that are copies of other AMIs from scanning.

> > excludeBackupDlmAmis -> (boolean)

> > > Whether to exclude AMIs created by Amazon Data Lifecycle Manager (DLM) backups from scanning.

> status -> (string)

> > The status of the AMI scan configuration.

> > Possible values:

> > * `SUCCESS`
> > * `PENDING`
> > * `FAILED`

> updatedAt -> (timestamp)

> > The date and time when the AMI scan configuration was last updated.