report_jobs

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

Overview

Name	report_jobs
Type	Resource
Id	aws.backup.report_jobs

Fields

The following fields are returned by SELECT queries:

describe_report_job

Name	Datatype	Description
completion_time	string (date-time)	The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
creation_time	string (date-time)	The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
report_destination	object	The S3 bucket name and S3 keys for the destination where the report job publishes the report.
report_job_id	string	The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.
report_plan_arn	string	An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
report_template	string	Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
status	string	The status of a report job. The statuses are: CREATED | RUNNING | COMPLETED | FAILED COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.
status_message	string	A message explaining the status of the report job.

list_report_jobs

Name	Datatype	Description
next_token	string	An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
report_jobs	array	Details about your report jobs in JSON format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_report_job	select	report_job_id, region		Returns the details associated with creating a report as specified by its ReportJobId.
list_report_jobs	select	region	ReportPlanName, CreationBefore, CreationAfter, Status, MaxResults, NextToken	Returns details about your report jobs.

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)
report_job_id	string	The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.
CreationAfter	string (date-time)	Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
CreationBefore	string (date-time)	Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
MaxResults	integer	The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
NextToken	string	An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
ReportPlanName	string	Returns only report jobs with the specified report plan name.
Status	string	Returns only report jobs that are in the specified status. The statuses are: CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES Please note that only scanning jobs finish with state completed with issues. For backup jobs this is a console interpretation of a job that finishes in completed state and has a status message.

SELECT examples

describe_report_job

Returns the details associated with creating a report as specified by its ReportJobId.

SELECT
completion_time,
creation_time,
report_destination,
report_job_id,
report_plan_arn,
report_template,
status,
status_message
FROM aws.backup.report_jobs
WHERE report_job_id = '{{ report_job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_report_jobs

Returns details about your report jobs.

SELECT
next_token,
report_jobs
FROM aws.backup.report_jobs
WHERE region = '{{ region }}' -- required
AND ReportPlanName = '{{ ReportPlanName }}'
AND CreationBefore = '{{ CreationBefore }}'
AND CreationAfter = '{{ CreationAfter }}'
AND Status = '{{ Status }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;