exclusions_previews

Creates, updates, deletes, gets or lists an exclusions_previews resource.

Overview

Name	exclusions_previews
Type	Resource
Id	aws.inspector.exclusions_previews

Fields

The following fields are returned by SELECT queries:

get_exclusions_preview

Name	Datatype	Description
exclusion_previews	array	Information about the exclusions included in the preview.
next_token	string	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.
preview_status	string	Specifies the status of the request to generate an exclusions preview. (WORK_IN_PROGRESS, COMPLETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_exclusions_preview	select	region		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.
create_exclusions_preview	insert	region, assessmentTemplateArn		Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_exclusions_preview

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.

SELECT
exclusion_previews,
next_token,
preview_status
FROM aws.inspector.exclusions_previews
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_exclusions_preview

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

INSERT INTO aws.inspector.exclusions_previews (
assessmentTemplateArn,
region
)
SELECT 
'{{ assessmentTemplateArn }}' /* required */,
'{{ region }}'
RETURNING
preview_token
;

Manifest

# Description fields are for documentation purposes
- name: exclusions_previews
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the exclusions_previews resource.
  - name: assessmentTemplateArn
    value: "{{ assessmentTemplateArn }}"
    description: |
      The ARN that specifies the assessment template for which you want to create an exclusions preview.