Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MediaConvert.ListJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.

This operation returns paginated results.

Synopsis

data ListJobs = ListJobs' {
- status :: Maybe JobStatus
- queue :: Maybe Text
- nextToken :: Maybe Text
- order :: Maybe Order
- maxResults :: Maybe Natural
}
newListJobs :: ListJobs
listJobs_status :: Lens' ListJobs (Maybe JobStatus)
listJobs_queue :: Lens' ListJobs (Maybe Text)
listJobs_nextToken :: Lens' ListJobs (Maybe Text)
listJobs_order :: Lens' ListJobs (Maybe Order)
listJobs_maxResults :: Lens' ListJobs (Maybe Natural)
data ListJobsResponse = ListJobsResponse' {
- nextToken :: Maybe Text
- jobs :: Maybe [Job]
- httpStatus :: Int
}
newListJobsResponse :: Int -> ListJobsResponse
listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)
listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [Job])
listJobsResponse_httpStatus :: Lens' ListJobsResponse Int

Creating a Request

data ListJobs Source #

See: newListJobs smart constructor.

Constructors

ListJobs'

Fields

status :: Maybe JobStatus
Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
queue :: Maybe Text
Optional. Provide a queue name to get back only jobs from that queue.
nextToken :: Maybe Text
Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
order :: Maybe Order
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
maxResults :: Maybe Natural
Optional. Number of jobs, up to twenty, that will be returned at one time.

Instances

Instances details

Eq ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods (==) :: ListJobs -> ListJobs -> Bool # (/=) :: ListJobs -> ListJobs -> Bool #
Read ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods readsPrec :: Int -> ReadS ListJobs # readList :: ReadS [ListJobs] # readPrec :: ReadPrec ListJobs # readListPrec :: ReadPrec [ListJobs] #
Show ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods showsPrec :: Int -> ListJobs -> ShowS # show :: ListJobs -> String # showList :: [ListJobs] -> ShowS #
Generic ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Associated Types type Rep ListJobs :: Type -> Type # Methods from :: ListJobs -> Rep ListJobs x # to :: Rep ListJobs x -> ListJobs #
NFData ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods rnf :: ListJobs -> () #
Hashable ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods hashWithSalt :: Int -> ListJobs -> Int # hash :: ListJobs -> Int #
AWSPager ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods page :: ListJobs -> AWSResponse ListJobs -> Maybe ListJobs #
AWSRequest ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Associated Types type AWSResponse ListJobs # Methods request :: ListJobs -> Request ListJobs # response :: MonadResource m => Logger -> Service -> Proxy ListJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJobs))) #
ToHeaders ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods toHeaders :: ListJobs -> [Header] #
ToPath ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods toPath :: ListJobs -> ByteString #
ToQuery ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods toQuery :: ListJobs -> QueryString #
type Rep ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.MediaConvert.ListJobs" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "ListJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :: S1 ('MetaSel ('Just "queue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Order)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListJobs Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs type AWSResponse ListJobs = ListJobsResponse

newListJobs :: ListJobs Source #

Create a value of ListJobs 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:status:ListJobs', listJobs_status - Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

$sel:queue:ListJobs', listJobs_queue - Optional. Provide a queue name to get back only jobs from that queue.

$sel:nextToken:ListJobs', listJobs_nextToken - Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

$sel:order:ListJobs', listJobs_order - Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

$sel:maxResults:ListJobs', listJobs_maxResults - Optional. Number of jobs, up to twenty, that will be returned at one time.

Request Lenses

listJobs_status :: Lens' ListJobs (Maybe JobStatus) Source #

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

listJobs_queue :: Lens' ListJobs (Maybe Text) Source #

Optional. Provide a queue name to get back only jobs from that queue.

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

listJobs_order :: Lens' ListJobs (Maybe Order) Source #

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #

Optional. Number of jobs, up to twenty, that will be returned at one time.

Destructuring the Response

data ListJobsResponse Source #

See: newListJobsResponse smart constructor.

Constructors

ListJobsResponse'
Fields nextToken :: Maybe Text Use this string to request the next batch of jobs. jobs :: Maybe [Job] List of jobs httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListJobsResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods (==) :: ListJobsResponse -> ListJobsResponse -> Bool # (/=) :: ListJobsResponse -> ListJobsResponse -> Bool #
Read ListJobsResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods readsPrec :: Int -> ReadS ListJobsResponse # readList :: ReadS [ListJobsResponse] # readPrec :: ReadPrec ListJobsResponse # readListPrec :: ReadPrec [ListJobsResponse] #
Show ListJobsResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods showsPrec :: Int -> ListJobsResponse -> ShowS # show :: ListJobsResponse -> String # showList :: [ListJobsResponse] -> ShowS #
Generic ListJobsResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Associated Types type Rep ListJobsResponse :: Type -> Type # Methods from :: ListJobsResponse -> Rep ListJobsResponse x # to :: Rep ListJobsResponse x -> ListJobsResponse #
NFData ListJobsResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs Methods rnf :: ListJobsResponse -> () #
type Rep ListJobsResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListJobs type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.MediaConvert.ListJobs" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "ListJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Job])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListJobsResponse'`
-> ListJobsResponse

Create a value of ListJobsResponse 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:nextToken:ListJobs', listJobsResponse_nextToken - Use this string to request the next batch of jobs.

$sel:jobs:ListJobsResponse', listJobsResponse_jobs - List of jobs

$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.

Response Lenses

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

Use this string to request the next batch of jobs.

listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [Job]) Source #

List of jobs

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.