reports

Creates, updates, deletes, gets or lists a reports resource.

Overview

Name	reports
Type	Resource
Id	aws.artifact.reports

Fields

The following fields are returned by SELECT queries:

get_report

Name	Datatype	Description
document_presigned_url	string	Presigned S3 url to access the report content.

list_reports

Name	Datatype	Description
id	string	Unique resource ID for the report resource. (pattern: <code>report-[a-zA-Z0-9]{16}</code>)
name	string	Name for the report resource. (pattern: <code>[a-zA-Z0-9_-\s]*</code>)
acceptance_type	string	Acceptance type for report. (PASSTHROUGH, EXPLICIT)
arn	string	ARN for the report resource. (pattern: <code>[^<>]*</code>)
category	string	Category for the report resource. (pattern: <code>[a-zA-Z0-9_-\s]*</code>)
company_name	string	Associated company name for the report resource. (pattern: <code>[a-zA-Z0-9_-\s]*</code>)
description	string	Description for the report resource. (pattern: <code>[^<>]*</code>)
period_end	string (date-time)	Timestamp indicating the report resource effective end.
period_start	string (date-time)	Timestamp indicating the report resource effective start.
product_name	string	Associated product name for the report resource. (pattern: <code>[a-zA-Z0-9_-\s]*</code>)
series	string	Series for the report resource. (pattern: <code>[a-zA-Z0-9_-\s]*</code>)
state	string	Current state of the report resource. (PUBLISHED, UNPUBLISHED)
status_message	string	The message associated with the current upload state.
upload_state	string	The current state of the document upload. (PROCESSING, COMPLETE, FAILED, FAULT)
version	integer (int64)	Version for the report resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_report	select	reportId, termToken, region	reportVersion	Get the content for a single report.
list_reports	select	region	maxResults, nextToken	List available reports.

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)
reportId	string	Unique resource ID for the report resource.
termToken	string	Unique download token provided by GetTermForReport API.
maxResults	integer	Maximum number of resources to return in the paginated response.
nextToken	string	Pagination token to request the next page of resources.
reportVersion	integer (int64)	Version for the report resource.

SELECT examples

get_report

Get the content for a single report.

SELECT
document_presigned_url
FROM aws.artifact.reports
WHERE reportId = '{{ reportId }}' -- required
AND termToken = '{{ termToken }}' -- required
AND region = '{{ region }}' -- required
AND reportVersion = '{{ reportVersion }}'
;

list_reports

List available reports.

SELECT
id,
name,
acceptance_type,
arn,
category,
company_name,
description,
period_end,
period_start,
product_name,
series,
state,
status_message,
upload_state,
version
FROM aws.artifact.reports
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;