PutReportDefinition
Creates the report definition for a report in Application Cost Profiler.
Request Syntax
POST /reportDefinition HTTP/1.1
Content-type: application/json
{
"destinationS3Location": {
"bucket": "string
",
"prefix": "string
"
},
"format": "string
",
"reportDescription": "string
",
"reportFrequency": "string
",
"reportId": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- destinationS3Location
-
Required. Amazon Simple Storage Service (Amazon S3) location where Application Cost Profiler uploads the report.
Type: S3Location object
Required: Yes
- format
-
Required. The format to use for the generated report.
Type: String
Valid Values:
CSV | PARQUET
Required: Yes
- reportDescription
-
Required. Description of the report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*
Required: Yes
- reportFrequency
-
Required. The cadence to generate the report.
Type: String
Valid Values:
MONTHLY | DAILY | ALL
Required: Yes
- reportId
-
Required. ID of the report. You can choose any valid string matching the pattern for the ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[0-9A-Za-z\.\-_]+$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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.
- reportId
-
ID of the report.
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
- ServiceQuotaExceededException
-
Your request exceeds one or more of the service quotas.
HTTP Status Code: 402
- 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: