amazonka-elastictranscoder-1.4.5: Amazon Elastic Transcoder SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElasticTranscoder.ListJobsByStatus

Contents

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.

Synopsis

Creating a Request

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 # 
Data 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 # 
Show ListJobsByStatus # 
Generic ListJobsByStatus # 
Hashable ListJobsByStatus # 
NFData ListJobsByStatus # 

Methods

rnf :: ListJobsByStatus -> () #

AWSPager ListJobsByStatus # 
AWSRequest ListJobsByStatus # 
ToQuery ListJobsByStatus # 
ToPath ListJobsByStatus # 
ToHeaders ListJobsByStatus # 
type Rep ListJobsByStatus # 
type Rep ListJobsByStatus = D1 (MetaData "ListJobsByStatus" "Network.AWS.ElasticTranscoder.ListJobsByStatus" "amazonka-elastictranscoder-1.4.5-IWhO0jSg9d9K4YiAeruaf2" False) (C1 (MetaCons "ListJobsByStatus'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ljbsAscending") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ljbsPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ljbsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ListJobsByStatus # 

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 #

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 # 
Data ListJobsByStatusResponse # 

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 # 
Show ListJobsByStatusResponse # 
Generic ListJobsByStatusResponse # 
NFData ListJobsByStatusResponse # 
type Rep ListJobsByStatusResponse # 
type Rep ListJobsByStatusResponse = D1 (MetaData "ListJobsByStatusResponse" "Network.AWS.ElasticTranscoder.ListJobsByStatus" "amazonka-elastictranscoder-1.4.5-IWhO0jSg9d9K4YiAeruaf2" False) (C1 (MetaCons "ListJobsByStatusResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ljbsrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ljbsrsJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Job']))) (S1 (MetaSel (Just Symbol "_ljbsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.