Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetScheduledQueryHistory

Retrieves the execution history of a scheduled query within a specified time range, including query results and destination processing status.

Request Syntax


{
   "endTime": number,
   "executionStatuses": [ "string" ],
   "identifier": "string",
   "maxResults": number,
   "nextToken": "string",
   "startTime": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

endTime

The end time for the history query in Unix epoch format.

Type: Long

Valid Range: Minimum value of 0.

Required: Yes

executionStatuses

An array of execution statuses to filter the history results. Only executions with the specified statuses are returned.

Type: Array of strings

Valid Values: Running | InvalidQuery | Complete | Failed | Timeout

Required: No

identifier

The ARN or name of the scheduled query to retrieve history for.

Type: String

Pattern: [\w#+=/:,.@-]*

Required: Yes

maxResults

The maximum number of history records to return. Valid range is 1 to 1000.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

The token for the next set of items to return. The token expires after 24 hours.

Type: String

Length Constraints: Minimum length of 1.

Required: No

startTime

The start time for the history query in Unix epoch format.

Type: Long

Valid Range: Minimum value of 0.

Required: Yes

Response Syntax


{
   "name": "string",
   "nextToken": "string",
   "scheduledQueryArn": "string",
   "triggerHistory": [ 
      { 
         "destinations": [ 
            { 
               "destinationIdentifier": "string",
               "destinationType": "string",
               "errorMessage": "string",
               "processedIdentifier": "string",
               "status": "string"
            }
         ],
         "errorMessage": "string",
         "executionStatus": "string",
         "queryId": "string",
         "triggeredTimestamp": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

name

The name of the scheduled query.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9_\-/.#]+$

nextToken

The token for the next set of items to return. The token expires after 24 hours.

Type: String

Length Constraints: Minimum length of 1.

scheduledQueryArn

The ARN of the scheduled query.

Type: String

triggerHistory

An array of execution history records for the scheduled query.

Type: Array of TriggerHistoryRecord objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permissions to perform this action.

HTTP Status Code: 400

InternalServerException

An internal server error occurred while processing the request. This exception is returned when the service encounters an unexpected condition that prevents it from fulfilling the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 400

ValidationException

One of the parameters for the request is not valid.

HTTP Status Code: 400