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

ListBusinessReportSchedules

Lists the details of the schedules that a user configured.

Request Syntax

{ "MaxResults": number, "NextToken": "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.

MaxResults

The maximum number of schedules listed in the call.

Type: Integer

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

Required: No

NextToken

The token used to list the remaining schedules from the previous API call.

Type: String

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

Required: No

Response Syntax

{ "BusinessReportSchedules": [ { "ContentRange": { "Interval": "string" }, "Format": "string", "LastBusinessReport": { "DeliveryTime": number, "DownloadUrl": "string", "FailureCode": "string", "S3Location": { "BucketName": "string", "Path": "string" }, "Status": "string" }, "Recurrence": { "StartDate": "string" }, "S3BucketName": "string", "S3KeyPrefix": "string", "ScheduleArn": "string", "ScheduleName": "string" } ], "NextToken": "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.

BusinessReportSchedules

The schedule of the reports.

Type: Array of BusinessReportSchedule objects

NextToken

The token used to list the remaining schedules from the previous API call.

Type: String

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

Errors

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

See Also

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