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 ]

create-scheduled-query

Description

Creates a scheduled query that runs CloudWatch Logs Insights queries at regular intervals. Scheduled queries enable proactive monitoring by automatically executing queries to detect patterns and anomalies in your log data. Query results can be delivered to Amazon S3 for analysis or further processing.

See also: AWS API Documentation

Synopsis

  create-scheduled-query
--name <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>]
[--tags <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

--name (string)

The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.

--description (string)

An optional description for the scheduled query to help identify its purpose and functionality.

--query-language (string)

The query language to use for the scheduled query. Valid values are LogsQL , PPL , and SQL .

Possible values:

  • CWLI
  • SQL
  • PPL

--query-string (string)

The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.

--log-group-identifiers (list)

An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.

(string)

Syntax:

"string" "string" ...

--schedule-expression (string)

A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.

--timezone (string)

The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.

--start-time-offset (long)

The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.

--destination-configuration (structure)

Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.

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 start time for the scheduled query in Unix epoch format. The query will not execute before this time.

--schedule-end-time (long)

The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.

--execution-role-arn (string)

The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.

--state (string)

The initial state of the scheduled query. Valid values are ENABLED and DISABLED . Default is ENABLED .

Possible values:

  • ENABLED
  • DISABLED

--tags (map)

Key-value pairs to associate with the scheduled query for resource management and cost allocation.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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 created scheduled query.

state -> (string)

The current state of the scheduled query.