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.KeySpaces.ListKeyspaces
Description
Returns a list of keyspaces.
This operation returns paginated results.
Synopsis
- data ListKeyspaces = ListKeyspaces' {}
- newListKeyspaces :: ListKeyspaces
- listKeyspaces_maxResults :: Lens' ListKeyspaces (Maybe Natural)
- listKeyspaces_nextToken :: Lens' ListKeyspaces (Maybe Text)
- data ListKeyspacesResponse = ListKeyspacesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- keyspaces :: [KeyspaceSummary]
- newListKeyspacesResponse :: Int -> ListKeyspacesResponse
- listKeyspacesResponse_nextToken :: Lens' ListKeyspacesResponse (Maybe Text)
- listKeyspacesResponse_httpStatus :: Lens' ListKeyspacesResponse Int
- listKeyspacesResponse_keyspaces :: Lens' ListKeyspacesResponse [KeyspaceSummary]
Creating a Request
data ListKeyspaces Source #
See: newListKeyspaces
smart constructor.
Constructors
ListKeyspaces' | |
Fields
|
Instances
newListKeyspaces :: ListKeyspaces Source #
Create a value of ListKeyspaces
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:maxResults:ListKeyspaces'
, listKeyspaces_maxResults
- The total number of keyspaces to return in the output. If the total
number of keyspaces available is more than the value specified, a
NextToken
is provided in the output. To resume pagination, provide the
NextToken
value as an argument of a subsequent API invocation.
ListKeyspaces
, listKeyspaces_nextToken
- The pagination token. To resume pagination, provide the NextToken
value as argument of a subsequent API invocation.
Request Lenses
listKeyspaces_maxResults :: Lens' ListKeyspaces (Maybe Natural) Source #
The total number of keyspaces to return in the output. If the total
number of keyspaces available is more than the value specified, a
NextToken
is provided in the output. To resume pagination, provide the
NextToken
value as an argument of a subsequent API invocation.
listKeyspaces_nextToken :: Lens' ListKeyspaces (Maybe Text) Source #
The pagination token. To resume pagination, provide the NextToken
value as argument of a subsequent API invocation.
Destructuring the Response
data ListKeyspacesResponse Source #
See: newListKeyspacesResponse
smart constructor.
Constructors
ListKeyspacesResponse' | |
Fields
|
Instances
newListKeyspacesResponse Source #
Create a value of ListKeyspacesResponse
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:
ListKeyspaces
, listKeyspacesResponse_nextToken
- A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
$sel:httpStatus:ListKeyspacesResponse'
, listKeyspacesResponse_httpStatus
- The response's http status code.
$sel:keyspaces:ListKeyspacesResponse'
, listKeyspacesResponse_keyspaces
- A list of keyspaces.
Response Lenses
listKeyspacesResponse_nextToken :: Lens' ListKeyspacesResponse (Maybe Text) Source #
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
listKeyspacesResponse_httpStatus :: Lens' ListKeyspacesResponse Int Source #
The response's http status code.
listKeyspacesResponse_keyspaces :: Lens' ListKeyspacesResponse [KeyspaceSummary] Source #
A list of keyspaces.