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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a paginated list of your EventBridge Scheduler schedules.

This operation returns paginated results.

Synopsis

data ListSchedules = ListSchedules' {
- groupName :: Maybe Text
- maxResults :: Maybe Natural
- namePrefix :: Maybe Text
- nextToken :: Maybe Text
- state :: Maybe ScheduleState
}
newListSchedules :: ListSchedules
listSchedules_groupName :: Lens' ListSchedules (Maybe Text)
listSchedules_maxResults :: Lens' ListSchedules (Maybe Natural)
listSchedules_namePrefix :: Lens' ListSchedules (Maybe Text)
listSchedules_nextToken :: Lens' ListSchedules (Maybe Text)
listSchedules_state :: Lens' ListSchedules (Maybe ScheduleState)
data ListSchedulesResponse = ListSchedulesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- schedules :: [ScheduleSummary]
}
newListSchedulesResponse :: Int -> ListSchedulesResponse
listSchedulesResponse_nextToken :: Lens' ListSchedulesResponse (Maybe Text)
listSchedulesResponse_httpStatus :: Lens' ListSchedulesResponse Int
listSchedulesResponse_schedules :: Lens' ListSchedulesResponse [ScheduleSummary]

Creating a Request

data ListSchedules Source #

See: newListSchedules smart constructor.

Constructors

ListSchedules'

Fields

groupName :: Maybe Text
If specified, only lists the schedules whose associated schedule group matches the given filter.
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
Schedule name prefix to return the filtered list of resources.
nextToken :: Maybe Text
The token returned by a previous call to retrieve the next set of results.
state :: Maybe ScheduleState
If specified, only lists the schedules whose current state matches the given filter.

Instances

Instances details

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

newListSchedules :: ListSchedules Source #

Create a value of ListSchedules 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:

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

$sel:maxResults:ListSchedules', listSchedules_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:ListSchedules', listSchedules_namePrefix - Schedule name prefix to return the filtered list of resources.

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

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

Request Lenses

listSchedules_groupName :: Lens' ListSchedules (Maybe Text) Source #

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

listSchedules_maxResults :: Lens' ListSchedules (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.

listSchedules_namePrefix :: Lens' ListSchedules (Maybe Text) Source #

Schedule name prefix to return the filtered list of resources.

listSchedules_nextToken :: Lens' ListSchedules (Maybe Text) Source #

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

listSchedules_state :: Lens' ListSchedules (Maybe ScheduleState) Source #

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

Destructuring the Response

data ListSchedulesResponse Source #

See: newListSchedulesResponse smart constructor.

Constructors

ListSchedulesResponse'
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. schedules :: [ScheduleSummary] The schedules that match the specified criteria.

Instances

Instances details

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

newListSchedulesResponse Source #

Arguments

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

Create a value of ListSchedulesResponse 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:

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

$sel:httpStatus:ListSchedulesResponse', listSchedulesResponse_httpStatus - The response's http status code.

$sel:schedules:ListSchedulesResponse', listSchedulesResponse_schedules - The schedules that match the specified criteria.

Response Lenses

listSchedulesResponse_nextToken :: Lens' ListSchedulesResponse (Maybe Text) Source #

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

listSchedulesResponse_httpStatus :: Lens' ListSchedulesResponse Int Source #

The response's http status code.

listSchedulesResponse_schedules :: Lens' ListSchedulesResponse [ScheduleSummary] Source #

The schedules that match the specified criteria.