List Schedule Groups

eventbridgescheduler_list_schedule_groups

R Documentation

Returns a paginated list of your schedule groups

Description

Returns a paginated list of your schedule groups.

Usage

eventbridgescheduler_list_schedule_groups(MaxResults, NamePrefix,
  NextToken)

Arguments

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	The name prefix that you can use to return a filtered list of your schedule groups.
NextToken	The token returned by a previous call to retrieve the next set of results.

Value

A list with the following syntax:

list(
  NextToken = "string",
  ScheduleGroups = list(
    list(
      Arn = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      LastModificationDate = as.POSIXct(
        "2015-01-01"
      ),
      Name = "string",
      State = "ACTIVE"|"DELETING"
    )
  )
)

Request syntax

svc$list_schedule_groups(
  MaxResults = 123,
  NamePrefix = "string",
  NextToken = "string"
)