[ aws . alexaforbusiness ]

update-business-report-schedule

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-business-report-schedule
--schedule-arn <value>
[--s3-bucket-name <value>]
[--s3-key-prefix <value>]
[--format <value>]
[--schedule-name <value>]
[--recurrence <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--schedule-arn (string)

The ARN of the business report schedule.

--s3-bucket-name (string)

The S3 location of the output reports.

--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

  • CSV_ZIP

--schedule-name (string)

The name identifier of the schedule.

--recurrence (structure)

The recurrence of the reports.

StartDate -> (string)

The start date.

Shorthand Syntax:

StartDate=string

JSON Syntax:

{
  "StartDate": "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.

Output

None