| Copyright | (c) 2013-2021 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 |
Amazonka.StepFunctions.ListStateMachines
Description
Lists the existing state machines.
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 operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This operation returns paginated results.
Synopsis
- data ListStateMachines = ListStateMachines' {}
- newListStateMachines :: ListStateMachines
- listStateMachines_nextToken :: Lens' ListStateMachines (Maybe Text)
- listStateMachines_maxResults :: Lens' ListStateMachines (Maybe Natural)
- data ListStateMachinesResponse = ListStateMachinesResponse' {}
- newListStateMachinesResponse :: Int -> ListStateMachinesResponse
- listStateMachinesResponse_nextToken :: Lens' ListStateMachinesResponse (Maybe Text)
- listStateMachinesResponse_httpStatus :: Lens' ListStateMachinesResponse Int
- listStateMachinesResponse_stateMachines :: Lens' ListStateMachinesResponse [StateMachineListItem]
Creating a Request
data ListStateMachines Source #
See: newListStateMachines smart constructor.
Constructors
| ListStateMachines' | |
Fields
| |
Instances
newListStateMachines :: ListStateMachines Source #
Create a value of ListStateMachines 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:nextToken:ListStateMachines', listStateMachines_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:maxResults:ListStateMachines', listStateMachines_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.
Request Lenses
listStateMachines_nextToken :: Lens' ListStateMachines (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.
listStateMachines_maxResults :: Lens' ListStateMachines (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.
Destructuring the Response
data ListStateMachinesResponse Source #
See: newListStateMachinesResponse smart constructor.
Constructors
| ListStateMachinesResponse' | |
Fields
| |
Instances
newListStateMachinesResponse Source #
Create a value of ListStateMachinesResponse 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:nextToken:ListStateMachines', listStateMachinesResponse_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:ListStateMachinesResponse', listStateMachinesResponse_httpStatus - The response's http status code.
$sel:stateMachines:ListStateMachinesResponse', listStateMachinesResponse_stateMachines - Undocumented member.
Response Lenses
listStateMachinesResponse_nextToken :: Lens' ListStateMachinesResponse (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.
listStateMachinesResponse_httpStatus :: Lens' ListStateMachinesResponse Int Source #
The response's http status code.
listStateMachinesResponse_stateMachines :: Lens' ListStateMachinesResponse [StateMachineListItem] Source #
Undocumented member.