DescribeReportDefinitions - Amazon Billing and Cost Management
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Lists the Amazon Cost and Usage Report available to this account.

Request Syntax

{ "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The maximum number of results that Amazon returns for the operation.

Type: Integer

Valid Range: Fixed value of 5.

Required: No


A generic string.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [A-Za-z0-9_\.\-=]*

Required: No

Response Syntax

{ "NextToken": "string", "ReportDefinitions": [ { "AdditionalArtifacts": [ "string" ], "AdditionalSchemaElements": [ "string" ], "BillingViewArn": "string", "Compression": "string", "Format": "string", "RefreshClosedReports": boolean, "ReportName": "string", "ReportStatus": { "lastDelivery": "string", "lastStatus": "string" }, "ReportVersioning": "string", "S3Bucket": "string", "S3Prefix": "string", "S3Region": "string", "TimeUnit": "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.


A generic string.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [A-Za-z0-9_\.\-=]*


An Amazon Cost and Usage Report list owned by the account.

Type: Array of ReportDefinition objects


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


An error on the server occurred during the processing of your request. Try again later.

HTTP Status Code: 500


The following is a sample request and response of the DescribeReportDefinitions operation.

This example illustrates one usage of DescribeReportDefinitions.

Sample Request

POST / HTTP/1.1 Host: api.cur.<region>.<domain> x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AWSOrigamiServiceGateway.DescribeReportDefinitions { "MaxResults": 5 }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "ReportDefinitions": [ { "AdditionalArtifacts": ["QUICKSIGHT"], "AdditionalSchemaElements": ["RESOURCES"], "Compression": "GZIP", "Format": "textORcsv", "ReportName": "ExampleReport", "S3Bucket": "example-s3-bucket", "S3Prefix": "exampleprefix", "S3Region": "us-east-1", "TimeUnit": "HOURLY" }, { "AdditionalArtifacts": ["QUICKSIGHT"], "AdditionalSchemaElements": ["RESOURCES"], "Compression": "GZIP", "Format": "textORcsv", "ReportName": "ExampleReport2", "S3Bucket": "example-s3-bucket", "S3Prefix": "exampleprefix", "S3Region": "us-east-1", "TimeUnit": "HOURLY" "ReportStatus": { "lastDelivery": "20191102T054923Z", "lastStatus": "SUCCESS" } } ] }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: