AWS Cost Explorer Service
Cost Management APIs

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeReportDefinitions

Lists the AWS Cost and Usage reports 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.

MaxResults

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

Type: Integer

Valid Range: Fixed value of 5.

Required: No

NextToken

A generic string.

Type: String

Required: No

Response Syntax

{ "NextToken": "string", "ReportDefinitions": [ { "AdditionalArtifacts": [ "string" ], "AdditionalSchemaElements": [ "string" ], "Compression": "string", "Format": "string", "RefreshClosedReports": boolean, "ReportName": "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.

NextToken

A generic string.

Type: String

ReportDefinitions

A list of AWS Cost and Usage reports owned by the account.

Type: Array of ReportDefinition objects

Errors

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

InternalErrorException

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

HTTP Status Code: 500

Example

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

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" }] }

See Also

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