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 Source #

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 Source #

The ListJobsByPipelineRequest structure.

See: listJobsByPipeline smart constructor.

Instances

Eq ListJobsByPipeline Source # 
Data ListJobsByPipeline Source # 

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 Source # 
Show ListJobsByPipeline Source # 
Generic ListJobsByPipeline Source # 
Hashable ListJobsByPipeline Source # 
NFData ListJobsByPipeline Source # 

Methods

rnf :: ListJobsByPipeline -> () #

AWSPager ListJobsByPipeline Source # 
AWSRequest ListJobsByPipeline Source # 
ToPath ListJobsByPipeline Source # 
ToHeaders ListJobsByPipeline Source # 
ToQuery ListJobsByPipeline Source # 
type Rep ListJobsByPipeline Source # 
type Rep ListJobsByPipeline = D1 (MetaData "ListJobsByPipeline" "Network.AWS.ElasticTranscoder.ListJobsByPipeline" "amazonka-elastictranscoder-1.4.5-GpfBhNC18w3LkITq5oXQDr" 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 Source # 

Request Lenses

ljbpAscending :: Lens' ListJobsByPipeline (Maybe Text) Source #

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) Source #

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 Source #

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

Destructuring the Response

listJobsByPipelineResponse Source #

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 Source #

The ListJobsByPipelineResponse structure.

See: listJobsByPipelineResponse smart constructor.

Instances

Eq ListJobsByPipelineResponse Source # 
Data ListJobsByPipelineResponse Source # 

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 Source # 
Show ListJobsByPipelineResponse Source # 
Generic ListJobsByPipelineResponse Source # 
NFData ListJobsByPipelineResponse Source # 
type Rep ListJobsByPipelineResponse Source # 
type Rep ListJobsByPipelineResponse = D1 (MetaData "ListJobsByPipelineResponse" "Network.AWS.ElasticTranscoder.ListJobsByPipeline" "amazonka-elastictranscoder-1.4.5-GpfBhNC18w3LkITq5oXQDr" 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) Source #

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'] Source #

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