Amazonka.ElasticTranscoder.ListJobsByPipeline

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.

Creating a Request

data ListJobsByPipeline

The ListJobsByPipelineRequest structure.

See: newListJobsByPipeline smart constructor.

Constructors

ListJobsByPipeline'

Fields

• ascending :: 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.

• pageToken :: 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.

• pipelineId :: Text

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

Instances

ToHeaders ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

toHeaders :: ListJobsByPipeline -> [Header]

ToPath ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

toPath :: ListJobsByPipeline -> ByteString

ToQuery ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

toQuery :: ListJobsByPipeline -> QueryString

AWSPager ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

page :: ListJobsByPipeline -> AWSResponse ListJobsByPipeline -> Maybe ListJobsByPipeline

AWSRequest ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Associated Types

type AWSResponse ListJobsByPipeline

Methods

request :: (Service -> Service) -> ListJobsByPipeline -> Request ListJobsByPipeline

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListJobsByPipeline -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJobsByPipeline)))

Generic ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Associated Types

type Rep ListJobsByPipeline :: Type -> Type

Methods

from :: ListJobsByPipeline -> Rep ListJobsByPipeline x

to :: Rep ListJobsByPipeline x -> ListJobsByPipeline

Read ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

readsPrec :: Int -> ReadS ListJobsByPipeline

readList :: ReadS [ListJobsByPipeline]

readPrec :: ReadPrec ListJobsByPipeline

readListPrec :: ReadPrec [ListJobsByPipeline]

Show ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

showsPrec :: Int -> ListJobsByPipeline -> ShowS

show :: ListJobsByPipeline -> String

showList :: [ListJobsByPipeline] -> ShowS

NFData ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

rnf :: ListJobsByPipeline -> ()

Eq ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

(==) :: ListJobsByPipeline -> ListJobsByPipeline -> Bool

(/=) :: ListJobsByPipeline -> ListJobsByPipeline -> Bool

Hashable ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

hashWithSalt :: Int -> ListJobsByPipeline -> Int

hash :: ListJobsByPipeline -> Int

type AWSResponse ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

type AWSResponse ListJobsByPipeline = ListJobsByPipelineResponse

type Rep ListJobsByPipeline

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

type Rep ListJobsByPipeline = D1 ('MetaData "ListJobsByPipeline" "Amazonka.ElasticTranscoder.ListJobsByPipeline" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "ListJobsByPipeline'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ascending") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListJobsByPipeline

Arguments

:: Text

ListJobsByPipeline

-> ListJobsByPipeline

Create a value of ListJobsByPipeline with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ascending:ListJobsByPipeline', listJobsByPipeline_ascending - 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.

$sel:pageToken:ListJobsByPipeline', listJobsByPipeline_pageToken - When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

ListJobsByPipeline, listJobsByPipeline_pipelineId - The ID of the pipeline for which you want to get job information.

Request Lenses

listJobsByPipeline_ascending :: 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.

listJobsByPipeline_pageToken :: 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.

listJobsByPipeline_pipelineId :: Lens' ListJobsByPipeline Text

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

Destructuring the Response

data ListJobsByPipelineResponse

The ListJobsByPipelineResponse structure.

See: newListJobsByPipelineResponse smart constructor.

Constructors

ListJobsByPipelineResponse'

Fields

• jobs :: Maybe [Job]

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

• nextPageToken :: 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListJobsByPipelineResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Associated Types

type Rep ListJobsByPipelineResponse :: Type -> Type

Methods

from :: ListJobsByPipelineResponse -> Rep ListJobsByPipelineResponse x

to :: Rep ListJobsByPipelineResponse x -> ListJobsByPipelineResponse

Read ListJobsByPipelineResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

readsPrec :: Int -> ReadS ListJobsByPipelineResponse

readList :: ReadS [ListJobsByPipelineResponse]

readPrec :: ReadPrec ListJobsByPipelineResponse

readListPrec :: ReadPrec [ListJobsByPipelineResponse]

Show ListJobsByPipelineResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

showsPrec :: Int -> ListJobsByPipelineResponse -> ShowS

show :: ListJobsByPipelineResponse -> String

showList :: [ListJobsByPipelineResponse] -> ShowS

NFData ListJobsByPipelineResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

rnf :: ListJobsByPipelineResponse -> ()

Eq ListJobsByPipelineResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

Methods

(==) :: ListJobsByPipelineResponse -> ListJobsByPipelineResponse -> Bool

(/=) :: ListJobsByPipelineResponse -> ListJobsByPipelineResponse -> Bool

type Rep ListJobsByPipelineResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByPipeline

type Rep ListJobsByPipelineResponse = D1 ('MetaData "ListJobsByPipelineResponse" "Amazonka.ElasticTranscoder.ListJobsByPipeline" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "ListJobsByPipelineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Job])) :*: (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListJobsByPipelineResponse

Arguments

:: Int

$sel:httpStatus:ListJobsByPipelineResponse'

-> ListJobsByPipelineResponse

Create a value of ListJobsByPipelineResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobs:ListJobsByPipelineResponse', listJobsByPipelineResponse_jobs - An array of Job objects that are in the specified pipeline.

$sel:nextPageToken:ListJobsByPipelineResponse', listJobsByPipelineResponse_nextPageToken - 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.

$sel:httpStatus:ListJobsByPipelineResponse', listJobsByPipelineResponse_httpStatus - The response's http status code.

Response Lenses

listJobsByPipelineResponse_jobs :: Lens' ListJobsByPipelineResponse (Maybe [Job])

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

listJobsByPipelineResponse_nextPageToken :: 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.

listJobsByPipelineResponse_httpStatus :: Lens' ListJobsByPipelineResponse Int

The response's http status code.