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 |
Returns a list of tables for a specified keyspace.
This operation returns paginated results.
Synopsis
- data ListTables = ListTables' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- keyspaceName :: Text
- newListTables :: Text -> ListTables
- listTables_maxResults :: Lens' ListTables (Maybe Natural)
- listTables_nextToken :: Lens' ListTables (Maybe Text)
- listTables_keyspaceName :: Lens' ListTables Text
- data ListTablesResponse = ListTablesResponse' {
- nextToken :: Maybe Text
- tables :: Maybe [TableSummary]
- httpStatus :: Int
- newListTablesResponse :: Int -> ListTablesResponse
- listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
- listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableSummary])
- listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
Creating a Request
data ListTables Source #
See: newListTables
smart constructor.
ListTables' | |
|
Instances
:: Text | |
-> ListTables |
Create a value of ListTables
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:ListTables'
, listTables_maxResults
- The total number of tables to return in the output. If the total number
of tables 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.
ListTables
, listTables_nextToken
- The pagination token. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
ListTables
, listTables_keyspaceName
- The name of the keyspace.
Request Lenses
listTables_maxResults :: Lens' ListTables (Maybe Natural) Source #
The total number of tables to return in the output. If the total number
of tables 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.
listTables_nextToken :: Lens' ListTables (Maybe Text) Source #
The pagination token. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
listTables_keyspaceName :: Lens' ListTables Text Source #
The name of the keyspace.
Destructuring the Response
data ListTablesResponse Source #
See: newListTablesResponse
smart constructor.
ListTablesResponse' | |
|
Instances
newListTablesResponse Source #
Create a value of ListTablesResponse
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:
ListTables
, listTablesResponse_nextToken
- A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
$sel:tables:ListTablesResponse'
, listTablesResponse_tables
- A list of tables.
$sel:httpStatus:ListTablesResponse'
, listTablesResponse_httpStatus
- The response's http status code.
Response Lenses
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text) Source #
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableSummary]) Source #
A list of tables.
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int Source #
The response's http status code.