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.ElasticTranscoder.ListJobsByStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

This operation returns paginated results.

Creating a Request

listJobsByStatus #

Arguments

:: Text	`ljbsStatus`
-> ListJobsByStatus

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

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

ljbsAscending - To list jobs in chronological order by the date and time that they were submitted, enter true . To list jobs in reverse chronological order, enter false .
ljbsPageToken - When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
ljbsStatus - To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted , Progressing , Complete , Canceled , or Error .

data ListJobsByStatus #

The ListJobsByStatusRequest structure.

See: listJobsByStatus smart constructor.

Instances

Eq ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods (==) :: ListJobsByStatus -> ListJobsByStatus -> Bool # (/=) :: ListJobsByStatus -> ListJobsByStatus -> Bool #
Data ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobsByStatus -> c ListJobsByStatus # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobsByStatus # toConstr :: ListJobsByStatus -> Constr # dataTypeOf :: ListJobsByStatus -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListJobsByStatus) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobsByStatus) # gmapT :: (forall b. Data b => b -> b) -> ListJobsByStatus -> ListJobsByStatus # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByStatus -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByStatus -> r # gmapQ :: (forall d. Data d => d -> u) -> ListJobsByStatus -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobsByStatus -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobsByStatus -> m ListJobsByStatus # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByStatus -> m ListJobsByStatus # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByStatus -> m ListJobsByStatus #
Read ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods readsPrec :: Int -> ReadS ListJobsByStatus # readList :: ReadS [ListJobsByStatus] # readPrec :: ReadPrec ListJobsByStatus # readListPrec :: ReadPrec [ListJobsByStatus] #
Show ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods showsPrec :: Int -> ListJobsByStatus -> ShowS # show :: ListJobsByStatus -> String # showList :: [ListJobsByStatus] -> ShowS #
Generic ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Associated Types type Rep ListJobsByStatus :: Type -> Type # Methods from :: ListJobsByStatus -> Rep ListJobsByStatus x # to :: Rep ListJobsByStatus x -> ListJobsByStatus #
Hashable ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods hashWithSalt :: Int -> ListJobsByStatus -> Int # hash :: ListJobsByStatus -> Int #
AWSPager ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods page :: ListJobsByStatus -> Rs ListJobsByStatus -> Maybe ListJobsByStatus #
AWSRequest ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Associated Types type Rs ListJobsByStatus :: Type # Methods request :: ListJobsByStatus -> Request ListJobsByStatus # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListJobsByStatus -> ClientResponse -> m (Response ListJobsByStatus) #
ToHeaders ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods toHeaders :: ListJobsByStatus -> [Header] #
ToPath ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods toPath :: ListJobsByStatus -> ByteString #
ToQuery ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods toQuery :: ListJobsByStatus -> QueryString #
NFData ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods rnf :: ListJobsByStatus -> () #
type Rep ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus type Rep ListJobsByStatus = D1 (MetaData "ListJobsByStatus" "Network.AWS.ElasticTranscoder.ListJobsByStatus" "amazonka-elastictranscoder-1.6.1-J2fDYMJzdmX6ru8jsTFFkp" False) (C1 (MetaCons "ListJobsByStatus'" PrefixI True) (S1 (MetaSel (Just "_ljbsAscending") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_ljbsPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ljbsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ListJobsByStatus #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus type Rs ListJobsByStatus = ListJobsByStatusResponse

Request Lenses

ljbsAscending :: Lens' ListJobsByStatus (Maybe Text) #

To list jobs in chronological order by the date and time that they were submitted, enter true . To list jobs in reverse chronological order, enter false .

ljbsPageToken :: Lens' ListJobsByStatus (Maybe Text) #

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

ljbsStatus :: Lens' ListJobsByStatus Text #

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted , Progressing , Complete , Canceled , or Error .

Destructuring the Response

listJobsByStatusResponse #

Arguments

:: Int	`ljbsrsResponseStatus`
-> ListJobsByStatusResponse

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

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

ljbsrsNextPageToken - A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null .
ljbsrsJobs - An array of Job objects that have the specified status.
ljbsrsResponseStatus - -- | The response status code.

data ListJobsByStatusResponse #

The ListJobsByStatusResponse structure.

See: listJobsByStatusResponse smart constructor.

Instances

Eq ListJobsByStatusResponse #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods (==) :: ListJobsByStatusResponse -> ListJobsByStatusResponse -> Bool # (/=) :: ListJobsByStatusResponse -> ListJobsByStatusResponse -> Bool #
Data ListJobsByStatusResponse #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobsByStatusResponse -> c ListJobsByStatusResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobsByStatusResponse # toConstr :: ListJobsByStatusResponse -> Constr # dataTypeOf :: ListJobsByStatusResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListJobsByStatusResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobsByStatusResponse) # gmapT :: (forall b. Data b => b -> b) -> ListJobsByStatusResponse -> ListJobsByStatusResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByStatusResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByStatusResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListJobsByStatusResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobsByStatusResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobsByStatusResponse -> m ListJobsByStatusResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByStatusResponse -> m ListJobsByStatusResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByStatusResponse -> m ListJobsByStatusResponse #
Read ListJobsByStatusResponse #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods readsPrec :: Int -> ReadS ListJobsByStatusResponse # readList :: ReadS [ListJobsByStatusResponse] # readPrec :: ReadPrec ListJobsByStatusResponse # readListPrec :: ReadPrec [ListJobsByStatusResponse] #
Show ListJobsByStatusResponse #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods showsPrec :: Int -> ListJobsByStatusResponse -> ShowS # show :: ListJobsByStatusResponse -> String # showList :: [ListJobsByStatusResponse] -> ShowS #
Generic ListJobsByStatusResponse #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Associated Types type Rep ListJobsByStatusResponse :: Type -> Type # Methods from :: ListJobsByStatusResponse -> Rep ListJobsByStatusResponse x # to :: Rep ListJobsByStatusResponse x -> ListJobsByStatusResponse #
NFData ListJobsByStatusResponse #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus Methods rnf :: ListJobsByStatusResponse -> () #
type Rep ListJobsByStatusResponse #
Instance details Defined in Network.AWS.ElasticTranscoder.ListJobsByStatus type Rep ListJobsByStatusResponse = D1 (MetaData "ListJobsByStatusResponse" "Network.AWS.ElasticTranscoder.ListJobsByStatus" "amazonka-elastictranscoder-1.6.1-J2fDYMJzdmX6ru8jsTFFkp" False) (C1 (MetaCons "ListJobsByStatusResponse'" PrefixI True) (S1 (MetaSel (Just "_ljbsrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_ljbsrsJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Job'])) :: S1 (MetaSel (Just "_ljbsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ljbsrsNextPageToken :: Lens' ListJobsByStatusResponse (Maybe Text) #

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null .

ljbsrsJobs :: Lens' ListJobsByStatusResponse [Job'] #

An array of Job objects that have the specified status.

ljbsrsResponseStatus :: Lens' ListJobsByStatusResponse Int #

- | The response status code.