Skip to content

Returns a paginated list of your EventBridge Scheduler schedules

Description

Returns a paginated list of your EventBridge Scheduler schedules.

Usage

eventbridgescheduler_list_schedules(GroupName, MaxResults, NamePrefix,
  NextToken, State)

Arguments

  • GroupName

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

  • 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.

  • NamePrefix

    Schedule name prefix to return the filtered list of resources.

  • NextToken

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

  • State

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

Value

A list with the following syntax:

list(
  NextToken = "string",
  Schedules = list(
    list(
      Arn = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      GroupName = "string",
      LastModificationDate = as.POSIXct(
        "2015-01-01"
      ),
      Name = "string",
      State = "ENABLED"|"DISABLED",
      Target = list(
        Arn = "string"
      )
    )
  )
)

Request syntax

svc$list_schedules(
  GroupName = "string",
  MaxResults = 123,
  NamePrefix = "string",
  NextToken = "string",
  State = "ENABLED"|"DISABLED"
)