CreateScheduledQueryRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-create-scheduled-query-request-schema.json",
  "title": "CreateScheduledQueryRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-scheduled-query-api-openapi.yml#/components/schemas/CreateScheduledQueryRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the scheduled query. The name must be unique within your account and region. Length must be between 1 and 300 characters."
    },
    "description": {
      "type": "string",
      "description": "An optional description for the scheduled query to help identify its purpose and functionality."
    },
    "queryLanguage": {
      "type": "string",
      "enum": [
        "CWLI",
        "SQL",
        "PPL"
      ],
      "description": "The query language to use for the scheduled query. Valid values are CWLI, PPL, and SQL."
    },
    "queryString": {
      "type": "string",
      "description": "The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters."
    },
    "logGroupIdentifiers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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."
    },
    "scheduleExpression": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone."
    },
    "startTimeOffset": {
      "type": "integer",
      "description": "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."
    },
    "endTimeOffset": {
      "type": "integer",
      "description": "The time offset in seconds that defines the end of the lookback period for the query. Together with startTimeOffset, this determines the time window relative to the execution time over which the query runs."
    },
    "destinationConfiguration": {
      "$ref": "#/$defs/DestinationConfiguration"
    },
    "scheduleStartTime": {
      "type": "integer",
      "description": "The start time for the scheduled query in Unix epoch format. The query will not execute before this time."
    },
    "scheduleEndTime": {
      "type": "integer",
      "description": "The end time for the scheduled query in Unix epoch format. The query will stop executing after this time."
    },
    "executionRoleArn": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "enum": [
        "ENABLED",
        "DISABLED"
      ],
      "description": "The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED."
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value pairs to associate with the scheduled query for resource management and cost allocation."
    }
  },
  "required": [
    "name",
    "queryLanguage",
    "queryString",
    "scheduleExpression",
    "executionRoleArn"
  ],
  "$defs": {
    "DestinationConfiguration": {
      "type": "object",
      "properties": {
        "s3Configuration": {
          "$ref": "#/$defs/S3Configuration"
        },
        "lookupTableConfiguration": {
          "$ref": "#/$defs/LookupTableConfiguration"
        }
      }
    },
    "LookupTableConfiguration": {
      "type": "object",
      "properties": {
        "tableName": {
          "type": "string",
          "description": "The name of the lookup table to create or update with query results. The name can contain only alphanumeric characters and underscores."
        },
        "roleArn": {
          "type": "string",
          "description": "The ARN of the IAM role that grants permissions to create or update the lookup table with query results."
        },
        "description": {
          "type": "string",
          "description": "A description of the lookup table."
        },
        "kmsKeyId": {
          "type": "string",
          "description": "The ARN of the KMS key to use to encrypt the lookup table data. If you don't specify a key, the data is encrypted with an Amazon Web Services-owned key."
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Key-value pairs to associate with the lookup table for resource management and cost allocation. The service applies tags only during initial table creation."
        }
      },
      "required": [
        "tableName",
        "roleArn"
      ]
    },
    "S3Configuration": {
      "type": "object",
      "properties": {
        "destinationIdentifier": {
          "type": "string",
          "description": "The Amazon S3 URI where query results are delivered. Must be a valid S3 URI format."
        },
        "roleArn": {
          "type": "string",
          "description": "The ARN of the IAM role that grants permissions to write query results to the specified Amazon S3 destination."
        },
        "ownerAccountId": {
          "type": "string",
          "description": "The Amazon Web Services accountId for the bucket owning account."
        },
        "kmsKeyId": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the KMS encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket."
        }
      },
      "required": [
        "destinationIdentifier",
        "roleArn"
      ]
    }
  }
}