Start Report Creation
| resourcegroupstaggingapi_start_report_creation | R Documentation |
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy¶
Description¶
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.
The generated report is saved to the following location:
s3://amzn-s3-demo-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv
For more information about evaluating resource compliance with tag policies, including the required permissions, review Permissions for evaluating organization-wide compliance in the Tagging Amazon Web Services Resources and Tag Editor user guide.
You can call this operation only from the organization's management account and from the us-east-1 Region.
If the account associated with the identity used to call
start_report_creation is different from the account that owns the
Amazon S3 bucket, there must be a bucket policy attached to the bucket
to provide access. For more information, review Amazon S3 bucket policy
for report
storage
in the Tagging Amazon Web Services Resources and Tag Editor user
guide.
Usage¶
resourcegroupstaggingapi_start_report_creation(S3Bucket)
Arguments¶
S3Bucket |
[required] The name of the Amazon S3 bucket where the report will be stored; for example:
For more information on S3 bucket requirements, including an example bucket policy, see the example Amazon S3 bucket policy on this page. |
Value¶
An empty list.
Request syntax¶
svc$start_report_creation(
S3Bucket = "string"
)