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.StepFunctions.GetExecutionHistory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

This operation returns paginated results.

Synopsis

data GetExecutionHistory = GetExecutionHistory' {
- includeExecutionData :: Maybe Bool
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- reverseOrder :: Maybe Bool
- executionArn :: Text
}
newGetExecutionHistory :: Text -> GetExecutionHistory
getExecutionHistory_includeExecutionData :: Lens' GetExecutionHistory (Maybe Bool)
getExecutionHistory_maxResults :: Lens' GetExecutionHistory (Maybe Natural)
getExecutionHistory_nextToken :: Lens' GetExecutionHistory (Maybe Text)
getExecutionHistory_reverseOrder :: Lens' GetExecutionHistory (Maybe Bool)
getExecutionHistory_executionArn :: Lens' GetExecutionHistory Text
data GetExecutionHistoryResponse = GetExecutionHistoryResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- events :: [HistoryEvent]
}
newGetExecutionHistoryResponse :: Int -> GetExecutionHistoryResponse
getExecutionHistoryResponse_nextToken :: Lens' GetExecutionHistoryResponse (Maybe Text)
getExecutionHistoryResponse_httpStatus :: Lens' GetExecutionHistoryResponse Int
getExecutionHistoryResponse_events :: Lens' GetExecutionHistoryResponse [HistoryEvent]

Creating a Request

data GetExecutionHistory Source #

See: newGetExecutionHistory smart constructor.

Constructors

GetExecutionHistory'

Fields

includeExecutionData :: Maybe Bool
You can select whether execution data (input or output of a history event) is returned. The default is true.
maxResults :: Maybe Natural
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
nextToken :: Maybe Text
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
reverseOrder :: Maybe Bool
Lists events in descending order of their timeStamp.
executionArn :: Text
The Amazon Resource Name (ARN) of the execution.

Instances

Instances details

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

newGetExecutionHistory Source #

Arguments

:: Text	`GetExecutionHistory`
-> GetExecutionHistory

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

GetExecutionHistory, getExecutionHistory_includeExecutionData - You can select whether execution data (input or output of a history event) is returned. The default is true.

$sel:maxResults:GetExecutionHistory', getExecutionHistory_maxResults - The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

GetExecutionHistory, getExecutionHistory_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

$sel:reverseOrder:GetExecutionHistory', getExecutionHistory_reverseOrder - Lists events in descending order of their timeStamp.

GetExecutionHistory, getExecutionHistory_executionArn - The Amazon Resource Name (ARN) of the execution.

Request Lenses

getExecutionHistory_includeExecutionData :: Lens' GetExecutionHistory (Maybe Bool) Source #

You can select whether execution data (input or output of a history event) is returned. The default is true.

getExecutionHistory_maxResults :: Lens' GetExecutionHistory (Maybe Natural) Source #

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

getExecutionHistory_nextToken :: Lens' GetExecutionHistory (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

getExecutionHistory_reverseOrder :: Lens' GetExecutionHistory (Maybe Bool) Source #

Lists events in descending order of their timeStamp.

getExecutionHistory_executionArn :: Lens' GetExecutionHistory Text Source #

The Amazon Resource Name (ARN) of the execution.

Destructuring the Response

data GetExecutionHistoryResponse Source #

See: newGetExecutionHistoryResponse smart constructor.

Constructors

GetExecutionHistoryResponse'

Fields

nextToken :: Maybe Text
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
httpStatus :: Int
The response's http status code.
events :: [HistoryEvent]
The list of events that occurred in the execution.

Instances

Instances details

Generic GetExecutionHistoryResponse Source #
Instance details Defined in Amazonka.StepFunctions.GetExecutionHistory Associated Types type Rep GetExecutionHistoryResponse :: Type -> Type # Methods from :: GetExecutionHistoryResponse -> Rep GetExecutionHistoryResponse x # to :: Rep GetExecutionHistoryResponse x -> GetExecutionHistoryResponse #
Show GetExecutionHistoryResponse Source #
Instance details Defined in Amazonka.StepFunctions.GetExecutionHistory Methods showsPrec :: Int -> GetExecutionHistoryResponse -> ShowS # show :: GetExecutionHistoryResponse -> String # showList :: [GetExecutionHistoryResponse] -> ShowS #
NFData GetExecutionHistoryResponse Source #
Instance details Defined in Amazonka.StepFunctions.GetExecutionHistory Methods rnf :: GetExecutionHistoryResponse -> () #
Eq GetExecutionHistoryResponse Source #
Instance details Defined in Amazonka.StepFunctions.GetExecutionHistory Methods (==) :: GetExecutionHistoryResponse -> GetExecutionHistoryResponse -> Bool # (/=) :: GetExecutionHistoryResponse -> GetExecutionHistoryResponse -> Bool #
type Rep GetExecutionHistoryResponse Source #
Instance details Defined in Amazonka.StepFunctions.GetExecutionHistory type Rep GetExecutionHistoryResponse = D1 ('MetaData "GetExecutionHistoryResponse" "Amazonka.StepFunctions.GetExecutionHistory" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "GetExecutionHistoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HistoryEvent]))))

newGetExecutionHistoryResponse Source #

Arguments

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

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

GetExecutionHistory, getExecutionHistoryResponse_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

$sel:httpStatus:GetExecutionHistoryResponse', getExecutionHistoryResponse_httpStatus - The response's http status code.

$sel:events:GetExecutionHistoryResponse', getExecutionHistoryResponse_events - The list of events that occurred in the execution.

Response Lenses

getExecutionHistoryResponse_nextToken :: Lens' GetExecutionHistoryResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

getExecutionHistoryResponse_httpStatus :: Lens' GetExecutionHistoryResponse Int Source #

The response's http status code.

getExecutionHistoryResponse_events :: Lens' GetExecutionHistoryResponse [HistoryEvent] Source #

The list of events that occurred in the execution.