/AWS1/CL_CWLGETSCHDDQUERYRSP¶
GetScheduledQueryResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_scheduledqueryarn TYPE /AWS1/CWLARN /AWS1/CWLARN¶
The Amazon Resource Name (ARN) of the scheduled query.
iv_name TYPE /AWS1/CWLSCHEDULEDQUERYNAME /AWS1/CWLSCHEDULEDQUERYNAME¶
The name of the scheduled query.
iv_description TYPE /AWS1/CWLSCHEDULEDQUERYDESC /AWS1/CWLSCHEDULEDQUERYDESC¶
The description of the scheduled query.
iv_querylanguage TYPE /AWS1/CWLQUERYLANGUAGE /AWS1/CWLQUERYLANGUAGE¶
The query language used by the scheduled query (LogsQL, PPL, or SQL).
iv_querystring TYPE /AWS1/CWLQUERYSTRING /AWS1/CWLQUERYSTRING¶
The CloudWatch Logs Insights query string being executed.
it_loggroupidentifiers TYPE /AWS1/CL_CWLSCHDQUERYLOGGRID00=>TT_SCHEDULEDQUERYLOGGROUPIDS TT_SCHEDULEDQUERYLOGGROUPIDS¶
The log group identifiers being queried by the scheduled query.
iv_scheduleexpression TYPE /AWS1/CWLSCHEDULEEXPRESSION /AWS1/CWLSCHEDULEEXPRESSION¶
The cron expression that defines when the scheduled query runs.
iv_timezone TYPE /AWS1/CWLSCHEDULETIMEZONE /AWS1/CWLSCHEDULETIMEZONE¶
The timezone in which the schedule expression is evaluated.
iv_starttimeoffset TYPE /AWS1/CWLSTARTTIMEOFFSET /AWS1/CWLSTARTTIMEOFFSET¶
Time offset in seconds from the execution time for the start of the query time range.
io_destinationconfiguration TYPE REF TO /AWS1/CL_CWLDESTINATIONCONF /AWS1/CL_CWLDESTINATIONCONF¶
Configuration for destinations where the query results are delivered.
iv_state TYPE /AWS1/CWLSCHEDULEDQUERYSTATE /AWS1/CWLSCHEDULEDQUERYSTATE¶
The current state of the scheduled query (ENABLED or DISABLED).
iv_lasttriggeredtime TYPE /AWS1/CWLTIMESTAMP /AWS1/CWLTIMESTAMP¶
The time when the scheduled query was last executed, in Unix epoch time.
iv_lastexecutionstatus TYPE /AWS1/CWLEXECUTIONSTATUS /AWS1/CWLEXECUTIONSTATUS¶
The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).
iv_schedulestarttime TYPE /AWS1/CWLTIMESTAMP /AWS1/CWLTIMESTAMP¶
The start time for the query schedule in Unix epoch time.
iv_scheduleendtime TYPE /AWS1/CWLTIMESTAMP /AWS1/CWLTIMESTAMP¶
The end time for the query schedule in Unix epoch time.
iv_executionrolearn TYPE /AWS1/CWLROLEARN /AWS1/CWLROLEARN¶
The ARN of the IAM role used to execute the scheduled query.
iv_creationtime TYPE /AWS1/CWLTIMESTAMP /AWS1/CWLTIMESTAMP¶
The time when the scheduled query was created, in Unix epoch time.
iv_lastupdatedtime TYPE /AWS1/CWLTIMESTAMP /AWS1/CWLTIMESTAMP¶
The time when the scheduled query was last updated, in Unix epoch time.
Queryable Attributes¶
scheduledQueryArn¶
The Amazon Resource Name (ARN) of the scheduled query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULEDQUERYARN() |
Getter for SCHEDULEDQUERYARN, with configurable default |
ASK_SCHEDULEDQUERYARN() |
Getter for SCHEDULEDQUERYARN w/ exceptions if field has no v |
HAS_SCHEDULEDQUERYARN() |
Determine if SCHEDULEDQUERYARN has a value |
name¶
The name of the scheduled query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
description¶
The description of the scheduled query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
queryLanguage¶
The query language used by the scheduled query (LogsQL, PPL, or SQL).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYLANGUAGE() |
Getter for QUERYLANGUAGE, with configurable default |
ASK_QUERYLANGUAGE() |
Getter for QUERYLANGUAGE w/ exceptions if field has no value |
HAS_QUERYLANGUAGE() |
Determine if QUERYLANGUAGE has a value |
queryString¶
The CloudWatch Logs Insights query string being executed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYSTRING() |
Getter for QUERYSTRING, with configurable default |
ASK_QUERYSTRING() |
Getter for QUERYSTRING w/ exceptions if field has no value |
HAS_QUERYSTRING() |
Determine if QUERYSTRING has a value |
logGroupIdentifiers¶
The log group identifiers being queried by the scheduled query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGGROUPIDENTIFIERS() |
Getter for LOGGROUPIDENTIFIERS, with configurable default |
ASK_LOGGROUPIDENTIFIERS() |
Getter for LOGGROUPIDENTIFIERS w/ exceptions if field has no |
HAS_LOGGROUPIDENTIFIERS() |
Determine if LOGGROUPIDENTIFIERS has a value |
scheduleExpression¶
The cron expression that defines when the scheduled query runs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULEEXPRESSION() |
Getter for SCHEDULEEXPRESSION, with configurable default |
ASK_SCHEDULEEXPRESSION() |
Getter for SCHEDULEEXPRESSION w/ exceptions if field has no |
HAS_SCHEDULEEXPRESSION() |
Determine if SCHEDULEEXPRESSION has a value |
timezone¶
The timezone in which the schedule expression is evaluated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIMEZONE() |
Getter for TIMEZONE, with configurable default |
ASK_TIMEZONE() |
Getter for TIMEZONE w/ exceptions if field has no value |
HAS_TIMEZONE() |
Determine if TIMEZONE has a value |
startTimeOffset¶
Time offset in seconds from the execution time for the start of the query time range.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTTIMEOFFSET() |
Getter for STARTTIMEOFFSET, with configurable default |
ASK_STARTTIMEOFFSET() |
Getter for STARTTIMEOFFSET w/ exceptions if field has no val |
HAS_STARTTIMEOFFSET() |
Determine if STARTTIMEOFFSET has a value |
destinationConfiguration¶
Configuration for destinations where the query results are delivered.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATIONCONFIGURATION() |
Getter for DESTINATIONCONFIGURATION |
state¶
The current state of the scheduled query (ENABLED or DISABLED).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
lastTriggeredTime¶
The time when the scheduled query was last executed, in Unix epoch time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTTRIGGEREDTIME() |
Getter for LASTTRIGGEREDTIME, with configurable default |
ASK_LASTTRIGGEREDTIME() |
Getter for LASTTRIGGEREDTIME w/ exceptions if field has no v |
HAS_LASTTRIGGEREDTIME() |
Determine if LASTTRIGGEREDTIME has a value |
lastExecutionStatus¶
The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTEXECUTIONSTATUS() |
Getter for LASTEXECUTIONSTATUS, with configurable default |
ASK_LASTEXECUTIONSTATUS() |
Getter for LASTEXECUTIONSTATUS w/ exceptions if field has no |
HAS_LASTEXECUTIONSTATUS() |
Determine if LASTEXECUTIONSTATUS has a value |
scheduleStartTime¶
The start time for the query schedule in Unix epoch time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULESTARTTIME() |
Getter for SCHEDULESTARTTIME, with configurable default |
ASK_SCHEDULESTARTTIME() |
Getter for SCHEDULESTARTTIME w/ exceptions if field has no v |
HAS_SCHEDULESTARTTIME() |
Determine if SCHEDULESTARTTIME has a value |
scheduleEndTime¶
The end time for the query schedule in Unix epoch time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULEENDTIME() |
Getter for SCHEDULEENDTIME, with configurable default |
ASK_SCHEDULEENDTIME() |
Getter for SCHEDULEENDTIME w/ exceptions if field has no val |
HAS_SCHEDULEENDTIME() |
Determine if SCHEDULEENDTIME has a value |
executionRoleArn¶
The ARN of the IAM role used to execute the scheduled query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONROLEARN() |
Getter for EXECUTIONROLEARN, with configurable default |
ASK_EXECUTIONROLEARN() |
Getter for EXECUTIONROLEARN w/ exceptions if field has no va |
HAS_EXECUTIONROLEARN() |
Determine if EXECUTIONROLEARN has a value |
creationTime¶
The time when the scheduled query was created, in Unix epoch time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
lastUpdatedTime¶
The time when the scheduled query was last updated, in Unix epoch time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDTIME() |
Getter for LASTUPDATEDTIME, with configurable default |
ASK_LASTUPDATEDTIME() |
Getter for LASTUPDATEDTIME w/ exceptions if field has no val |
HAS_LASTUPDATEDTIME() |
Determine if LASTUPDATEDTIME has a value |