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.HoneyCode.ListTableRows

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

This operation returns paginated results.

Synopsis

data ListTableRows = ListTableRows' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- rowIds :: Maybe (NonEmpty Text)
- workbookId :: Text
- tableId :: Text
}
newListTableRows :: Text -> Text -> ListTableRows
listTableRows_maxResults :: Lens' ListTableRows (Maybe Natural)
listTableRows_nextToken :: Lens' ListTableRows (Maybe Text)
listTableRows_rowIds :: Lens' ListTableRows (Maybe (NonEmpty Text))
listTableRows_workbookId :: Lens' ListTableRows Text
listTableRows_tableId :: Lens' ListTableRows Text
data ListTableRowsResponse = ListTableRowsResponse' {
- nextToken :: Maybe Text
- rowIdsNotFound :: Maybe (NonEmpty Text)
- httpStatus :: Int
- columnIds :: NonEmpty Text
- rows :: [TableRow]
- workbookCursor :: Integer
}
newListTableRowsResponse :: Int -> NonEmpty Text -> Integer -> ListTableRowsResponse
listTableRowsResponse_nextToken :: Lens' ListTableRowsResponse (Maybe Text)
listTableRowsResponse_rowIdsNotFound :: Lens' ListTableRowsResponse (Maybe (NonEmpty Text))
listTableRowsResponse_httpStatus :: Lens' ListTableRowsResponse Int
listTableRowsResponse_columnIds :: Lens' ListTableRowsResponse (NonEmpty Text)
listTableRowsResponse_rows :: Lens' ListTableRowsResponse [TableRow]
listTableRowsResponse_workbookCursor :: Lens' ListTableRowsResponse Integer

Creating a Request

data ListTableRows Source #

See: newListTableRows smart constructor.

Constructors

ListTableRows'

Fields

maxResults :: Maybe Natural
The maximum number of rows to return in each page of the results.
nextToken :: Maybe Text
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
rowIds :: Maybe (NonEmpty Text)
This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
workbookId :: Text
The ID of the workbook that contains the table whose rows are being retrieved.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
tableId :: Text
The ID of the table whose rows are being retrieved.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Instances

Instances details

ToJSON ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods toJSON :: ListTableRows -> Value # toEncoding :: ListTableRows -> Encoding # toJSONList :: [ListTableRows] -> Value # toEncodingList :: [ListTableRows] -> Encoding #
ToHeaders ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods toHeaders :: ListTableRows -> [Header] #
ToPath ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods toPath :: ListTableRows -> ByteString #
ToQuery ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods toQuery :: ListTableRows -> QueryString #
AWSPager ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods page :: ListTableRows -> AWSResponse ListTableRows -> Maybe ListTableRows #
AWSRequest ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Associated Types type AWSResponse ListTableRows # Methods request :: (Service -> Service) -> ListTableRows -> Request ListTableRows # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTableRows -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTableRows))) #
Generic ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Associated Types type Rep ListTableRows :: Type -> Type # Methods from :: ListTableRows -> Rep ListTableRows x # to :: Rep ListTableRows x -> ListTableRows #
Read ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods readsPrec :: Int -> ReadS ListTableRows # readList :: ReadS [ListTableRows] # readPrec :: ReadPrec ListTableRows # readListPrec :: ReadPrec [ListTableRows] #
Show ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods showsPrec :: Int -> ListTableRows -> ShowS # show :: ListTableRows -> String # showList :: [ListTableRows] -> ShowS #
NFData ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods rnf :: ListTableRows -> () #
Eq ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods (==) :: ListTableRows -> ListTableRows -> Bool # (/=) :: ListTableRows -> ListTableRows -> Bool #
Hashable ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods hashWithSalt :: Int -> ListTableRows -> Int # hash :: ListTableRows -> Int #
type AWSResponse ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows type AWSResponse ListTableRows = ListTableRowsResponse
type Rep ListTableRows Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows type Rep ListTableRows = D1 ('MetaData "ListTableRows" "Amazonka.HoneyCode.ListTableRows" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "ListTableRows'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "rowIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "workbookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListTableRows Source #

Arguments

:: Text	`$sel:workbookId:ListTableRows'`
-> Text	`ListTableRows`
-> ListTableRows

Create a value of ListTableRows 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:ListTableRows', listTableRows_maxResults - The maximum number of rows to return in each page of the results.

ListTableRows, listTableRows_nextToken - This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

ListTableRows, listTableRows_rowIds - This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

$sel:workbookId:ListTableRows', listTableRows_workbookId - The ID of the workbook that contains the table whose rows are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

ListTableRows, listTableRows_tableId - The ID of the table whose rows are being retrieved.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Request Lenses

listTableRows_maxResults :: Lens' ListTableRows (Maybe Natural) Source #

The maximum number of rows to return in each page of the results.

listTableRows_nextToken :: Lens' ListTableRows (Maybe Text) Source #

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

listTableRows_rowIds :: Lens' ListTableRows (Maybe (NonEmpty Text)) Source #

This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

listTableRows_workbookId :: Lens' ListTableRows Text Source #

The ID of the workbook that contains the table whose rows are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

listTableRows_tableId :: Lens' ListTableRows Text Source #

The ID of the table whose rows are being retrieved.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Destructuring the Response

data ListTableRowsResponse Source #

See: newListTableRowsResponse smart constructor.

Constructors

ListTableRowsResponse'

Fields

nextToken :: Maybe Text
Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.
rowIdsNotFound :: Maybe (NonEmpty Text)
The list of row ids included in the request that were not found in the table.
httpStatus :: Int
The response's http status code.
columnIds :: NonEmpty Text
The list of columns in the table whose row data is returned in the result.
rows :: [TableRow]
The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows.
workbookCursor :: Integer
Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

Instances

Instances details

Generic ListTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Associated Types type Rep ListTableRowsResponse :: Type -> Type # Methods from :: ListTableRowsResponse -> Rep ListTableRowsResponse x # to :: Rep ListTableRowsResponse x -> ListTableRowsResponse #
Show ListTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods showsPrec :: Int -> ListTableRowsResponse -> ShowS # show :: ListTableRowsResponse -> String # showList :: [ListTableRowsResponse] -> ShowS #
NFData ListTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods rnf :: ListTableRowsResponse -> () #
Eq ListTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows Methods (==) :: ListTableRowsResponse -> ListTableRowsResponse -> Bool # (/=) :: ListTableRowsResponse -> ListTableRowsResponse -> Bool #
type Rep ListTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.ListTableRows type Rep ListTableRowsResponse = D1 ('MetaData "ListTableRowsResponse" "Amazonka.HoneyCode.ListTableRows" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "ListTableRowsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "rowIdsNotFound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: (S1 ('MetaSel ('Just "columnIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: (S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TableRow]) :*: S1 ('MetaSel ('Just "workbookCursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))))

newListTableRowsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTableRowsResponse'`
-> NonEmpty Text	`$sel:columnIds:ListTableRowsResponse'`
-> Integer	`$sel:workbookCursor:ListTableRowsResponse'`
-> ListTableRowsResponse

Create a value of ListTableRowsResponse 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:

ListTableRows, listTableRowsResponse_nextToken - Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

$sel:rowIdsNotFound:ListTableRowsResponse', listTableRowsResponse_rowIdsNotFound - The list of row ids included in the request that were not found in the table.

$sel:httpStatus:ListTableRowsResponse', listTableRowsResponse_httpStatus - The response's http status code.

$sel:columnIds:ListTableRowsResponse', listTableRowsResponse_columnIds - The list of columns in the table whose row data is returned in the result.

ListTableRowsResponse, listTableRowsResponse_rows - The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows.

$sel:workbookCursor:ListTableRowsResponse', listTableRowsResponse_workbookCursor - Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

Response Lenses

listTableRowsResponse_nextToken :: Lens' ListTableRowsResponse (Maybe Text) Source #

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

listTableRowsResponse_rowIdsNotFound :: Lens' ListTableRowsResponse (Maybe (NonEmpty Text)) Source #

The list of row ids included in the request that were not found in the table.

listTableRowsResponse_httpStatus :: Lens' ListTableRowsResponse Int Source #

The response's http status code.

listTableRowsResponse_columnIds :: Lens' ListTableRowsResponse (NonEmpty Text) Source #

The list of columns in the table whose row data is returned in the result.

listTableRowsResponse_rows :: Lens' ListTableRowsResponse [TableRow] Source #

The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows.

listTableRowsResponse_workbookCursor :: Lens' ListTableRowsResponse Integer Source #

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.