Amazonka.ElasticTranscoder.ListJobsByStatus

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

data ListJobsByStatus

The ListJobsByStatusRequest structure.

See: newListJobsByStatus smart constructor.

Constructors

ListJobsByStatus'

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.

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

Instances

ToHeaders ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

toHeaders :: ListJobsByStatus -> [Header]

ToPath ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

toPath :: ListJobsByStatus -> ByteString

ToQuery ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

toQuery :: ListJobsByStatus -> QueryString

AWSPager ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

page :: ListJobsByStatus -> AWSResponse ListJobsByStatus -> Maybe ListJobsByStatus

AWSRequest ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Associated Types

type AWSResponse ListJobsByStatus

Methods

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

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

Generic ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Associated Types

type Rep ListJobsByStatus :: Type -> Type

Methods

from :: ListJobsByStatus -> Rep ListJobsByStatus x

to :: Rep ListJobsByStatus x -> ListJobsByStatus

Read ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

readsPrec :: Int -> ReadS ListJobsByStatus

readList :: ReadS [ListJobsByStatus]

readPrec :: ReadPrec ListJobsByStatus

readListPrec :: ReadPrec [ListJobsByStatus]

Show ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

showsPrec :: Int -> ListJobsByStatus -> ShowS

show :: ListJobsByStatus -> String

showList :: [ListJobsByStatus] -> ShowS

NFData ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

rnf :: ListJobsByStatus -> ()

Eq ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

(==) :: ListJobsByStatus -> ListJobsByStatus -> Bool

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

Hashable ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

hashWithSalt :: Int -> ListJobsByStatus -> Int

hash :: ListJobsByStatus -> Int

type AWSResponse ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

type AWSResponse ListJobsByStatus = ListJobsByStatusResponse

type Rep ListJobsByStatus

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

type Rep ListJobsByStatus = D1 ('MetaData "ListJobsByStatus" "Amazonka.ElasticTranscoder.ListJobsByStatus" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "ListJobsByStatus'" '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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListJobsByStatus

Arguments

:: Text

ListJobsByStatus

-> ListJobsByStatus

Create a value of ListJobsByStatus 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:ListJobsByStatus', listJobsByStatus_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:ListJobsByStatus', listJobsByStatus_pageToken - When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

ListJobsByStatus, listJobsByStatus_status - 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.

Request Lenses

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

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

listJobsByStatus_status :: 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

data ListJobsByStatusResponse

The ListJobsByStatusResponse structure.

See: newListJobsByStatusResponse smart constructor.

Constructors

ListJobsByStatusResponse'

Fields

• jobs :: Maybe [Job]

  An array of Job objects that have the specified status.

• 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 ListJobsByStatusResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Associated Types

type Rep ListJobsByStatusResponse :: Type -> Type

Methods

from :: ListJobsByStatusResponse -> Rep ListJobsByStatusResponse x

to :: Rep ListJobsByStatusResponse x -> ListJobsByStatusResponse

Read ListJobsByStatusResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

readsPrec :: Int -> ReadS ListJobsByStatusResponse

readList :: ReadS [ListJobsByStatusResponse]

readPrec :: ReadPrec ListJobsByStatusResponse

readListPrec :: ReadPrec [ListJobsByStatusResponse]

Show ListJobsByStatusResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

showsPrec :: Int -> ListJobsByStatusResponse -> ShowS

show :: ListJobsByStatusResponse -> String

showList :: [ListJobsByStatusResponse] -> ShowS

NFData ListJobsByStatusResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

rnf :: ListJobsByStatusResponse -> ()

Eq ListJobsByStatusResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

Methods

(==) :: ListJobsByStatusResponse -> ListJobsByStatusResponse -> Bool

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

type Rep ListJobsByStatusResponse

Defined in Amazonka.ElasticTranscoder.ListJobsByStatus

type Rep ListJobsByStatusResponse = D1 ('MetaData "ListJobsByStatusResponse" "Amazonka.ElasticTranscoder.ListJobsByStatus" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "ListJobsByStatusResponse'" '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))))

newListJobsByStatusResponse

Arguments

:: Int

$sel:httpStatus:ListJobsByStatusResponse'

-> ListJobsByStatusResponse

Create a value of ListJobsByStatusResponse 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:ListJobsByStatusResponse', listJobsByStatusResponse_jobs - An array of Job objects that have the specified status.

$sel:nextPageToken:ListJobsByStatusResponse', listJobsByStatusResponse_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:ListJobsByStatusResponse', listJobsByStatusResponse_httpStatus - The response's http status code.

Response Lenses

listJobsByStatusResponse_jobs :: Lens' ListJobsByStatusResponse (Maybe [Job])

An array of Job objects that have the specified status.

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

listJobsByStatusResponse_httpStatus :: Lens' ListJobsByStatusResponse Int

The response's http status code.