Alexa For Business
Alexa for Business API (API Version 2017-11-09)

UpdateBusinessReportSchedule

Updates the configuration of the report delivery schedule with the specified schedule ARN.

Request Syntax

{ "Format": "string", "Recurrence": { "StartDate": "string" }, "S3BucketName": "string", "S3KeyPrefix": "string", "ScheduleArn": "string", "ScheduleName": "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.

Format

The format of the generated report (individual CSV files or zipped files of individual files).

Type: String

Valid Values: CSV | CSV_ZIP

Required: No

Recurrence

The recurrence of the reports.

Type: BusinessReportRecurrence object

Required: No

S3BucketName

The S3 location of the output reports.

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

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}

Required: Yes

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

ConcurrentModificationException

HTTP Status Code: 400

NotFoundException

The resource is not found.

HTTP Status Code: 400

See Also

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