CreateBusinessReportSchedule
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
Request Syntax
{
"ClientRequestToken": "string
",
"ContentRange": {
"Interval": "string
"
},
"Format": "string
",
"Recurrence": {
"StartDate": "string
"
},
"S3BucketName": "string
",
"S3KeyPrefix": "string
",
"ScheduleName": "string
",
"Tags": [
{
"Key": "string
",
"Value": "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.
- ClientRequestToken
-
The client request token.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 150.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
Required: No
- ContentRange
-
The content range of the reports.
Type: BusinessReportContentRange object
Required: Yes
- Format
-
The format of the generated report (individual CSV files or zipped files of individual files).
Type: String
Valid Values:
CSV | CSV_ZIP
Required: Yes
- Recurrence
-
The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
Type: BusinessReportRecurrence object
Required: No
- S3BucketName
-
The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
Type: String
Pattern:
[a-z0-9-\.]{3,63}
Required: No
- S3KeyPrefix
-
The S3 key where the report is delivered.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Pattern:
[A-Za-z0-9!_\-\.\*'()/]*
Required: No
- ScheduleName
-
The name identifier of the schedule.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
Required: No
- Tags
-
The tags for the business report schedule.
Type: Array of Tag objects
Required: No
Response Syntax
{
"ScheduleArn": "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.
- ScheduleArn
-
The ARN of the business report schedule.
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
The resource being created already exists.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: