ListScheduledQueries
Gets a list of all scheduled queries in the caller's Amazon account and Region.
ListScheduledQueries
is eventually consistent.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
"
}
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.
- MaxResults
-
The maximum number of items to return in the output. If the total number of items available is more than the value specified, a
NextToken
is provided in the output. To resume pagination, provide theNextToken
value as the argument to the subsequent call toListScheduledQueriesRequest
.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
A pagination token to resume pagination.
Type: String
Required: No
Response Syntax
{
"NextToken": "string",
"ScheduledQueries": [
{
"Arn": "string",
"CreationTime": number,
"ErrorReportConfiguration": {
"S3Configuration": {
"BucketName": "string",
"EncryptionOption": "string",
"ObjectKeyPrefix": "string"
}
},
"LastRunStatus": "string",
"Name": "string",
"NextInvocationTime": number,
"PreviousInvocationTime": number,
"State": "string",
"TargetDestination": {
"TimestreamDestination": {
"DatabaseName": "string",
"TableName": "string"
}
}
}
]
}
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.
- NextToken
-
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
- ScheduledQueries
-
A list of scheduled queries.
Type: Array of ScheduledQuery objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have the necessary permissions to access the account settings.
HTTP Status Code: 400
- InternalServerException
-
An internal server error occurred while processing the request.
HTTP Status Code: 400
- InvalidEndpointException
-
The requested endpoint is invalid.
HTTP Status Code: 400
- ThrottlingException
-
The request was throttled due to excessive requests.
HTTP Status Code: 400
- ValidationException
-
Invalid or malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: