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.M2.ListBatchJobDefinitions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBatchJobDefinitions Source #

See: newListBatchJobDefinitions smart constructor.

Constructors

ListBatchJobDefinitions'

Fields

maxResults :: Maybe Natural
The maximum number of batch job definitions to return.
nextToken :: Maybe Text
A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
prefix :: Maybe Text
If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
applicationId :: Text
The identifier of the application.

Instances

Instances details

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

newListBatchJobDefinitions Source #

Arguments

:: Text	`ListBatchJobDefinitions`
-> ListBatchJobDefinitions

Create a value of ListBatchJobDefinitions 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:maxResults:ListBatchJobDefinitions', listBatchJobDefinitions_maxResults - The maximum number of batch job definitions to return.

ListBatchJobDefinitions, listBatchJobDefinitions_nextToken - A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

$sel:prefix:ListBatchJobDefinitions', listBatchJobDefinitions_prefix - If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.

ListBatchJobDefinitions, listBatchJobDefinitions_applicationId - The identifier of the application.

Request Lenses

listBatchJobDefinitions_maxResults :: Lens' ListBatchJobDefinitions (Maybe Natural) Source #

The maximum number of batch job definitions to return.

listBatchJobDefinitions_nextToken :: Lens' ListBatchJobDefinitions (Maybe Text) Source #

A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

listBatchJobDefinitions_prefix :: Lens' ListBatchJobDefinitions (Maybe Text) Source #

If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.

listBatchJobDefinitions_applicationId :: Lens' ListBatchJobDefinitions Text Source #

The identifier of the application.

Destructuring the Response

data ListBatchJobDefinitionsResponse Source #

See: newListBatchJobDefinitionsResponse smart constructor.

Constructors

ListBatchJobDefinitionsResponse'
Fields nextToken :: Maybe Text If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items. httpStatus :: Int The response's http status code. batchJobDefinitions :: [BatchJobDefinition] The list of batch job definitions.

Instances

Instances details

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

newListBatchJobDefinitionsResponse Source #

Arguments

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

Create a value of ListBatchJobDefinitionsResponse 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:

ListBatchJobDefinitions, listBatchJobDefinitionsResponse_nextToken - If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

$sel:httpStatus:ListBatchJobDefinitionsResponse', listBatchJobDefinitionsResponse_httpStatus - The response's http status code.

$sel:batchJobDefinitions:ListBatchJobDefinitionsResponse', listBatchJobDefinitionsResponse_batchJobDefinitions - The list of batch job definitions.

Response Lenses

listBatchJobDefinitionsResponse_nextToken :: Lens' ListBatchJobDefinitionsResponse (Maybe Text) Source #

If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

listBatchJobDefinitionsResponse_httpStatus :: Lens' ListBatchJobDefinitionsResponse Int Source #

The response's http status code.

listBatchJobDefinitionsResponse_batchJobDefinitions :: Lens' ListBatchJobDefinitionsResponse [BatchJobDefinition] Source #

The list of batch job definitions.