Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
This operation returns paginated results.
- getExecutionHistory :: Text -> GetExecutionHistory
- data GetExecutionHistory
- gehReverseOrder :: Lens' GetExecutionHistory (Maybe Bool)
- gehNextToken :: Lens' GetExecutionHistory (Maybe Text)
- gehMaxResults :: Lens' GetExecutionHistory (Maybe Natural)
- gehExecutionARN :: Lens' GetExecutionHistory Text
- getExecutionHistoryResponse :: Int -> GetExecutionHistoryResponse
- data GetExecutionHistoryResponse
- gehrsNextToken :: Lens' GetExecutionHistoryResponse (Maybe Text)
- gehrsResponseStatus :: Lens' GetExecutionHistoryResponse Int
- gehrsEvents :: Lens' GetExecutionHistoryResponse [HistoryEvent]
Creating a Request
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 theirtimeStamp
.gehNextToken
- If anextToken
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 innextToken
. Keep all other arguments unchanged. The configuredmaxResults
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 100. A value of 0 means to use the default. 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 Source #
See: getExecutionHistory
smart constructor.
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
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) Source #
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 100. A value of 0 means to use the default. 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 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 anextToken
is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token innextToken
. Keep all other arguments unchanged. The configuredmaxResults
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.
Response Lenses
gehrsNextToken :: Lens' GetExecutionHistoryResponse (Maybe Text) Source #
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 Source #
- - | The response status code.
gehrsEvents :: Lens' GetExecutionHistoryResponse [HistoryEvent] Source #
The list of events that occurred in the execution.