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

Contents

Description

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

This operation returns paginated results.

Synopsis

Creating a Request

listJobsByPipeline #

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

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

  • ljbpAscending - 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 .
  • ljbpPageToken - When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
  • ljbpPipelineId - The ID of the pipeline for which you want to get job information.

data ListJobsByPipeline #

The ListJobsByPipelineRequest structure.

See: listJobsByPipeline smart constructor.

Instances

Eq ListJobsByPipeline # 
Data ListJobsByPipeline # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobsByPipeline -> c ListJobsByPipeline #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobsByPipeline #

toConstr :: ListJobsByPipeline -> Constr #

dataTypeOf :: ListJobsByPipeline -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListJobsByPipeline) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobsByPipeline) #

gmapT :: (forall b. Data b => b -> b) -> ListJobsByPipeline -> ListJobsByPipeline #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByPipeline -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByPipeline -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListJobsByPipeline -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobsByPipeline -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobsByPipeline -> m ListJobsByPipeline #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByPipeline -> m ListJobsByPipeline #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByPipeline -> m ListJobsByPipeline #

Read ListJobsByPipeline # 
Show ListJobsByPipeline # 
Generic ListJobsByPipeline # 
Hashable ListJobsByPipeline # 
NFData ListJobsByPipeline # 

Methods

rnf :: ListJobsByPipeline -> () #

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

Request Lenses

ljbpAscending :: Lens' ListJobsByPipeline (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 .

ljbpPageToken :: Lens' ListJobsByPipeline (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.

ljbpPipelineId :: Lens' ListJobsByPipeline Text #

The ID of the pipeline for which you want to get job information.

Destructuring the Response

listJobsByPipelineResponse #

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

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

  • ljbprsNextPageToken - 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 .
  • ljbprsJobs - An array of Job objects that are in the specified pipeline.
  • ljbprsResponseStatus - -- | The response status code.

data ListJobsByPipelineResponse #

The ListJobsByPipelineResponse structure.

See: listJobsByPipelineResponse smart constructor.

Instances

Eq ListJobsByPipelineResponse # 
Data ListJobsByPipelineResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobsByPipelineResponse -> c ListJobsByPipelineResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobsByPipelineResponse #

toConstr :: ListJobsByPipelineResponse -> Constr #

dataTypeOf :: ListJobsByPipelineResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListJobsByPipelineResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobsByPipelineResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListJobsByPipelineResponse -> ListJobsByPipelineResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByPipelineResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsByPipelineResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListJobsByPipelineResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobsByPipelineResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobsByPipelineResponse -> m ListJobsByPipelineResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByPipelineResponse -> m ListJobsByPipelineResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsByPipelineResponse -> m ListJobsByPipelineResponse #

Read ListJobsByPipelineResponse # 
Show ListJobsByPipelineResponse # 
Generic ListJobsByPipelineResponse # 
NFData ListJobsByPipelineResponse # 
type Rep ListJobsByPipelineResponse # 
type Rep ListJobsByPipelineResponse = D1 (MetaData "ListJobsByPipelineResponse" "Network.AWS.ElasticTranscoder.ListJobsByPipeline" "amazonka-elastictranscoder-1.4.5-IWhO0jSg9d9K4YiAeruaf2" False) (C1 (MetaCons "ListJobsByPipelineResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ljbprsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ljbprsJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Job']))) (S1 (MetaSel (Just Symbol "_ljbprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

ljbprsNextPageToken :: Lens' ListJobsByPipelineResponse (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 .

ljbprsJobs :: Lens' ListJobsByPipelineResponse [Job'] #

An array of Job objects that are in the specified pipeline.