[ aws . alexaforbusiness ]



Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--schedule-name <value>]
[--s3-bucket-name <value>]
[--s3-key-prefix <value>]
--format <value>
--content-range <value>
[--recurrence <value>]
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--schedule-name (string)

The name identifier of the schedule.

--s3-bucket-name (string)

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.

--s3-key-prefix (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).

Possible values:

  • CSV


--content-range (structure)

The content range of the reports.

Interval -> (string)

The interval of the content range.

Shorthand Syntax:


JSON Syntax:

  "Interval": "ONE_DAY"|"ONE_WEEK"|"THIRTY_DAYS"

--recurrence (structure)

The recurrence of the reports. If this isn’t specified, the report will only be delivered one time when the API is called.

StartDate -> (string)

The start date.

Shorthand Syntax:


JSON Syntax:

  "StartDate": "string"

--client-request-token (string)

The client request token.

--tags (list)

The tags for the business report schedule.


A key-value pair that can be associated with a resource.

Key -> (string)

The key of a tag. Tag keys are case-sensitive.

Value -> (string)

The value of a tag. Tag values are case sensitive and can be null.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


ScheduleArn -> (string)

The ARN of the business report schedule.