Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . alexaforbusiness ]

list-business-report-schedules

Description

Lists the details of the schedules that a user configured.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-business-report-schedules is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: BusinessReportSchedules

Synopsis

  list-business-report-schedules
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

BusinessReportSchedules -> (list)

The schedule of the reports.

(structure)

The schedule of the usage report.

ScheduleArn -> (string)

The ARN of the business report schedule.

ScheduleName -> (string)

The name identifier of the schedule.

S3BucketName -> (string)

The S3 bucket name of the output reports.

S3KeyPrefix -> (string)

The S3 key where the report is delivered.

Format -> (string)

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

ContentRange -> (structure)

The content range of the reports.

Interval -> (string)

The interval of the content range.

Recurrence -> (structure)

The recurrence of the reports.

StartDate -> (string)

The start date.

LastBusinessReport -> (structure)

The details of the last business report delivery for a specified time interval.

Status -> (string)

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

FailureCode -> (string)

The failure code.

S3Location -> (structure)

The S3 location of the output reports.

Path -> (string)

The path of the business report.

BucketName -> (string)

The S3 bucket name of the output reports.

DeliveryTime -> (timestamp)

The time of report delivery.

DownloadUrl -> (string)

The download link where a user can download the report.

NextToken -> (string)

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