AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bcm-dashboards ]

update-scheduled-report

Description

Updates an existing scheduled report’s properties, including its name, description, schedule configuration, and widget settings. Only the parameters included in the request are updated; all other properties remain unchanged.

See also: AWS API Documentation

Synopsis

  update-scheduled-report
--arn <value>
[--name <value>]
[--description <value>]
[--dashboard-arn <value>]
[--scheduled-report-execution-role-arn <value>]
[--schedule-config <value>]
[--widget-ids <value>]
[--widget-date-range-override <value>]
[--clear-widget-ids | --no-clear-widget-ids]
[--clear-widget-date-range-override | --no-clear-widget-date-range-override]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--arn (string)

The ARN of the scheduled report to update.

--name (string)

The new name for the scheduled report.

--description (string)

The new description for the scheduled report.

--dashboard-arn (string)

The ARN of the dashboard to associate with the scheduled report.

--scheduled-report-execution-role-arn (string)

The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.

--schedule-config (structure)

The updated schedule configuration for the report.

scheduleExpression -> (string)

The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year) .

scheduleExpressionTimeZone -> (string)

The time zone for the schedule expression, for example, UTC .

schedulePeriod -> (structure)

The time period during which the schedule is active.

startTime -> (timestamp)

The start time of the schedule period. If not specified, defaults to the time of the create or update request. The start time cannot be more than 5 minutes before the time of the request.

endTime -> (timestamp)

The end time of the schedule period. If not specified, defaults to 3 years from the time of the create or update request. The maximum allowed value is 3 years from the current time. Setting an end time beyond this limit returns a ValidationException .

state -> (string)

The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.

Shorthand Syntax:

scheduleExpression=string,scheduleExpressionTimeZone=string,schedulePeriod={startTime=timestamp,endTime=timestamp},state=string

JSON Syntax:

{
  "scheduleExpression": "string",
  "scheduleExpressionTimeZone": "string",
  "schedulePeriod": {
    "startTime": timestamp,
    "endTime": timestamp
  },
  "state": "ENABLED"|"DISABLED"
}

--widget-ids (list)

The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.

(string)

Syntax:

"string" "string" ...

--widget-date-range-override (structure)

The date range override to apply to widgets in the scheduled report.

startTime -> (structure)

The start time of the date range for querying data.

type -> (string)

The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.

value -> (string)

The actual date/time value.

endTime -> (structure)

The end time of the date range for querying data.

type -> (string)

The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.

value -> (string)

The actual date/time value.

Shorthand Syntax:

startTime={type=string,value=string},endTime={type=string,value=string}

JSON Syntax:

{
  "startTime": {
    "type": "ABSOLUTE"|"RELATIVE",
    "value": "string"
  },
  "endTime": {
    "type": "ABSOLUTE"|"RELATIVE",
    "value": "string"
  }
}

--clear-widget-ids | --no-clear-widget-ids (boolean)

Set to true to clear existing widgetIds.

--clear-widget-date-range-override | --no-clear-widget-date-range-override (boolean)

Set to true to clear existing widgetDateRangeOverride.

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

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

arn -> (string)

The ARN of the updated scheduled report.