list-exposures-by-remediation-v2¶

Description¶

Retrieves the exposure findings tied to a specific remediation target. Results are sorted by previous severity, highest first, and are paginated.

Synopsis¶

  list-exposures-by-remediation-v2
--target-uid <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]

Options¶

--target-uid (string) [required]

The unique identifier (ID) of an existing remediation target to list exposure findings for.

Constraints:

min: 1

max: 2048

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Output¶

Items -> (list)

An array of exposure findings returned by the operation.

Constraints:

min: 0

max: 1000

(structure)

Provides details about an exposure finding and the effect the specific remediation target has on it.

MetadataUid -> (string) [required]

The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding.

Constraints:

pattern: .*\S.*

Title -> (string) [required]

The title of the exposure finding.

Constraints:

pattern: .*\S.*

PreviousSeverity -> (string) [required]

The severity of the exposure finding before the remediation target is resolved.

Possible values:

Informational

Low

Medium

High

Critical

ProjectedSeverity -> (string) [required]

The severity of the exposure finding after the remediation target is resolved.

Possible values:

Informational

Low

Medium

High

Critical

Impact -> (string) [required]

The impact resolving a remediation target has on the exposure finding.

Reduces specifies that resolving the remediation target lowers the severity of the exposure finding, but does not resolve it.

Resolves specifies that resolving the remediation target resolves the exposure finding.

Unchanged specifies that resolving the remediation target does not change the severity of the exposure finding.

Possible values:

Reduces

Resolves

Unchanged

TargetUid -> (string)

The unique identifier (ID) of the remediation target that the exposure findings are associated with.

Constraints:

pattern: .*\S.*

Resource -> (structure)

Provides comprehensive details about a resource.

AccountId -> (string) [required]

The Amazon Web Services account that recorded the resource data in Security Hub.

Constraints:

pattern: .*\S.*

Region -> (string) [required]

The Amazon Web Services Region in which Security Hub recorded the resource data.

Constraints:

pattern: .*\S.*

ResourceOwnerAccountId -> (string)

The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.

Constraints:

pattern: .*\S.*

ResourceOwnerOrgId -> (string)

The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID.

Constraints:

pattern: .*\S.*

Type -> (string) [required]

The type of the resource.

Constraints:

pattern: .*\S.*

Name -> (string)

The name of the resource.

Constraints:

pattern: .*\S.*

Id -> (string) [required]

The unique identifier for a resource.

Constraints:

pattern: .*\S.*

ResourceGuid -> (string)

The global identifier used to identify a resource.

Constraints:

pattern: .*\S.*

ResourceRegion -> (string) [required]

The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1 ). For Azure resources, this is the Azure region (for example, westus2 ). This field is always included.

Constraints:

pattern: .*\S.*

CloudProvider -> (string) [required]

The cloud provider where the resource exists.

AWS specifies that the resource exists in Amazon Web Services.

Azure specifies that the resource exists in Microsoft Azure.

Possible values:

Azure

AWS

TotalCount -> (integer)

The total count of exposure findings associated with the remediation target.

Trait -> (structure)

The specific trait associated with the remediation target.

Type -> (string) [required]

The trait type.

Constraints:

pattern: .*\S.*

Title -> (string) [required]

The trait title.

Constraints:

pattern: .*\S.*

NextToken -> (string)

The pagination token to use to request the next page of results. Otherwise, this parameter is null.

Table of Contents

Feedback

User Guide