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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists historical, current, and scheduled batch job executions for a specific application.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBatchJobExecutions Source #

See: newListBatchJobExecutions smart constructor.

Constructors

ListBatchJobExecutions'

Fields

executionIds :: Maybe (NonEmpty Text)
The unique identifier of each batch job execution.
jobName :: Maybe Text
The name of each batch job execution.
maxResults :: Maybe Natural
The maximum number of batch job executions to return.
nextToken :: Maybe Text
A pagination token to control the number of batch job executions displayed in the list.
startedAfter :: Maybe POSIX
The time after which the batch job executions started.
startedBefore :: Maybe POSIX
The time before the batch job executions started.
status :: Maybe BatchJobExecutionStatus
The status of the batch job executions.
applicationId :: Text
The unique identifier of the application.

Instances

Instances details

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

newListBatchJobExecutions Source #

Arguments

:: Text	`ListBatchJobExecutions`
-> ListBatchJobExecutions

Create a value of ListBatchJobExecutions 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:executionIds:ListBatchJobExecutions', listBatchJobExecutions_executionIds - The unique identifier of each batch job execution.

ListBatchJobExecutions, listBatchJobExecutions_jobName - The name of each batch job execution.

$sel:maxResults:ListBatchJobExecutions', listBatchJobExecutions_maxResults - The maximum number of batch job executions to return.

ListBatchJobExecutions, listBatchJobExecutions_nextToken - A pagination token to control the number of batch job executions displayed in the list.

$sel:startedAfter:ListBatchJobExecutions', listBatchJobExecutions_startedAfter - The time after which the batch job executions started.

$sel:startedBefore:ListBatchJobExecutions', listBatchJobExecutions_startedBefore - The time before the batch job executions started.

ListBatchJobExecutions, listBatchJobExecutions_status - The status of the batch job executions.

ListBatchJobExecutions, listBatchJobExecutions_applicationId - The unique identifier of the application.

Request Lenses

listBatchJobExecutions_executionIds :: Lens' ListBatchJobExecutions (Maybe (NonEmpty Text)) Source #

The unique identifier of each batch job execution.

listBatchJobExecutions_jobName :: Lens' ListBatchJobExecutions (Maybe Text) Source #

The name of each batch job execution.

listBatchJobExecutions_maxResults :: Lens' ListBatchJobExecutions (Maybe Natural) Source #

The maximum number of batch job executions to return.

listBatchJobExecutions_nextToken :: Lens' ListBatchJobExecutions (Maybe Text) Source #

A pagination token to control the number of batch job executions displayed in the list.

listBatchJobExecutions_startedAfter :: Lens' ListBatchJobExecutions (Maybe UTCTime) Source #

The time after which the batch job executions started.

listBatchJobExecutions_startedBefore :: Lens' ListBatchJobExecutions (Maybe UTCTime) Source #

The time before the batch job executions started.

listBatchJobExecutions_status :: Lens' ListBatchJobExecutions (Maybe BatchJobExecutionStatus) Source #

The status of the batch job executions.

listBatchJobExecutions_applicationId :: Lens' ListBatchJobExecutions Text Source #

The unique identifier of the application.

Destructuring the Response

data ListBatchJobExecutionsResponse Source #

See: newListBatchJobExecutionsResponse smart constructor.

Constructors

ListBatchJobExecutionsResponse'
Fields nextToken :: Maybe Text A pagination token that's returned when the response doesn't contain all batch job executions. httpStatus :: Int The response's http status code. batchJobExecutions :: [BatchJobExecutionSummary] Returns a list of batch job executions for an application.

Instances

Instances details

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

newListBatchJobExecutionsResponse Source #

Arguments

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

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

ListBatchJobExecutions, listBatchJobExecutionsResponse_nextToken - A pagination token that's returned when the response doesn't contain all batch job executions.

$sel:httpStatus:ListBatchJobExecutionsResponse', listBatchJobExecutionsResponse_httpStatus - The response's http status code.

$sel:batchJobExecutions:ListBatchJobExecutionsResponse', listBatchJobExecutionsResponse_batchJobExecutions - Returns a list of batch job executions for an application.

Response Lenses

listBatchJobExecutionsResponse_nextToken :: Lens' ListBatchJobExecutionsResponse (Maybe Text) Source #

A pagination token that's returned when the response doesn't contain all batch job executions.

listBatchJobExecutionsResponse_httpStatus :: Lens' ListBatchJobExecutionsResponse Int Source #

The response's http status code.

listBatchJobExecutionsResponse_batchJobExecutions :: Lens' ListBatchJobExecutionsResponse [BatchJobExecutionSummary] Source #

Returns a list of batch job executions for an application.