ListReportDefinitions - API Reference

ListReportDefinitions

Retrieves a list of all reports and their configurations for your AWS account.

The maximum number of reports is one.

Request Syntax

GET /reportDefinition?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token value from a previous call to access the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 102400.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "reportDefinitions": [ { "createdAt": number, "destinationS3Location": { "bucket": "string", "prefix": "string" }, "format": "string", "lastUpdatedAt": number, "reportDescription": "string", "reportFrequency": "string", "reportId": "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

The value of the next token, if it exists. Null if there are no more results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 102400.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

reportDefinitions

The retrieved reports.

Type: Array of ReportDefinition objects

Errors

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

AccessDeniedException

You do not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

ThrottlingException

The calls to AWS Application Cost Profiler API are throttled. The request was denied.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints for the API.

HTTP Status Code: 400

See Also

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