Network.AWS.StepFunctions.GetExecutionHistory

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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Creating a Request

getExecutionHistory

Arguments

:: Text

gehExecutionARN

-> GetExecutionHistory

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

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

• gehReverseOrder - Lists events in descending order of their timeStamp .
• gehNextToken - If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged. The configured maxResults determines how many results can be returned in a single call.
• gehMaxResults - The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
• gehExecutionARN - The Amazon Resource Name (ARN) of the execution.

data GetExecutionHistory

See: getExecutionHistory smart constructor.

Instances

Eq GetExecutionHistory

Methods

(==) :: GetExecutionHistory -> GetExecutionHistory -> Bool

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

Data GetExecutionHistory

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetExecutionHistory -> c GetExecutionHistory

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetExecutionHistory

toConstr :: GetExecutionHistory -> Constr

dataTypeOf :: GetExecutionHistory -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetExecutionHistory)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetExecutionHistory)

gmapT :: (forall b. Data b => b -> b) -> GetExecutionHistory -> GetExecutionHistory

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetExecutionHistory -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetExecutionHistory -> r

gmapQ :: (forall d. Data d => d -> u) -> GetExecutionHistory -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetExecutionHistory -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetExecutionHistory -> m GetExecutionHistory

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetExecutionHistory -> m GetExecutionHistory

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetExecutionHistory -> m GetExecutionHistory

Read GetExecutionHistory

Methods

readsPrec :: Int -> ReadS GetExecutionHistory

readList :: ReadS [GetExecutionHistory]

readPrec :: ReadPrec GetExecutionHistory

readListPrec :: ReadPrec [GetExecutionHistory]

Show GetExecutionHistory

Methods

showsPrec :: Int -> GetExecutionHistory -> ShowS

show :: GetExecutionHistory -> String

showList :: [GetExecutionHistory] -> ShowS

Generic GetExecutionHistory

Associated Types

type Rep GetExecutionHistory :: * -> *

Methods

from :: GetExecutionHistory -> Rep GetExecutionHistory x

to :: Rep GetExecutionHistory x -> GetExecutionHistory

Hashable GetExecutionHistory

Methods

hashWithSalt :: Int -> GetExecutionHistory -> Int

hash :: GetExecutionHistory -> Int

ToJSON GetExecutionHistory

Methods

toJSON :: GetExecutionHistory -> Value

toEncoding :: GetExecutionHistory -> Encoding

toJSONList :: [GetExecutionHistory] -> Value

toEncodingList :: [GetExecutionHistory] -> Encoding

NFData GetExecutionHistory

Methods

rnf :: GetExecutionHistory -> ()

AWSRequest GetExecutionHistory

Associated Types

type Rs GetExecutionHistory :: *

Methods

request :: GetExecutionHistory -> Request GetExecutionHistory

response :: MonadResource m => Logger -> Service -> Proxy * GetExecutionHistory -> ClientResponse -> m (Response GetExecutionHistory)

ToPath GetExecutionHistory

Methods

toPath :: GetExecutionHistory -> ByteString

ToHeaders GetExecutionHistory

Methods

toHeaders :: GetExecutionHistory -> [Header]

ToQuery GetExecutionHistory

Methods

toQuery :: GetExecutionHistory -> QueryString

type Rep GetExecutionHistory

type Rep GetExecutionHistory = D1 (MetaData "GetExecutionHistory" "Network.AWS.StepFunctions.GetExecutionHistory" "amazonka-stepfunctions-1.4.5-WXy4AxO2hM72RNEOsME5O" False) (C1 (MetaCons "GetExecutionHistory'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gehReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gehNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gehMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_gehExecutionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetExecutionHistory

type Rs GetExecutionHistory = GetExecutionHistoryResponse

Request Lenses

gehReverseOrder :: Lens' GetExecutionHistory (Maybe Bool)

Lists events in descending order of their timeStamp .

gehNextToken :: Lens' GetExecutionHistory (Maybe Text)

If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged. The configured maxResults determines how many results can be returned in a single call.

gehMaxResults :: Lens' GetExecutionHistory (Maybe Natural)

The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

gehExecutionARN :: Lens' GetExecutionHistory Text

The Amazon Resource Name (ARN) of the execution.

Destructuring the Response

getExecutionHistoryResponse

Arguments

:: Int

gehrsResponseStatus

-> GetExecutionHistoryResponse

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

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

• gehrsNextToken - If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged. The configured maxResults determines how many results can be returned in a single call.
• gehrsResponseStatus - -- | The response status code.
• gehrsEvents - The list of events that occurred in the execution.

data GetExecutionHistoryResponse

See: getExecutionHistoryResponse smart constructor.

Instances

Eq GetExecutionHistoryResponse

Methods

(==) :: GetExecutionHistoryResponse -> GetExecutionHistoryResponse -> Bool

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

Data GetExecutionHistoryResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetExecutionHistoryResponse -> c GetExecutionHistoryResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetExecutionHistoryResponse

toConstr :: GetExecutionHistoryResponse -> Constr

dataTypeOf :: GetExecutionHistoryResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetExecutionHistoryResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetExecutionHistoryResponse)

gmapT :: (forall b. Data b => b -> b) -> GetExecutionHistoryResponse -> GetExecutionHistoryResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetExecutionHistoryResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetExecutionHistoryResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetExecutionHistoryResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetExecutionHistoryResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetExecutionHistoryResponse -> m GetExecutionHistoryResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetExecutionHistoryResponse -> m GetExecutionHistoryResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetExecutionHistoryResponse -> m GetExecutionHistoryResponse

Read GetExecutionHistoryResponse

Methods

readsPrec :: Int -> ReadS GetExecutionHistoryResponse

readList :: ReadS [GetExecutionHistoryResponse]

readPrec :: ReadPrec GetExecutionHistoryResponse

readListPrec :: ReadPrec [GetExecutionHistoryResponse]

Show GetExecutionHistoryResponse

Methods

showsPrec :: Int -> GetExecutionHistoryResponse -> ShowS

show :: GetExecutionHistoryResponse -> String

showList :: [GetExecutionHistoryResponse] -> ShowS

Generic GetExecutionHistoryResponse

Associated Types

type Rep GetExecutionHistoryResponse :: * -> *

Methods

from :: GetExecutionHistoryResponse -> Rep GetExecutionHistoryResponse x

to :: Rep GetExecutionHistoryResponse x -> GetExecutionHistoryResponse

NFData GetExecutionHistoryResponse

Methods

rnf :: GetExecutionHistoryResponse -> ()

type Rep GetExecutionHistoryResponse

type Rep GetExecutionHistoryResponse = D1 (MetaData "GetExecutionHistoryResponse" "Network.AWS.StepFunctions.GetExecutionHistory" "amazonka-stepfunctions-1.4.5-WXy4AxO2hM72RNEOsME5O" False) (C1 (MetaCons "GetExecutionHistoryResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gehrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gehrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_gehrsEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [HistoryEvent])))))

Response Lenses

gehrsNextToken :: Lens' GetExecutionHistoryResponse (Maybe Text)

If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken . Keep all other arguments unchanged. The configured maxResults determines how many results can be returned in a single call.

gehrsResponseStatus :: Lens' GetExecutionHistoryResponse Int

• - | The response status code.

gehrsEvents :: Lens' GetExecutionHistoryResponse [HistoryEvent]

The list of events that occurred in the execution.