Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaPackage.ListHarvestJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a collection of HarvestJob records.

This operation returns paginated results.

Synopsis

data ListHarvestJobs = ListHarvestJobs' {
- includeChannelId :: Maybe Text
- includeStatus :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListHarvestJobs :: ListHarvestJobs
listHarvestJobs_includeChannelId :: Lens' ListHarvestJobs (Maybe Text)
listHarvestJobs_includeStatus :: Lens' ListHarvestJobs (Maybe Text)
listHarvestJobs_maxResults :: Lens' ListHarvestJobs (Maybe Natural)
listHarvestJobs_nextToken :: Lens' ListHarvestJobs (Maybe Text)
data ListHarvestJobsResponse = ListHarvestJobsResponse' {
- harvestJobs :: Maybe [HarvestJob]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListHarvestJobsResponse :: Int -> ListHarvestJobsResponse
listHarvestJobsResponse_harvestJobs :: Lens' ListHarvestJobsResponse (Maybe [HarvestJob])
listHarvestJobsResponse_nextToken :: Lens' ListHarvestJobsResponse (Maybe Text)
listHarvestJobsResponse_httpStatus :: Lens' ListHarvestJobsResponse Int

Creating a Request

data ListHarvestJobs Source #

See: newListHarvestJobs smart constructor.

Constructors

ListHarvestJobs'

Fields

includeChannelId :: Maybe Text
When specified, the request will return only HarvestJobs associated with the given Channel ID.
includeStatus :: Maybe Text
When specified, the request will return only HarvestJobs in the given status.
maxResults :: Maybe Natural
The upper bound on the number of records to return.
nextToken :: Maybe Text
A token used to resume pagination from the end of a previous request.

Instances

Instances details

ToHeaders ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods toHeaders :: ListHarvestJobs -> [Header] #
ToPath ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods toPath :: ListHarvestJobs -> ByteString #
ToQuery ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods toQuery :: ListHarvestJobs -> QueryString #
AWSPager ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods page :: ListHarvestJobs -> AWSResponse ListHarvestJobs -> Maybe ListHarvestJobs #
AWSRequest ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Associated Types type AWSResponse ListHarvestJobs # Methods request :: (Service -> Service) -> ListHarvestJobs -> Request ListHarvestJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListHarvestJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListHarvestJobs))) #
Generic ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Associated Types type Rep ListHarvestJobs :: Type -> Type # Methods from :: ListHarvestJobs -> Rep ListHarvestJobs x # to :: Rep ListHarvestJobs x -> ListHarvestJobs #
Read ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods readsPrec :: Int -> ReadS ListHarvestJobs # readList :: ReadS [ListHarvestJobs] # readPrec :: ReadPrec ListHarvestJobs # readListPrec :: ReadPrec [ListHarvestJobs] #
Show ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods showsPrec :: Int -> ListHarvestJobs -> ShowS # show :: ListHarvestJobs -> String # showList :: [ListHarvestJobs] -> ShowS #
NFData ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods rnf :: ListHarvestJobs -> () #
Eq ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods (==) :: ListHarvestJobs -> ListHarvestJobs -> Bool # (/=) :: ListHarvestJobs -> ListHarvestJobs -> Bool #
Hashable ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods hashWithSalt :: Int -> ListHarvestJobs -> Int # hash :: ListHarvestJobs -> Int #
type AWSResponse ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs type AWSResponse ListHarvestJobs = ListHarvestJobsResponse
type Rep ListHarvestJobs Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs type Rep ListHarvestJobs = D1 ('MetaData "ListHarvestJobs" "Amazonka.MediaPackage.ListHarvestJobs" "amazonka-mediapackage-2.0-Ht5BbgvzDNJCrSLrgDmB6l" 'False) (C1 ('MetaCons "ListHarvestJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "includeChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "includeStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListHarvestJobs :: ListHarvestJobs Source #

Create a value of ListHarvestJobs 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:includeChannelId:ListHarvestJobs', listHarvestJobs_includeChannelId - When specified, the request will return only HarvestJobs associated with the given Channel ID.

$sel:includeStatus:ListHarvestJobs', listHarvestJobs_includeStatus - When specified, the request will return only HarvestJobs in the given status.

$sel:maxResults:ListHarvestJobs', listHarvestJobs_maxResults - The upper bound on the number of records to return.

ListHarvestJobs, listHarvestJobs_nextToken - A token used to resume pagination from the end of a previous request.

Request Lenses

listHarvestJobs_includeChannelId :: Lens' ListHarvestJobs (Maybe Text) Source #

When specified, the request will return only HarvestJobs associated with the given Channel ID.

listHarvestJobs_includeStatus :: Lens' ListHarvestJobs (Maybe Text) Source #

When specified, the request will return only HarvestJobs in the given status.

listHarvestJobs_maxResults :: Lens' ListHarvestJobs (Maybe Natural) Source #

The upper bound on the number of records to return.

listHarvestJobs_nextToken :: Lens' ListHarvestJobs (Maybe Text) Source #

A token used to resume pagination from the end of a previous request.

Destructuring the Response

data ListHarvestJobsResponse Source #

See: newListHarvestJobsResponse smart constructor.

Constructors

ListHarvestJobsResponse'
Fields harvestJobs :: Maybe [HarvestJob] A list of HarvestJob records. nextToken :: Maybe Text A token that can be used to resume pagination from the end of the collection. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListHarvestJobsResponse Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Associated Types type Rep ListHarvestJobsResponse :: Type -> Type # Methods from :: ListHarvestJobsResponse -> Rep ListHarvestJobsResponse x # to :: Rep ListHarvestJobsResponse x -> ListHarvestJobsResponse #
Read ListHarvestJobsResponse Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods readsPrec :: Int -> ReadS ListHarvestJobsResponse # readList :: ReadS [ListHarvestJobsResponse] # readPrec :: ReadPrec ListHarvestJobsResponse # readListPrec :: ReadPrec [ListHarvestJobsResponse] #
Show ListHarvestJobsResponse Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods showsPrec :: Int -> ListHarvestJobsResponse -> ShowS # show :: ListHarvestJobsResponse -> String # showList :: [ListHarvestJobsResponse] -> ShowS #
NFData ListHarvestJobsResponse Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods rnf :: ListHarvestJobsResponse -> () #
Eq ListHarvestJobsResponse Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs Methods (==) :: ListHarvestJobsResponse -> ListHarvestJobsResponse -> Bool # (/=) :: ListHarvestJobsResponse -> ListHarvestJobsResponse -> Bool #
type Rep ListHarvestJobsResponse Source #
Instance details Defined in Amazonka.MediaPackage.ListHarvestJobs type Rep ListHarvestJobsResponse = D1 ('MetaData "ListHarvestJobsResponse" "Amazonka.MediaPackage.ListHarvestJobs" "amazonka-mediapackage-2.0-Ht5BbgvzDNJCrSLrgDmB6l" 'False) (C1 ('MetaCons "ListHarvestJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "harvestJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HarvestJob])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListHarvestJobsResponse Source #

Arguments

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

Create a value of ListHarvestJobsResponse 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:harvestJobs:ListHarvestJobsResponse', listHarvestJobsResponse_harvestJobs - A list of HarvestJob records.

ListHarvestJobs, listHarvestJobsResponse_nextToken - A token that can be used to resume pagination from the end of the collection.

$sel:httpStatus:ListHarvestJobsResponse', listHarvestJobsResponse_httpStatus - The response's http status code.

Response Lenses

listHarvestJobsResponse_harvestJobs :: Lens' ListHarvestJobsResponse (Maybe [HarvestJob]) Source #

A list of HarvestJob records.

listHarvestJobsResponse_nextToken :: Lens' ListHarvestJobsResponse (Maybe Text) Source #

A token that can be used to resume pagination from the end of the collection.

listHarvestJobsResponse_httpStatus :: Lens' ListHarvestJobsResponse Int Source #

The response's http status code.