declarative_policies_reports

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

Overview

Name	declarative_policies_reports
Type	Resource
Id	aws.ec2.declarative_policies_reports

Fields

The following fields are returned by SELECT queries:

describe_declarative_policies_reports

Name	Datatype	Description
end_time	string	The time when the report generation ended.
report_id	string	The ID of the report.
s3_bucket	string	The name of the Amazon S3 bucket where the report is located.
s3_prefix	string	The prefix for your S3 object.
start_time	string	The time when the report generation started.
status	string	The current status of the report.
tags	string	Any tags assigned to the report.
target_id	string	The root ID, organizational unit ID, or account ID. Format: For root: r-ab12 For OU: ou-ab12-cdef1234 For account: 123456789012

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_declarative_policies_reports	select	region	DryRun, NextToken, MaxResults, ReportId	Describes the metadata of an account status report, including the status of the report. To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses (running, cancelled, or error) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide. For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.

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)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
MaxResults	integer	The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NextToken	string	The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
ReportId	array	One or more report IDs.

SELECT examples

describe_declarative_policies_reports

Describes the metadata of an account status report, including the status of the report. To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses (running, cancelled, or error) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide. For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.

SELECT
end_time,
report_id,
s3_bucket,
s3_prefix,
start_time,
status,
tags,
target_id
FROM aws.ec2.declarative_policies_reports
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND ReportId = '{{ ReportId }}'
;