amazonka-stepfunctions-1.6.1: Amazon Step Functions SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StepFunctions.GetExecutionHistory

Contents

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 a nextToken is 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.

This operation returns paginated results.

Synopsis

Creating a Request

getExecutionHistory Source #

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 is 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 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 100. 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.
  • gehExecutionARN - The Amazon Resource Name (ARN) of the execution.

data GetExecutionHistory Source #

See: getExecutionHistory smart constructor.

Instances
Eq GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Data GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.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 Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Show GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Generic GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Associated Types

type Rep GetExecutionHistory :: Type -> Type #

Hashable GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

ToJSON GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

AWSPager GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

AWSRequest GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Associated Types

type Rs GetExecutionHistory :: Type #

ToHeaders GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

ToPath GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

ToQuery GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

NFData GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Methods

rnf :: GetExecutionHistory -> () #

type Rep GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

type Rep GetExecutionHistory = D1 (MetaData "GetExecutionHistory" "Network.AWS.StepFunctions.GetExecutionHistory" "amazonka-stepfunctions-1.6.1-2PTLha96w99Qwy2XlD0kq" False) (C1 (MetaCons "GetExecutionHistory'" PrefixI True) ((S1 (MetaSel (Just "_gehReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_gehNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gehMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_gehExecutionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetExecutionHistory Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Request Lenses

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

Lists events in descending order of their timeStamp .

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

If a nextToken is 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) 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 100. 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.

gehExecutionARN :: Lens' GetExecutionHistory Text Source #

The Amazon Resource Name (ARN) of the execution.

Destructuring the Response

getExecutionHistoryResponse Source #

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 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.
  • gehrsResponseStatus - -- | The response status code.
  • gehrsEvents - The list of events that occurred in the execution.

data GetExecutionHistoryResponse Source #

See: getExecutionHistoryResponse smart constructor.

Instances
Eq GetExecutionHistoryResponse Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Data GetExecutionHistoryResponse Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

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 Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Show GetExecutionHistoryResponse Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Generic GetExecutionHistoryResponse Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

Associated Types

type Rep GetExecutionHistoryResponse :: Type -> Type #

NFData GetExecutionHistoryResponse Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

type Rep GetExecutionHistoryResponse Source # 
Instance details

Defined in Network.AWS.StepFunctions.GetExecutionHistory

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

Response Lenses

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

If a nextToken is 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.

gehrsEvents :: Lens' GetExecutionHistoryResponse [HistoryEvent] Source #

The list of events that occurred in the execution.