ResourceGroupsTaggingAPI / Client / describe_report_creation

describe_report_creation#

ResourceGroupsTaggingAPI.Client.describe_report_creation()#

Describes the status of the StartReportCreation operation.

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.describe_report_creation()
Return type:

dict

Returns:

Response Syntax

{
    'Status': 'string',
    'S3Location': 'string',
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) –

    • Status (string) –

      Reports the status of the operation.

      The operation status can be one of the following:

      • RUNNING - Report creation is in progress.

      • SUCCEEDED - Report creation is complete. You can open the report from the Amazon S3 bucket that you specified when you ran StartReportCreation.

      • FAILED - Report creation timed out or the Amazon S3 bucket is not accessible.

      • NO REPORT - No report was generated in the last 90 days.

    • S3Location (string) –

      The path to the Amazon S3 bucket where the report was stored on creation.

    • ErrorMessage (string) –

      Details of the common errors that all operations return.

Exceptions

  • ResourceGroupsTaggingAPI.Client.exceptions.ConstraintViolationException

  • ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException

  • ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException

  • ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException