AWS CLI Command Reference

[ aws . logs ]

update-scheduled-query

Description

Updates the configuration of an existing scheduled query. This operation follows PUT semantics, replacing the existing configuration with the provided values.

See also: AWS API Documentation

Synopsis

  update-scheduled-query
--identifier <value>
[--description <value>]
--query-language <value>
--query-string <value>
[--log-group-identifiers <value>]
--schedule-expression <value>
[--timezone <value>]
[--start-time-offset <value>]
[--destination-configuration <value>]
[--schedule-start-time <value>]
[--schedule-end-time <value>]
--execution-role-arn <value>
[--state <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]

Options

--identifier (string) [required]

The name or ARN of the scheduled query to update.

Constraints:

  • pattern: [\w#+=/:,.@-]*

--description (string)

Updated description for the scheduled query.

Constraints:

  • max: 1024

--query-language (string) [required]

Updated query language to use (LogsQL, PPL, or SQL).

Possible values:

  • CWLI
  • SQL
  • PPL

--query-string (string) [required]

Updated CloudWatch Logs Insights query string to execute.

Constraints:

  • min: 0
  • max: 10000

--log-group-identifiers (list)

Updated log group identifiers to query.

Constraints:

  • min: 1
  • max: 50

(string)

Constraints:

  • min: 1
  • max: 2048
  • pattern: [\w#+=/:,.@-]*

Syntax:

"string" "string" ...

--schedule-expression (string) [required]

Updated cron expression that defines when the scheduled query runs.

Constraints:

  • max: 256

--timezone (string)

Updated timezone in which the schedule expression is evaluated.

Constraints:

  • min: 1

--start-time-offset (long)

Updated time offset in seconds from the execution time for the start of the query time range.

--destination-configuration (structure)

Updated configuration for destinations where the query results will be delivered.

s3Configuration -> (structure) [required]

Configuration for delivering query results to an Amazon S3 bucket.

destinationIdentifier -> (string) [required]

The S3 URI where query results will be stored (e.g., s3://bucket-name/prefix/).

Constraints:

  • max: 1024
  • pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

roleArn -> (string) [required]

The ARN of the IAM role that CloudWatch Logs will assume to write results to the S3 bucket.

Constraints:

  • min: 1

Shorthand Syntax:

s3Configuration={destinationIdentifier=string,roleArn=string}

JSON Syntax:

{
  "s3Configuration": {
    "destinationIdentifier": "string",
    "roleArn": "string"
  }
}

--schedule-start-time (long)

Updated start time for the query schedule in Unix epoch time.

Constraints:

  • min: 0

--schedule-end-time (long)

Updated end time for the query schedule in Unix epoch time.

Constraints:

  • min: 0

--execution-role-arn (string) [required]

Updated ARN of the IAM role that CloudWatch Logs will assume to execute the scheduled query.

Constraints:

  • min: 1

--state (string)

Updated state of the scheduled query (ENABLED or DISABLED).

Possible values:

  • ENABLED
  • DISABLED

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

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

Output

scheduledQueryArn -> (string)

The ARN of the updated scheduled query.

name -> (string)

The name of the updated scheduled query.

Constraints:

  • min: 1
  • max: 255
  • pattern: ^[a-zA-Z0-9_\-/.#]+$

description -> (string)

The description of the updated scheduled query.

Constraints:

  • max: 1024

queryLanguage -> (string)

The query language used by the updated scheduled query.

Possible values:

  • CWLI
  • SQL
  • PPL

queryString -> (string)

The query string of the updated scheduled query.

Constraints:

  • min: 0
  • max: 10000

logGroupIdentifiers -> (list)

The log group identifiers of the updated scheduled query.

Constraints:

  • min: 1
  • max: 50

(string)

Constraints:

  • min: 1
  • max: 2048
  • pattern: [\w#+=/:,.@-]*

scheduleExpression -> (string)

The schedule expression of the updated scheduled query.

Constraints:

  • max: 256

timezone -> (string)

The timezone of the updated scheduled query.

Constraints:

  • min: 1

startTimeOffset -> (long)

The start time offset of the updated scheduled query.

destinationConfiguration -> (structure)

The destination configuration of the updated scheduled query.

s3Configuration -> (structure) [required]

Configuration for delivering query results to an Amazon S3 bucket.

destinationIdentifier -> (string) [required]

The S3 URI where query results will be stored (e.g., s3://bucket-name/prefix/).

Constraints:

  • max: 1024
  • pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

roleArn -> (string) [required]

The ARN of the IAM role that CloudWatch Logs will assume to write results to the S3 bucket.

Constraints:

  • min: 1

state -> (string)

The state of the updated scheduled query.

Possible values:

  • ENABLED
  • DISABLED

lastTriggeredTime -> (long)

The time when the updated scheduled query was last executed.

Constraints:

  • min: 0

lastExecutionStatus -> (string)

The status of the last execution of the updated scheduled query (Running, Complete, Failed, Timeout, or InvalidQuery).

Possible values:

  • Running
  • InvalidQuery
  • Complete
  • Failed
  • Timeout

scheduleStartTime -> (long)

The schedule start time of the updated scheduled query.

Constraints:

  • min: 0

scheduleEndTime -> (long)

The schedule end time of the updated scheduled query.

Constraints:

  • min: 0

executionRoleArn -> (string)

The execution role ARN of the updated scheduled query.

Constraints:

  • min: 1

creationTime -> (long)

The creation time of the updated scheduled query.

Constraints:

  • min: 0

lastUpdatedTime -> (long)

The last updated time of the scheduled query.

Constraints:

  • min: 0
© Copyright 2025, Amazon Web Services. Created using Sphinx.