Response Syntax Response Elements Errors Examples See Also

DescribeReportCreation

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.

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ErrorMessage

Details of the common errors that all operations return.

Type: String

S3Location

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

Type: String

Status

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ConstraintViolationException

The request failed because performing the operation would violate a constraint.

Some of the reasons in the following list might not apply to this specific operation.

You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the Amazon Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com) to integrate with Amazon Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.

HTTP Status Code: 400

InternalServiceException

The request processing failed because of an unknown error, exception, or failure. You can retry the request.

HTTP Status Code: 500

InvalidParameterException

The request failed because of one of the following reasons:

A required parameter is missing.
A provided string parameter is malformed.
An provided parameter value is out of range.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the Amazon Organizations User Guide.
The partition specified in an ARN parameter in the request doesn't match the partition where you invoked the operation. The partition is specified by the second field of the ARN.

HTTP Status Code: 400

ThrottledException

The request failed because it exceeded the allowed frequency of submitted requests.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeReportCreation.

Sample Request



POST / HTTP/1.1
Host: tagging.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 20
X-Amz-Target: ResourceGroupsTaggingAPI_20170126.DescribeReportCreation
X-Amz-Date: 20191201T214524Z
User-Agent: aws-cli/1.11.79 Python/2.7.9 Windows/7 botocore/1.5.42 
Content-Type: application/x-amz-json-1.1
Authorization:  AUTHPARAMS

{}

Sample Response



HTTP/1.1 200 OK
x-amzn-RequestID: d3cf21f0-26db-11e7-a532-75e05382c8b1
Content-Type: application/x-amz-json-1.1
Date: Sun, 1 Dec 2019 21:45:25 GMT

{
    "ErrorMessage":null,
    "S3Location":"s3://awsexamplebucket/AwsTagPolicies/o-exampleorgid/2019-12-01-T21:45:24Z/report.csv",
    "Status":"SUCCEEDED"
}