Skip to content

aws.inspector.get_exclusions_preview

Example SQL Queries

SELECT * FROM
aws.inspector.get_exclusions_preview
WHERE
"assessment_template_arn" = 'VALUE'
AND "preview_token" = 'VALUE';

Description

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Table Definition

Column NameColumn Data Type
assessment_template_arn Required Input Column

The ARN that specifies the assessment template for which the exclusions preview was requested.

VARCHAR
preview_token Required Input Column

The unique identifier associated of the exclusions preview.

VARCHAR
locale Input Column

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

VARCHAR
max_results Input Column

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

BIGINT
next_token Input Column

When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
exclusion_previews

Information about the exclusions included in the preview.

STRUCT(
"title" VARCHAR,
"description" VARCHAR,
"recommendation" VARCHAR,
"scopes" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"attributes" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
Show child fields
exclusion_previews[]
Show child fields
exclusion_previews[].attributes[]
Show child fields
exclusion_previews[].attributes[].key

The attribute key.

exclusion_previews[].attributes[].value

The value assigned to the attribute key.

exclusion_previews[].description

The description of the exclusion preview.

exclusion_previews[].recommendation

The recommendation for the exclusion preview.

exclusion_previews[].scopes[]
Show child fields
exclusion_previews[].scopes[].key

The type of the scope.

exclusion_previews[].scopes[].value

The resource identifier for the specified scope type.

exclusion_previews[].title

The name of the exclusion preview.

preview_status

Specifies the status of the request to generate an exclusions preview.

VARCHAR