AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . logs ]

update-scheduled-query

Description

Updates an existing scheduled query with new configuration. This operation uses PUT semantics, allowing modification of query parameters, schedule, and destinations.

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

Options

--identifier (string)

The ARN or name of the scheduled query to update.

--description (string)

An updated description for the scheduled query.

--query-language (string)

The updated query language for the scheduled query.

Possible values:

  • CWLI
  • SQL
  • PPL

--query-string (string)

The updated query string to execute.

--log-group-identifiers (list)

The updated array of log group names or ARNs to query.

(string)

Syntax:

"string" "string" ...

--schedule-expression (string)

The updated cron expression that defines when the scheduled query runs.

--timezone (string)

The updated timezone for evaluating the schedule expression.

--start-time-offset (long)

The updated time offset in seconds that defines the lookback period for the query.

--destination-configuration (structure)

The updated configuration for where to deliver query results.

s3Configuration -> (structure)

Configuration for delivering query results to Amazon S3.

destinationIdentifier -> (string)

The Amazon S3 URI where query results are delivered. Must be a valid S3 URI format.

roleArn -> (string)

The ARN of the IAM role that grants permissions to write query results to the specified Amazon S3 destination.

Shorthand Syntax:

s3Configuration={destinationIdentifier=string,roleArn=string}

JSON Syntax:

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

--schedule-start-time (long)

The updated start time for the scheduled query in Unix epoch format.

--schedule-end-time (long)

The updated end time for the scheduled query in Unix epoch format.

--execution-role-arn (string)

The updated ARN of the IAM role that grants permissions to execute the query and deliver results.

--state (string)

The updated state of the scheduled query.

Possible values:

  • ENABLED
  • DISABLED

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

Output

scheduledQueryArn -> (string)

The ARN of the updated scheduled query.

name -> (string)

The name of the updated scheduled query.

description -> (string)

The description of the updated scheduled query.

queryLanguage -> (string)

The query language of the updated scheduled query.

queryString -> (string)

The query string of the updated scheduled query.

logGroupIdentifiers -> (list)

The log groups queried by the updated scheduled query.

(string)

scheduleExpression -> (string)

The cron expression of the updated scheduled query.

timezone -> (string)

The timezone of the updated scheduled query.

startTimeOffset -> (long)

The time offset of the updated scheduled query.

destinationConfiguration -> (structure)

The destination configuration of the updated scheduled query.

s3Configuration -> (structure)

Configuration for delivering query results to Amazon S3.

destinationIdentifier -> (string)

The Amazon S3 URI where query results are delivered. Must be a valid S3 URI format.

roleArn -> (string)

The ARN of the IAM role that grants permissions to write query results to the specified Amazon S3 destination.

state -> (string)

The state of the updated scheduled query.

lastTriggeredTime -> (long)

The timestamp when the updated scheduled query was last executed.

lastExecutionStatus -> (string)

The status of the most recent execution of the updated scheduled query.

scheduleStartTime -> (long)

The start time of the updated scheduled query.

scheduleEndTime -> (long)

The end time of the updated scheduled query.

executionRoleArn -> (string)

The execution role ARN of the updated scheduled query.

creationTime -> (long)

The timestamp when the scheduled query was originally created.

lastUpdatedTime -> (long)

The timestamp when the scheduled query was last updated.