Scheduled query notification messages - Amazon Timestream

Amazon Timestream for LiveAnalytics will no longer be open to new customers starting June 20, 2025. If you would like to use Amazon Timestream for LiveAnalytics, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Timestream for LiveAnalytics availability change.

Scheduled query notification messages

This section describes the messages sent by Timestream for LiveAnalytics when creating, deleting, running, or updating the state of a scheduled query.

Notification message name Structure Description

CreatingNotificationMessage

 
CreatingNotificationMessage {
    String arn;
    NotificationType type;
}

This notification message is sent before sending the response for CreateScheduledQuery. The scheduled query is enabled after sending this notification.

arn - The ARN of the scheduled query that is being created.

type - SCHEDULED_QUERY_CREATING

UpdateNotificationMessage

 
 UpdateNotificationMessage {
    String arn;
    NotificationType type;
    QueryState state;
}

This notification message is sent when a scheduled query is updated. Timestream for LiveAnalytics can disable the scheduled query, automatically, in case non-recoverable error is encountered, such as:

  • AssumeRole failure

  • Any 4xx errors encountered when communicating with KMS when a customer managed KMS key is specified.

  • Any 4xx errors encountered during running of the scheduled query.

  • Any 4xx errors encountered during ingestion of query results

arn - The ARN of the scheduled query that is being updated.

type - SCHEDULED_QUERY_UPDATE

state - ENABLED or DISABLED

DeleteNotificationMessage

 
DeletionNotificationMessage {
    String arn;
    NotificationType type;
}

This notification message is sent when a scheduled query has been deleted.

arn - The ARN of the scheduled query that is being created.

type - SCHEDULED_QUERY_DELETED

SuccessNotificationMessage

 
SuccessNotificationMessage {
    NotificationType type;
    String arn;
    Date nextInvocationEpochSecond;
    ScheduledQueryRunSummary runSummary;
}

ScheduledQueryRunSummary {
    Date invocationTime;
    Date triggerTime;
    String runStatus;
    ExecutionStats executionstats;
    ErrorReportLocation errorReportLocation;
    String failureReason;
}


ExecutionStats {
    Long bytesMetered;
    Long dataWrites;
    Long queryResultRows;
    Long recordsIngested;
    Long executionTimeInMillis;
}


ErrorReportLocation {
    S3ReportLocation s3ReportLocation;
}


S3ReportLocation {
    String bucketName;
    String objectKey;
}

This notification message is sent after the scheduled query is run and the results are successfully ingested.

ARN - The ARN of the scheduled query that is being deleted.

NotificationType - AUTO_TRIGGER_SUCCESS or MANUAL_TRIGGER_SUCCESS.

nextInvocationEpochSecond - The next time Timestream for LiveAnalytics will run the scheduled query.

runSummary - Information about the scheduled query run.

FailureNotificationMessage

 
FailureNotificationMessage {
    NotificationType type;
    String arn;
    ScheduledQueryRunSummary runSummary;
}

ScheduledQueryRunSummary {
    Date invocationTime;
    Date triggerTime;
    String runStatus;
    ExecutionStats executionstats;
    ErrorReportLocation errorReportLocation;
    String failureReason;
}


ExecutionStats {
    Long bytesMetered;
    Long dataWrites;
    Long queryResultRows;
    Long recordsIngested;
    Long executionTimeInMillis;
}


ErrorReportLocation {
    S3ReportLocation s3ReportLocation;
}


S3ReportLocation {
    String bucketName;
    String objectKey;
}

This notification message is sent when a failure is encountered during a scheduled query run or when ingesting the query results.

arn - The ARN of the scheduled query that is being run.

type - AUTO_TRIGGER_FAILURE or MANUAL_TRIGGER_FAILURE.

runSummary - Information about the scheduled query run.