Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Batch.DescribeJobDefinitions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a list of job definitions. You can specify a status (such as ACTIVE ) to only return job definitions that match that status.

Creating a Request

describeJobDefinitions :: DescribeJobDefinitions Source #

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

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

djdStatus - The status with which to filter job definitions.
djdJobDefinitionName - The name of the job definition to describe.
djdJobDefinitions - A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
djdNextToken - The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
djdMaxResults - The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

data DescribeJobDefinitions Source #

See: describeJobDefinitions smart constructor.

Instances

Eq DescribeJobDefinitions Source #
Methods (==) :: DescribeJobDefinitions -> DescribeJobDefinitions -> Bool # (/=) :: DescribeJobDefinitions -> DescribeJobDefinitions -> Bool #
Data DescribeJobDefinitions Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeJobDefinitions -> c DescribeJobDefinitions # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeJobDefinitions # toConstr :: DescribeJobDefinitions -> Constr # dataTypeOf :: DescribeJobDefinitions -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeJobDefinitions) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeJobDefinitions) # gmapT :: (forall b. Data b => b -> b) -> DescribeJobDefinitions -> DescribeJobDefinitions # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobDefinitions -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobDefinitions -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeJobDefinitions -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeJobDefinitions -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeJobDefinitions -> m DescribeJobDefinitions # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobDefinitions -> m DescribeJobDefinitions # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobDefinitions -> m DescribeJobDefinitions #
Read DescribeJobDefinitions Source #
Methods readsPrec :: Int -> ReadS DescribeJobDefinitions # readList :: ReadS [DescribeJobDefinitions] # readPrec :: ReadPrec DescribeJobDefinitions # readListPrec :: ReadPrec [DescribeJobDefinitions] #
Show DescribeJobDefinitions Source #
Methods showsPrec :: Int -> DescribeJobDefinitions -> ShowS # show :: DescribeJobDefinitions -> String # showList :: [DescribeJobDefinitions] -> ShowS #
Generic DescribeJobDefinitions Source #
Associated Types type Rep DescribeJobDefinitions :: * -> * # Methods from :: DescribeJobDefinitions -> Rep DescribeJobDefinitions x # to :: Rep DescribeJobDefinitions x -> DescribeJobDefinitions #
Hashable DescribeJobDefinitions Source #
Methods hashWithSalt :: Int -> DescribeJobDefinitions -> Int # hash :: DescribeJobDefinitions -> Int #
ToJSON DescribeJobDefinitions Source #
Methods toJSON :: DescribeJobDefinitions -> Value # toEncoding :: DescribeJobDefinitions -> Encoding # toJSONList :: [DescribeJobDefinitions] -> Value # toEncodingList :: [DescribeJobDefinitions] -> Encoding #
NFData DescribeJobDefinitions Source #
Methods rnf :: DescribeJobDefinitions -> () #
AWSRequest DescribeJobDefinitions Source #
Associated Types type Rs DescribeJobDefinitions :: * # Methods request :: DescribeJobDefinitions -> Request DescribeJobDefinitions # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeJobDefinitions -> ClientResponse -> m (Response DescribeJobDefinitions) #
ToHeaders DescribeJobDefinitions Source #
Methods toHeaders :: DescribeJobDefinitions -> [Header] #
ToPath DescribeJobDefinitions Source #
Methods toPath :: DescribeJobDefinitions -> ByteString #
ToQuery DescribeJobDefinitions Source #
Methods toQuery :: DescribeJobDefinitions -> QueryString #
type Rep DescribeJobDefinitions Source #
type Rep DescribeJobDefinitions = D1 * (MetaData "DescribeJobDefinitions" "Network.AWS.Batch.DescribeJobDefinitions" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "DescribeJobDefinitions'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_djdStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_djdJobDefinitionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((::) (S1 * (MetaSel (Just Symbol "_djdJobDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((::) (S1 * (MetaSel (Just Symbol "_djdNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_djdMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))
type Rs DescribeJobDefinitions Source #
type Rs DescribeJobDefinitions = DescribeJobDefinitionsResponse

Request Lenses

djdStatus :: Lens' DescribeJobDefinitions (Maybe Text) Source #

The status with which to filter job definitions.

djdJobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text) Source #

The name of the job definition to describe.

djdJobDefinitions :: Lens' DescribeJobDefinitions [Text] Source #

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

djdNextToken :: Lens' DescribeJobDefinitions (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

djdMaxResults :: Lens' DescribeJobDefinitions (Maybe Int) Source #

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

Destructuring the Response

describeJobDefinitionsResponse Source #

Arguments

:: Int	`djdrsResponseStatus`
-> DescribeJobDefinitionsResponse

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

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

djdrsJobDefinitions - The list of job definitions.
djdrsNextToken - The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
djdrsResponseStatus - -- | The response status code.

data DescribeJobDefinitionsResponse Source #

See: describeJobDefinitionsResponse smart constructor.

Instances

Eq DescribeJobDefinitionsResponse Source #
Methods (==) :: DescribeJobDefinitionsResponse -> DescribeJobDefinitionsResponse -> Bool # (/=) :: DescribeJobDefinitionsResponse -> DescribeJobDefinitionsResponse -> Bool #
Data DescribeJobDefinitionsResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeJobDefinitionsResponse -> c DescribeJobDefinitionsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeJobDefinitionsResponse # toConstr :: DescribeJobDefinitionsResponse -> Constr # dataTypeOf :: DescribeJobDefinitionsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeJobDefinitionsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeJobDefinitionsResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeJobDefinitionsResponse -> DescribeJobDefinitionsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobDefinitionsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobDefinitionsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeJobDefinitionsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeJobDefinitionsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeJobDefinitionsResponse -> m DescribeJobDefinitionsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobDefinitionsResponse -> m DescribeJobDefinitionsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobDefinitionsResponse -> m DescribeJobDefinitionsResponse #
Read DescribeJobDefinitionsResponse Source #
Methods readsPrec :: Int -> ReadS DescribeJobDefinitionsResponse # readList :: ReadS [DescribeJobDefinitionsResponse] # readPrec :: ReadPrec DescribeJobDefinitionsResponse # readListPrec :: ReadPrec [DescribeJobDefinitionsResponse] #
Show DescribeJobDefinitionsResponse Source #
Methods showsPrec :: Int -> DescribeJobDefinitionsResponse -> ShowS # show :: DescribeJobDefinitionsResponse -> String # showList :: [DescribeJobDefinitionsResponse] -> ShowS #
Generic DescribeJobDefinitionsResponse Source #
Associated Types type Rep DescribeJobDefinitionsResponse :: * -> * # Methods from :: DescribeJobDefinitionsResponse -> Rep DescribeJobDefinitionsResponse x # to :: Rep DescribeJobDefinitionsResponse x -> DescribeJobDefinitionsResponse #
NFData DescribeJobDefinitionsResponse Source #
Methods rnf :: DescribeJobDefinitionsResponse -> () #
type Rep DescribeJobDefinitionsResponse Source #
type Rep DescribeJobDefinitionsResponse = D1 * (MetaData "DescribeJobDefinitionsResponse" "Network.AWS.Batch.DescribeJobDefinitions" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "DescribeJobDefinitionsResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_djdrsJobDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [JobDefinition]))) ((::) (S1 * (MetaSel (Just Symbol "_djdrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_djdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

djdrsJobDefinitions :: Lens' DescribeJobDefinitionsResponse [JobDefinition] Source #

The list of job definitions.

djdrsNextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text) Source #

The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

djdrsResponseStatus :: Lens' DescribeJobDefinitionsResponse Int Source #

- | The response status code.