Network.AWS.Batch.DescribeJobDefinitions

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

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

See: describeJobDefinitions smart constructor.

Instances

Eq DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

(==) :: DescribeJobDefinitions -> DescribeJobDefinitions -> Bool

(/=) :: DescribeJobDefinitions -> DescribeJobDefinitions -> Bool

Data DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

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

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

readsPrec :: Int -> ReadS DescribeJobDefinitions

readList :: ReadS [DescribeJobDefinitions]

readPrec :: ReadPrec DescribeJobDefinitions

readListPrec :: ReadPrec [DescribeJobDefinitions]

Show DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

showsPrec :: Int -> DescribeJobDefinitions -> ShowS

show :: DescribeJobDefinitions -> String

showList :: [DescribeJobDefinitions] -> ShowS

Generic DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Associated Types

type Rep DescribeJobDefinitions :: Type -> Type

Methods

from :: DescribeJobDefinitions -> Rep DescribeJobDefinitions x

to :: Rep DescribeJobDefinitions x -> DescribeJobDefinitions

Hashable DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

hashWithSalt :: Int -> DescribeJobDefinitions -> Int

hash :: DescribeJobDefinitions -> Int

ToJSON DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

toJSON :: DescribeJobDefinitions -> Value

toEncoding :: DescribeJobDefinitions -> Encoding

toJSONList :: [DescribeJobDefinitions] -> Value

toEncodingList :: [DescribeJobDefinitions] -> Encoding

AWSRequest DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Associated Types

type Rs DescribeJobDefinitions :: Type

Methods

request :: DescribeJobDefinitions -> Request DescribeJobDefinitions

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeJobDefinitions -> ClientResponse -> m (Response DescribeJobDefinitions)

ToHeaders DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

toHeaders :: DescribeJobDefinitions -> [Header]

ToPath DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

toPath :: DescribeJobDefinitions -> ByteString

ToQuery DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

toQuery :: DescribeJobDefinitions -> QueryString

NFData DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

rnf :: DescribeJobDefinitions -> ()

type Rep DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitions = D1 (MetaData "DescribeJobDefinitions" "Network.AWS.Batch.DescribeJobDefinitions" "amazonka-batch-1.6.1-Ehms0ZM7bO3CGJpCkHVC0C" False) (C1 (MetaCons "DescribeJobDefinitions'" PrefixI True) ((S1 (MetaSel (Just "_djdStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_djdJobDefinitionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_djdJobDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_djdNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_djdMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))

type Rs DescribeJobDefinitions

Defined in Network.AWS.Batch.DescribeJobDefinitions

type Rs DescribeJobDefinitions = DescribeJobDefinitionsResponse

Request Lenses

djdStatus :: Lens' DescribeJobDefinitions (Maybe Text)

The status with which to filter job definitions.

djdJobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text)

The name of the job definition to describe.

djdJobDefinitions :: Lens' DescribeJobDefinitions [Text]

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

djdNextToken :: Lens' DescribeJobDefinitions (Maybe Text)

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)

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

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

See: describeJobDefinitionsResponse smart constructor.

Instances

Eq DescribeJobDefinitionsResponse

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

(==) :: DescribeJobDefinitionsResponse -> DescribeJobDefinitionsResponse -> Bool

(/=) :: DescribeJobDefinitionsResponse -> DescribeJobDefinitionsResponse -> Bool

Data DescribeJobDefinitionsResponse

Defined in Network.AWS.Batch.DescribeJobDefinitions

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

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

readsPrec :: Int -> ReadS DescribeJobDefinitionsResponse

readList :: ReadS [DescribeJobDefinitionsResponse]

readPrec :: ReadPrec DescribeJobDefinitionsResponse

readListPrec :: ReadPrec [DescribeJobDefinitionsResponse]

Show DescribeJobDefinitionsResponse

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

showsPrec :: Int -> DescribeJobDefinitionsResponse -> ShowS

show :: DescribeJobDefinitionsResponse -> String

showList :: [DescribeJobDefinitionsResponse] -> ShowS

Generic DescribeJobDefinitionsResponse

Defined in Network.AWS.Batch.DescribeJobDefinitions

Associated Types

type Rep DescribeJobDefinitionsResponse :: Type -> Type

Methods

from :: DescribeJobDefinitionsResponse -> Rep DescribeJobDefinitionsResponse x

to :: Rep DescribeJobDefinitionsResponse x -> DescribeJobDefinitionsResponse

NFData DescribeJobDefinitionsResponse

Defined in Network.AWS.Batch.DescribeJobDefinitions

Methods

rnf :: DescribeJobDefinitionsResponse -> ()

type Rep DescribeJobDefinitionsResponse

Defined in Network.AWS.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitionsResponse = D1 (MetaData "DescribeJobDefinitionsResponse" "Network.AWS.Batch.DescribeJobDefinitions" "amazonka-batch-1.6.1-Ehms0ZM7bO3CGJpCkHVC0C" False) (C1 (MetaCons "DescribeJobDefinitionsResponse'" PrefixI True) (S1 (MetaSel (Just "_djdrsJobDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JobDefinition])) :*: (S1 (MetaSel (Just "_djdrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_djdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

djdrsJobDefinitions :: Lens' DescribeJobDefinitionsResponse [JobDefinition]

The list of job definitions.

djdrsNextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text)

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

• - | The response status code.