ResourceGroupsTaggingAPI / Client / start_report_creation

start_report_creation#

ResourceGroupsTaggingAPI.Client.start_report_creation(**kwargs)#

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://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv

You can call this operation only from the organization’s management account and from the us-east-1 Region.

See also: AWS API Documentation

Request Syntax

response = client.start_report_creation(
    S3Bucket='string'
)
Parameters:

S3Bucket (string) –

[REQUIRED]

The name of the Amazon S3 bucket where the report will be stored; for example:

awsexamplebucket

For more information on S3 bucket requirements, including an example bucket policy, see the example S3 bucket policy on this page.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • ResourceGroupsTaggingAPI.Client.exceptions.ConcurrentModificationException

  • ResourceGroupsTaggingAPI.Client.exceptions.ConstraintViolationException

  • ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException

  • ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException

  • ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException