Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSchedules

Returns a paginated list of your EventBridge Scheduler schedules.

Request Syntax


GET /schedules?MaxResults=MaxResults&NamePrefix=NamePrefix&NextToken=NextToken&ScheduleGroup=GroupName&State=State HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

GroupName

If specified, only lists the schedules whose associated schedule group matches the given filter.

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

Pattern: ^[0-9a-zA-Z-_.]+$

MaxResults

If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

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

NamePrefix

Schedule name prefix to return the filtered list of resources.

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

Pattern: ^[0-9a-zA-Z-_.]+$

NextToken

The token returned by a previous call to retrieve the next set of results.

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

State

If specified, only lists the schedules whose current state matches the given filter.

Valid Values: ENABLED | DISABLED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Schedules": [ 
      { 
         "Arn": "string",
         "CreationDate": number,
         "GroupName": "string",
         "LastModificationDate": number,
         "Name": "string",
         "State": "string",
         "Target": { 
            "Arn": "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

Indicates whether there are additional results to retrieve. If the value is null, there are no more results.

Type: String

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

Schedules

The schedules that match the specified criteria.

Type: Array of ScheduleSummary objects

Errors

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

InternalServerException

Unexpected error encountered while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400