ListScheduledQueries - Amazon CloudWatch Logs

ListScheduledQueries

Lists all scheduled queries in the current AWS account and region with optional filtering by state.

Request Syntax

{ "maxResults": number, "nextToken": "string", "state": "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 scheduled queries to return in a single call.

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

state

Filter results by the state of scheduled queries (ENABLED or DISABLED).

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax

{ "nextToken": "string", "scheduledQueries": [ { "creationTime": number, "destinationConfiguration": { "s3Configuration": { "destinationIdentifier": "string", "roleArn": "string" } }, "lastExecutionStatus": "string", "lastTriggeredTime": number, "lastUpdatedTime": number, "name": "string", "scheduledQueryArn": "string", "scheduleExpression": "string", "state": "string", "timezone": "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

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

Type: String

Length Constraints: Minimum length of 1.

scheduledQueries

The list of scheduled queries with summary information.

Type: Array of ScheduledQuerySummary 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 is typically a temporary issue and the request can be retried.

HTTP Status Code: 500

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: