GetReportDefinition
Retrieves the definition of a report already configured in AWS Application Cost Profiler.
Request Syntax
GET /reportDefinition/reportId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- reportId
-
ID of the report to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[0-9A-Za-z\.\-_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"destinationS3Location": {
"bucket": "string",
"prefix": "string"
},
"format": "string",
"lastUpdated": 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.
- createdAt
-
Timestamp (milliseconds) when this report definition was created.
Type: Timestamp
- destinationS3Location
-
Amazon Simple Storage Service (Amazon S3) location where the report is uploaded.
Type: S3Location object
- format
-
Format of the generated report.
Type: String
Valid Values:
CSV | PARQUET
- lastUpdated
-
Timestamp (milliseconds) when this report definition was last updated.
Type: Timestamp
- reportDescription
-
Description of the report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*
- reportFrequency
-
Cadence used to generate the report.
Type: String
Valid Values:
MONTHLY | DAILY | ALL
- reportId
-
ID of the report retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[0-9A-Za-z\.\-_]+$
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: