[ aws . inspector ]

describe-exclusions

Description

Describes the exclusions that are specified by the exclusions’ ARNs.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-exclusions
--exclusion-arns <value>
[--locale <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--exclusion-arns (list)

The list of ARNs that specify the exclusions that you want to describe.

(string)

Syntax:

"string" "string" ...

--locale (string)

The locale into which you want to translate the exclusion’s title, description, and recommendation.

Possible values:

  • EN_US

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

See ‘aws help’ for descriptions of global parameters.

Output

exclusions -> (map)

Information about the exclusions.

key -> (string)

value -> (structure)

Contains information about what was excluded from an assessment run.

arn -> (string)

The ARN that specifies the exclusion.

title -> (string)

The name of the exclusion.

description -> (string)

The description of the exclusion.

recommendation -> (string)

The recommendation for the exclusion.

scopes -> (list)

The AWS resources for which the exclusion pertains.

(structure)

This data type contains key-value pairs that identify various Amazon resources.

key -> (string)

The type of the scope.

value -> (string)

The resource identifier for the specified scope type.

attributes -> (list)

The system-defined attributes for the exclusion.

(structure)

This data type is used as a request parameter in the AddAttributesToFindings and CreateAssessmentTemplate actions.

key -> (string)

The attribute key.

value -> (string)

The value assigned to the attribute key.

failedItems -> (map)

Exclusion details that cannot be described. An error code is provided for each failed item.

key -> (string)

value -> (structure)

Includes details about the failed items.

failureCode -> (string)

The status code of a failed item.

retryable -> (boolean)

Indicates whether you can immediately retry a request for this item for a specified resource.