Updates an existing scheduled query with new configuration¶

Description¶

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

Usage¶

cloudwatchlogs_update_scheduled_query(identifier, description,
  queryLanguage, queryString, logGroupIdentifiers, scheduleExpression,
  timezone, startTimeOffset, endTimeOffset, destinationConfiguration,
  scheduleStartTime, scheduleEndTime, executionRoleArn, state)

Arguments¶

identifier

[required] The ARN or name of the scheduled query to update.
description

An updated description for the scheduled query.
queryLanguage

[required] The updated query language for the scheduled query.
queryString

[required] The updated query string to execute.
logGroupIdentifiers

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

[required] The updated cron expression that defines when the scheduled query runs.
timezone

The updated timezone for evaluating the schedule expression.
startTimeOffset

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

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

The updated configuration for where to deliver query results.
scheduleStartTime

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

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

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

The updated state of the scheduled query.

Value¶

A list with the following syntax:

list(
  scheduledQueryArn = "string",
  name = "string",
  description = "string",
  queryLanguage = "CWLI"|"SQL"|"PPL",
  queryString = "string",
  logGroupIdentifiers = list(
    "string"
  ),
  scheduleExpression = "string",
  timezone = "string",
  startTimeOffset = 123,
  endTimeOffset = 123,
  destinationConfiguration = list(
    s3Configuration = list(
      destinationIdentifier = "string",
      roleArn = "string",
      ownerAccountId = "string",
      kmsKeyId = "string"
    ),
    lookupTableConfiguration = list(
      tableName = "string",
      roleArn = "string",
      description = "string",
      kmsKeyId = "string",
      tags = list(
        "string"
      )
    )
  ),
  state = "ENABLED"|"DISABLED",
  scheduleType = "CUSTOMER_MANAGED"|"AWS_MANAGED",
  lastTriggeredTime = 123,
  lastExecutionStatus = "Running"|"InvalidQuery"|"Complete"|"Failed"|"Timeout",
  scheduleStartTime = 123,
  scheduleEndTime = 123,
  executionRoleArn = "string",
  creationTime = 123,
  lastUpdatedTime = 123
)

Request syntax¶

svc$update_scheduled_query(
  identifier = "string",
  description = "string",
  queryLanguage = "CWLI"|"SQL"|"PPL",
  queryString = "string",
  logGroupIdentifiers = list(
    "string"
  ),
  scheduleExpression = "string",
  timezone = "string",
  startTimeOffset = 123,
  endTimeOffset = 123,
  destinationConfiguration = list(
    s3Configuration = list(
      destinationIdentifier = "string",
      roleArn = "string",
      ownerAccountId = "string",
      kmsKeyId = "string"
    ),
    lookupTableConfiguration = list(
      tableName = "string",
      roleArn = "string",
      description = "string",
      kmsKeyId = "string",
      tags = list(
        "string"
      )
    )
  ),
  scheduleStartTime = 123,
  scheduleEndTime = 123,
  executionRoleArn = "string",
  state = "ENABLED"|"DISABLED"
)