declarative_policies_report_summaries

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

Overview

Name	declarative_policies_report_summaries
Type	Resource
Id	aws.ec2.declarative_policies_report_summaries

Fields

The following fields are returned by SELECT queries:

get_declarative_policies_report_summary

Name	Datatype	Description
attribute_summaries	string	The attributes described in the report.
end_time	string	The time when the report generation ended.
number_of_accounts	integer	The total number of accounts associated with the specified targetId.
number_of_failed_accounts	integer	The number of accounts where attributes could not be retrieved in any Region.
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.
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
get_declarative_policies_report_summary	select	ReportId, region	DryRun	Retrieves a summary of the account status 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
ReportId	string	The ID of the report.
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.

SELECT examples

get_declarative_policies_report_summary

Retrieves a summary of the account status 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
attribute_summaries,
end_time,
number_of_accounts,
number_of_failed_accounts,
report_id,
s3_bucket,
s3_prefix,
start_time,
target_id
FROM aws.ec2.declarative_policies_report_summaries
WHERE ReportId = '{{ ReportId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;