Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Scheduler.ListScheduleGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a paginated list of your schedule groups.

This operation returns paginated results.

Synopsis

data ListScheduleGroups = ListScheduleGroups' {
- maxResults :: Maybe Natural
- namePrefix :: Maybe Text
- nextToken :: Maybe Text
}
newListScheduleGroups :: ListScheduleGroups
listScheduleGroups_maxResults :: Lens' ListScheduleGroups (Maybe Natural)
listScheduleGroups_namePrefix :: Lens' ListScheduleGroups (Maybe Text)
listScheduleGroups_nextToken :: Lens' ListScheduleGroups (Maybe Text)
data ListScheduleGroupsResponse = ListScheduleGroupsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- scheduleGroups :: [ScheduleGroupSummary]
}
newListScheduleGroupsResponse :: Int -> ListScheduleGroupsResponse
listScheduleGroupsResponse_nextToken :: Lens' ListScheduleGroupsResponse (Maybe Text)
listScheduleGroupsResponse_httpStatus :: Lens' ListScheduleGroupsResponse Int
listScheduleGroupsResponse_scheduleGroups :: Lens' ListScheduleGroupsResponse [ScheduleGroupSummary]

Creating a Request

data ListScheduleGroups Source #

See: newListScheduleGroups smart constructor.

Constructors

ListScheduleGroups'

Fields

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

Instances

Instances details

ToHeaders ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods toHeaders :: ListScheduleGroups -> [Header] #
ToPath ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods toPath :: ListScheduleGroups -> ByteString #
ToQuery ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods toQuery :: ListScheduleGroups -> QueryString #
AWSPager ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods page :: ListScheduleGroups -> AWSResponse ListScheduleGroups -> Maybe ListScheduleGroups #
AWSRequest ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Associated Types type AWSResponse ListScheduleGroups # Methods request :: (Service -> Service) -> ListScheduleGroups -> Request ListScheduleGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListScheduleGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListScheduleGroups))) #
Generic ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Associated Types type Rep ListScheduleGroups :: Type -> Type # Methods from :: ListScheduleGroups -> Rep ListScheduleGroups x # to :: Rep ListScheduleGroups x -> ListScheduleGroups #
Read ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods readsPrec :: Int -> ReadS ListScheduleGroups # readList :: ReadS [ListScheduleGroups] # readPrec :: ReadPrec ListScheduleGroups # readListPrec :: ReadPrec [ListScheduleGroups] #
Show ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods showsPrec :: Int -> ListScheduleGroups -> ShowS # show :: ListScheduleGroups -> String # showList :: [ListScheduleGroups] -> ShowS #
NFData ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods rnf :: ListScheduleGroups -> () #
Eq ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods (==) :: ListScheduleGroups -> ListScheduleGroups -> Bool # (/=) :: ListScheduleGroups -> ListScheduleGroups -> Bool #
Hashable ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods hashWithSalt :: Int -> ListScheduleGroups -> Int # hash :: ListScheduleGroups -> Int #
type AWSResponse ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups type AWSResponse ListScheduleGroups = ListScheduleGroupsResponse
type Rep ListScheduleGroups Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups type Rep ListScheduleGroups = D1 ('MetaData "ListScheduleGroups" "Amazonka.Scheduler.ListScheduleGroups" "amazonka-scheduler-2.0-8LKlva3Whvt7TpHIvtcn6a" 'False) (C1 ('MetaCons "ListScheduleGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "namePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListScheduleGroups :: ListScheduleGroups Source #

Create a value of ListScheduleGroups with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListScheduleGroups', listScheduleGroups_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.

$sel:namePrefix:ListScheduleGroups', listScheduleGroups_namePrefix - The name prefix that you can use to return a filtered list of your schedule groups.

ListScheduleGroups, listScheduleGroups_nextToken - The token returned by a previous call to retrieve the next set of results.

Request Lenses

listScheduleGroups_maxResults :: Lens' ListScheduleGroups (Maybe Natural) Source #

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.

listScheduleGroups_namePrefix :: Lens' ListScheduleGroups (Maybe Text) Source #

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

listScheduleGroups_nextToken :: Lens' ListScheduleGroups (Maybe Text) Source #

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

Destructuring the Response

data ListScheduleGroupsResponse Source #

See: newListScheduleGroupsResponse smart constructor.

Constructors

ListScheduleGroupsResponse'
Fields nextToken :: Maybe Text Indicates whether there are additional results to retrieve. If the value is null, there are no more results. httpStatus :: Int The response's http status code. scheduleGroups :: [ScheduleGroupSummary] The schedule groups that match the specified criteria.

Instances

Instances details

Generic ListScheduleGroupsResponse Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Associated Types type Rep ListScheduleGroupsResponse :: Type -> Type # Methods from :: ListScheduleGroupsResponse -> Rep ListScheduleGroupsResponse x # to :: Rep ListScheduleGroupsResponse x -> ListScheduleGroupsResponse #
Read ListScheduleGroupsResponse Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods readsPrec :: Int -> ReadS ListScheduleGroupsResponse # readList :: ReadS [ListScheduleGroupsResponse] # readPrec :: ReadPrec ListScheduleGroupsResponse # readListPrec :: ReadPrec [ListScheduleGroupsResponse] #
Show ListScheduleGroupsResponse Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods showsPrec :: Int -> ListScheduleGroupsResponse -> ShowS # show :: ListScheduleGroupsResponse -> String # showList :: [ListScheduleGroupsResponse] -> ShowS #
NFData ListScheduleGroupsResponse Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods rnf :: ListScheduleGroupsResponse -> () #
Eq ListScheduleGroupsResponse Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups Methods (==) :: ListScheduleGroupsResponse -> ListScheduleGroupsResponse -> Bool # (/=) :: ListScheduleGroupsResponse -> ListScheduleGroupsResponse -> Bool #
type Rep ListScheduleGroupsResponse Source #
Instance details Defined in Amazonka.Scheduler.ListScheduleGroups type Rep ListScheduleGroupsResponse = D1 ('MetaData "ListScheduleGroupsResponse" "Amazonka.Scheduler.ListScheduleGroups" "amazonka-scheduler-2.0-8LKlva3Whvt7TpHIvtcn6a" 'False) (C1 ('MetaCons "ListScheduleGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "scheduleGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ScheduleGroupSummary]))))

newListScheduleGroupsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListScheduleGroupsResponse'`
-> ListScheduleGroupsResponse

Create a value of ListScheduleGroupsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:httpStatus:ListScheduleGroupsResponse', listScheduleGroupsResponse_httpStatus - The response's http status code.

$sel:scheduleGroups:ListScheduleGroupsResponse', listScheduleGroupsResponse_scheduleGroups - The schedule groups that match the specified criteria.

Response Lenses

listScheduleGroupsResponse_nextToken :: Lens' ListScheduleGroupsResponse (Maybe Text) Source #

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

listScheduleGroupsResponse_httpStatus :: Lens' ListScheduleGroupsResponse Int Source #

The response's http status code.

listScheduleGroupsResponse_scheduleGroups :: Lens' ListScheduleGroupsResponse [ScheduleGroupSummary] Source #

The schedule groups that match the specified criteria.