create-scheduled-report¶

Description¶

Creates a new scheduled report for a dashboard. A scheduled report automatically generates and delivers dashboard snapshots on a recurring schedule. Reports are delivered within 15 minutes of the scheduled delivery time.

Synopsis¶

  create-scheduled-report
--scheduled-report <value>
[--resource-tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--scheduled-report (structure) [required]

The configuration for the scheduled report, including the dashboard to report on, the schedule, and the execution role that the service will use to generate the dashboard snapshot.

name -> (string) [required]

The name of the scheduled report.

Constraints:

min: 2

max: 50

pattern: (?!.* {2})[a-zA-Z][a-zA-Z0-9 _-]{0,48}[a-zA-Z0-9_-]

dashboardArn -> (string) [required]

The ARN of the dashboard to generate the scheduled report from.

Constraints:

min: 20

max: 2048

pattern: arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\*|[-a-z0-9]+)

scheduledReportExecutionRoleArn -> (string) [required]

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.

Constraints:

min: 20

max: 2048

pattern: arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_/-]+

scheduleConfig -> (structure) [required]

The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED .

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

Constraints:

min: 0

max: 1024

pattern: [\S\s]*

scheduleExpressionTimeZone -> (string)

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

Constraints:

min: 0

max: 1024

pattern: [\S\s]*

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.

Possible values:

ENABLED

DISABLED

description -> (string)

A description of the scheduled report’s purpose or contents.

Constraints:

min: 1

max: 200

pattern: (?!.* {2})[ a-zA-Z0-9.,!?;:@#$%&\-_/\\]*

widgetIds -> (list)

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

Constraints:

min: 0

max: 1

(string)

widgetDateRangeOverride -> (structure)

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

startTime -> (structure) [required]

The start time of the date range for querying data.

type -> (string) [required]

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

Possible values:

ABSOLUTE

RELATIVE

value -> (string) [required]

The actual date/time value.

Constraints:

min: 0

max: 1024

pattern: [\S\s]*

endTime -> (structure) [required]

The end time of the date range for querying data.

type -> (string) [required]

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

Possible values:

ABSOLUTE

RELATIVE

value -> (string) [required]

The actual date/time value.

Constraints:

min: 0

max: 1024

pattern: [\S\s]*

Shorthand Syntax:

name=string,dashboardArn=string,scheduledReportExecutionRoleArn=string,scheduleConfig={scheduleExpression=string,scheduleExpressionTimeZone=string,schedulePeriod={startTime=timestamp,endTime=timestamp},state=string},description=string,widgetIds=string,string,widgetDateRangeOverride={startTime={type=string,value=string},endTime={type=string,value=string}}

JSON Syntax:

{
  "name": "string",
  "dashboardArn": "string",
  "scheduledReportExecutionRoleArn": "string",
  "scheduleConfig": {
    "scheduleExpression": "string",
    "scheduleExpressionTimeZone": "string",
    "schedulePeriod": {
      "startTime": timestamp,
      "endTime": timestamp
    },
    "state": "ENABLED"|"DISABLED"
  },
  "description": "string",
  "widgetIds": ["string", ...],
  "widgetDateRangeOverride": {
    "startTime": {
      "type": "ABSOLUTE"|"RELATIVE",
      "value": "string"
    },
    "endTime": {
      "type": "ABSOLUTE"|"RELATIVE",
      "value": "string"
    }
  }
}

--resource-tags (list)

The tags to apply to the scheduled report resource for organization and management.

Constraints:

min: 0

max: 200

(structure)

A key-value pair that can be attached to a dashboard for organization and management purposes.

key -> (string) [required]

The key of the tag to be attached to the dashboard resource.

Constraints:

min: 1

max: 128

pattern: [\S\s]*

value -> (string) [required]

The value of the tag to be attached to the dashboard resource.

Constraints:

min: 0

max: 256

pattern: [\S\s]*

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:

min: 1

max: 128

pattern: [\u0021-\u007E]+

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

arn -> (string)

The ARN of the newly created scheduled report.

Constraints:

min: 20

max: 2048

pattern: arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:scheduled-report/(\*|[-a-z0-9]+)

Table of Contents

Feedback

User Guide