Method: Aws::Scheduler::Client#list_schedule_groups

Defined in:

lib/aws-sdk-scheduler/client.rb

#list_schedule_groups(params = {}) ⇒ Types::ListScheduleGroupsOutput

Returns a paginated list of your schedule groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_schedule_groups({
  max_results: 1,
  name_prefix: "ScheduleGroupNamePrefix",
  next_token: "NextToken",
})

Response structure

resp.next_token #=> String
resp.schedule_groups #=> Array
resp.schedule_groups[0].arn #=> String
resp.schedule_groups[0].creation_date #=> Time
resp.schedule_groups[0].last_modification_date #=> Time
resp.schedule_groups[0].name #=> String
resp.schedule_groups[0].state #=> String, one of "ACTIVE", "DELETING"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :max_results (Integer) —

  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.

• :name_prefix (String) —

  The name prefix that you can use to return a filtered list of your schedule groups.

• :next_token (String) —

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

Returns:

• (Types::ListScheduleGroupsOutput) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #schedule_groups => Array<Types::ScheduleGroupSummary>

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-scheduler/client.rb', line 978

def list_schedule_groups(params = {}, options = {})
  req = build_request(:list_schedule_groups, params)
  req.send_request(options)
end