report_metadatas

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

Overview

Name	report_metadatas
Type	Resource
Id	aws.artifact.report_metadatas

Fields

The following fields are returned by SELECT queries:

get_report_metadata

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>)
created_at	string (date-time)	Timestamp indicating when the report resource was created.
deleted_at	string (date-time)	Timestamp indicating when the report resource was deleted.
description	string	Description for the report resource. (pattern: <code>[^<>]*</code>)
last_modified_at	string (date-time)	Timestamp indicating when the report resource was last modified.
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>)
sequence_number	integer (int64)	Sequence number to enforce optimistic locking.
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.
term_arn	string	Unique resource ARN for term resource. (pattern: <code>[^<>]*</code>)
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_metadata	select	reportId, region	reportVersion	Get the metadata for a single report.

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.
reportVersion	integer (int64)	Version for the report resource.

SELECT examples

get_report_metadata

Get the metadata for a single report.

SELECT
id,
name,
acceptance_type,
arn,
category,
company_name,
created_at,
deleted_at,
description,
last_modified_at,
period_end,
period_start,
product_name,
sequence_number,
series,
state,
status_message,
term_arn,
upload_state,
version
FROM aws.artifact.report_metadatas
WHERE reportId = '{{ reportId }}' -- required
AND region = '{{ region }}' -- required
AND reportVersion = '{{ reportVersion }}'
;