amazonka-snowball-1.6.0: Amazon Import/Export Snowball SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Snowball.ListJobs

Contents

Description

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

This operation returns paginated results.

Synopsis

Creating a Request

listJobs :: ListJobs #

Creates a value of ListJobs with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ljNextToken - HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.
  • ljMaxResults - The number of JobListEntry objects to return.

data ListJobs #

See: listJobs smart constructor.

Instances

Eq ListJobs # 
Data ListJobs # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobs -> c ListJobs #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobs #

toConstr :: ListJobs -> Constr #

dataTypeOf :: ListJobs -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListJobs) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobs) #

gmapT :: (forall b. Data b => b -> b) -> ListJobs -> ListJobs #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobs -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobs -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListJobs -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobs -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobs -> m ListJobs #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobs -> m ListJobs #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobs -> m ListJobs #

Read ListJobs # 
Show ListJobs # 
Generic ListJobs # 

Associated Types

type Rep ListJobs :: * -> * #

Methods

from :: ListJobs -> Rep ListJobs x #

to :: Rep ListJobs x -> ListJobs #

Hashable ListJobs # 

Methods

hashWithSalt :: Int -> ListJobs -> Int #

hash :: ListJobs -> Int #

ToJSON ListJobs # 
NFData ListJobs # 

Methods

rnf :: ListJobs -> () #

AWSPager ListJobs # 
AWSRequest ListJobs # 
ToHeaders ListJobs # 

Methods

toHeaders :: ListJobs -> [Header] #

ToPath ListJobs # 
ToQuery ListJobs # 
type Rep ListJobs # 
type Rep ListJobs = D1 * (MetaData "ListJobs" "Network.AWS.Snowball.ListJobs" "amazonka-snowball-1.6.0-CpRkSYaTAPzF30R6kNaJAh" False) (C1 * (MetaCons "ListJobs'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ljNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ljMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))
type Rs ListJobs # 

Request Lenses

ljNextToken :: Lens' ListJobs (Maybe Text) #

HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

ljMaxResults :: Lens' ListJobs (Maybe Natural) #

The number of JobListEntry objects to return.

Destructuring the Response

listJobsResponse #

Creates a value of ListJobsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ljrsJobListEntries - Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.
  • ljrsNextToken - HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.
  • ljrsResponseStatus - -- | The response status code.

data ListJobsResponse #

See: listJobsResponse smart constructor.

Instances

Eq ListJobsResponse # 
Data ListJobsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListJobsResponse -> c ListJobsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListJobsResponse #

toConstr :: ListJobsResponse -> Constr #

dataTypeOf :: ListJobsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListJobsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListJobsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListJobsResponse -> ListJobsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListJobsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListJobsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListJobsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListJobsResponse -> m ListJobsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsResponse -> m ListJobsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListJobsResponse -> m ListJobsResponse #

Read ListJobsResponse # 
Show ListJobsResponse # 
Generic ListJobsResponse # 
NFData ListJobsResponse # 

Methods

rnf :: ListJobsResponse -> () #

type Rep ListJobsResponse # 
type Rep ListJobsResponse = D1 * (MetaData "ListJobsResponse" "Network.AWS.Snowball.ListJobs" "amazonka-snowball-1.6.0-CpRkSYaTAPzF30R6kNaJAh" False) (C1 * (MetaCons "ListJobsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ljrsJobListEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [JobListEntry]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ljrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ljrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ljrsJobListEntries :: Lens' ListJobsResponse [JobListEntry] #

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

ljrsNextToken :: Lens' ListJobsResponse (Maybe Text) #

HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

ljrsResponseStatus :: Lens' ListJobsResponse Int #

  • - | The response status code.