Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.IoT.ListJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists jobs.

Synopsis

Creating a Request

listJobs :: ListJobs #

Creates a value of ListJobs with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ljStatus - An optional filter that lets you search for jobs that have the specified status.
ljThingGroupId - A filter that limits the returned jobs to those for the specified group.
ljNextToken - The token to retrieve the next set of results.
ljThingGroupName - A filter that limits the returned jobs to those for the specified group.
ljMaxResults - The maximum number of results to return per request.
ljTargetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

data ListJobs #

See: listJobs smart constructor.

Instances

Eq ListJobs #
Methods (==) :: ListJobs -> ListJobs -> Bool # (/=) :: ListJobs -> ListJobs -> Bool #
Data ListJobs #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobs -> c ListJobs # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobs # toConstr :: ListJobs -> Constr # dataTypeOf :: ListJobs -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ListJobs) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobs) # gmapT :: (forall b. Data b => b -> b) -> ListJobs -> ListJobs # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobs -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobs -> r # gmapQ :: (forall d. Data d => d -> u) -> ListJobs -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobs -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobs -> m ListJobs # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobs -> m ListJobs # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobs -> m ListJobs #
Read ListJobs #
Methods readsPrec :: Int -> ReadS ListJobs # readList :: ReadS [ListJobs] # readPrec :: ReadPrec ListJobs # readListPrec :: ReadPrec [ListJobs] #
Show ListJobs #
Methods showsPrec :: Int -> ListJobs -> ShowS # show :: ListJobs -> String # showList :: [ListJobs] -> ShowS #
Generic ListJobs #
Associated Types type Rep ListJobs :: * -> * # Methods from :: ListJobs -> Rep ListJobs x # to :: Rep ListJobs x -> ListJobs #
Hashable ListJobs #
Methods hashWithSalt :: Int -> ListJobs -> Int # hash :: ListJobs -> Int #
NFData ListJobs #
Methods rnf :: ListJobs -> () #
AWSRequest ListJobs #
Associated Types type Rs ListJobs :: * # Methods request :: ListJobs -> Request ListJobs # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListJobs -> ClientResponse -> m (Response ListJobs) #
ToHeaders ListJobs #
Methods toHeaders :: ListJobs -> [Header] #
ToPath ListJobs #
Methods toPath :: ListJobs -> ByteString #
ToQuery ListJobs #
Methods toQuery :: ListJobs -> QueryString #
type Rep ListJobs #
type Rep ListJobs = D1 * (MetaData "ListJobs" "Network.AWS.IoT.ListJobs" "amazonka-iot-1.6.0-7DkcvCU69a26FkRzomxomK" False) (C1 * (MetaCons "ListJobs'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_ljStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobStatus))) ((::) (S1 * (MetaSel (Just Symbol "_ljThingGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ljNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((::) (S1 * (MetaSel (Just Symbol "_ljThingGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_ljMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_ljTargetSelection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TargetSelection)))))))
type Rs ListJobs #
type Rs ListJobs = ListJobsResponse

Request Lenses

ljStatus :: Lens' ListJobs (Maybe JobStatus) #

An optional filter that lets you search for jobs that have the specified status.

ljThingGroupId :: Lens' ListJobs (Maybe Text) #

A filter that limits the returned jobs to those for the specified group.

ljNextToken :: Lens' ListJobs (Maybe Text) #

The token to retrieve the next set of results.

ljThingGroupName :: Lens' ListJobs (Maybe Text) #

A filter that limits the returned jobs to those for the specified group.

ljMaxResults :: Lens' ListJobs (Maybe Natural) #

The maximum number of results to return per request.

ljTargetSelection :: Lens' ListJobs (Maybe TargetSelection) #

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Destructuring the Response

listJobsResponse #

Arguments

:: Int	`ljrsResponseStatus`
-> ListJobsResponse

Creates a value of ListJobsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ljrsJobs - A list of jobs.
ljrsNextToken - The token for the next set of results, or null if there are no additional results.
ljrsResponseStatus - -- | The response status code.

data ListJobsResponse #

See: listJobsResponse smart constructor.

Instances

Eq ListJobsResponse #
Methods (==) :: ListJobsResponse -> ListJobsResponse -> Bool # (/=) :: ListJobsResponse -> ListJobsResponse -> Bool #
Data ListJobsResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobsResponse -> c ListJobsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobsResponse # toConstr :: ListJobsResponse -> Constr # dataTypeOf :: ListJobsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ListJobsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobsResponse) # gmapT :: (forall b. Data b => b -> b) -> ListJobsResponse -> ListJobsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListJobsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobsResponse -> m ListJobsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsResponse -> m ListJobsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsResponse -> m ListJobsResponse #
Read ListJobsResponse #
Methods readsPrec :: Int -> ReadS ListJobsResponse # readList :: ReadS [ListJobsResponse] # readPrec :: ReadPrec ListJobsResponse # readListPrec :: ReadPrec [ListJobsResponse] #
Show ListJobsResponse #
Methods showsPrec :: Int -> ListJobsResponse -> ShowS # show :: ListJobsResponse -> String # showList :: [ListJobsResponse] -> ShowS #
Generic ListJobsResponse #
Associated Types type Rep ListJobsResponse :: * -> * # Methods from :: ListJobsResponse -> Rep ListJobsResponse x # to :: Rep ListJobsResponse x -> ListJobsResponse #
NFData ListJobsResponse #
Methods rnf :: ListJobsResponse -> () #
type Rep ListJobsResponse #
type Rep ListJobsResponse = D1 * (MetaData "ListJobsResponse" "Network.AWS.IoT.ListJobs" "amazonka-iot-1.6.0-7DkcvCU69a26FkRzomxomK" False) (C1 * (MetaCons "ListJobsResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ljrsJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [JobSummary]))) ((::) (S1 * (MetaSel (Just Symbol "_ljrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ljrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ljrsJobs :: Lens' ListJobsResponse [JobSummary] #

A list of jobs.

ljrsNextToken :: Lens' ListJobsResponse (Maybe Text) #

The token for the next set of results, or null if there are no additional results.

ljrsResponseStatus :: Lens' ListJobsResponse Int #

- | The response status code.