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.ListClusterJobs

Contents

Description

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

Synopsis

Creating a Request

listClusterJobs #

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

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

  • lcjNextToken - 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.
  • lcjMaxResults - The number of JobListEntry objects to return.
  • lcjClusterId - The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .

data ListClusterJobs #

See: listClusterJobs smart constructor.

Instances

Eq ListClusterJobs # 
Data ListClusterJobs # 

Methods

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

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

toConstr :: ListClusterJobs -> Constr #

dataTypeOf :: ListClusterJobs -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListClusterJobs # 
Show ListClusterJobs # 
Generic ListClusterJobs # 
Hashable ListClusterJobs # 
ToJSON ListClusterJobs # 
NFData ListClusterJobs # 

Methods

rnf :: ListClusterJobs -> () #

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

Request Lenses

lcjNextToken :: Lens' ListClusterJobs (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.

lcjMaxResults :: Lens' ListClusterJobs (Maybe Natural) #

The number of JobListEntry objects to return.

lcjClusterId :: Lens' ListClusterJobs Text #

The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .

Destructuring the Response

listClusterJobsResponse #

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

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

  • lcjrsJobListEntries - 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.
  • lcjrsNextToken - HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array.
  • lcjrsResponseStatus - -- | The response status code.

data ListClusterJobsResponse #

See: listClusterJobsResponse smart constructor.

Instances

Eq ListClusterJobsResponse # 
Data ListClusterJobsResponse # 

Methods

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

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

toConstr :: ListClusterJobsResponse -> Constr #

dataTypeOf :: ListClusterJobsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListClusterJobsResponse # 
Show ListClusterJobsResponse # 
Generic ListClusterJobsResponse # 
NFData ListClusterJobsResponse # 

Methods

rnf :: ListClusterJobsResponse -> () #

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

Response Lenses

lcjrsJobListEntries :: Lens' ListClusterJobsResponse [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.

lcjrsNextToken :: Lens' ListClusterJobsResponse (Maybe Text) #

HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array.

lcjrsResponseStatus :: Lens' ListClusterJobsResponse Int #

  • - | The response status code.