libZSservicesZSamazonka-honeycodeZSamazonka-honeycode
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.HoneyCode.QueryTableRows

Description

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

This operation returns paginated results.

Synopsis

Creating a Request

data QueryTableRows Source #

See: newQueryTableRows smart constructor.

Constructors

QueryTableRows' 

Fields

  • 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.

  • maxResults :: Maybe Natural

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

  • workbookId :: Text

    The ID of the workbook whose table rows are being queried.

    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 queried.

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

  • filterFormula :: Filter

    An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

Instances

Instances details
Eq QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Show QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Generic QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Associated Types

type Rep QueryTableRows :: Type -> Type #

NFData QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Methods

rnf :: QueryTableRows -> () #

Hashable QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

ToJSON QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

AWSPager QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

AWSRequest QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Associated Types

type AWSResponse QueryTableRows #

ToHeaders QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

ToPath QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

ToQuery QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

type Rep QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

type Rep QueryTableRows = D1 ('MetaData "QueryTableRows" "Amazonka.HoneyCode.QueryTableRows" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "QueryTableRows'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "workbookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "filterFormula") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Filter)))))
type AWSResponse QueryTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

newQueryTableRows Source #

Create a value of QueryTableRows 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:QueryTableRows', queryTableRows_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.

$sel:maxResults:QueryTableRows', queryTableRows_maxResults - The maximum number of rows to return in each page of the results.

$sel:workbookId:QueryTableRows', queryTableRows_workbookId - The ID of the workbook whose table rows are being queried.

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

$sel:tableId:QueryTableRows', queryTableRows_tableId - The ID of the table whose rows are being queried.

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

$sel:filterFormula:QueryTableRows', queryTableRows_filterFormula - An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

Request Lenses

queryTableRows_nextToken :: Lens' QueryTableRows (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.

queryTableRows_maxResults :: Lens' QueryTableRows (Maybe Natural) Source #

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

queryTableRows_workbookId :: Lens' QueryTableRows Text Source #

The ID of the workbook whose table rows are being queried.

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

queryTableRows_tableId :: Lens' QueryTableRows Text Source #

The ID of the table whose rows are being queried.

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

queryTableRows_filterFormula :: Lens' QueryTableRows Filter Source #

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

Destructuring the Response

data QueryTableRowsResponse Source #

See: newQueryTableRowsResponse smart constructor.

Constructors

QueryTableRowsResponse' 

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.

  • 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 that match the query filter.

  • 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
Eq QueryTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Show QueryTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Generic QueryTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Associated Types

type Rep QueryTableRowsResponse :: Type -> Type #

NFData QueryTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

Methods

rnf :: QueryTableRowsResponse -> () #

type Rep QueryTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.QueryTableRows

type Rep QueryTableRowsResponse = D1 ('MetaData "QueryTableRowsResponse" "Amazonka.HoneyCode.QueryTableRows" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "QueryTableRowsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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)))))

newQueryTableRowsResponse Source #

Create a value of QueryTableRowsResponse 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:QueryTableRows', queryTableRowsResponse_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:httpStatus:QueryTableRowsResponse', queryTableRowsResponse_httpStatus - The response's http status code.

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

$sel:rows:QueryTableRowsResponse', queryTableRowsResponse_rows - The list of rows in the table that match the query filter.

$sel:workbookCursor:QueryTableRowsResponse', queryTableRowsResponse_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

queryTableRowsResponse_nextToken :: Lens' QueryTableRowsResponse (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.

queryTableRowsResponse_columnIds :: Lens' QueryTableRowsResponse (NonEmpty Text) Source #

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

queryTableRowsResponse_rows :: Lens' QueryTableRowsResponse [TableRow] Source #

The list of rows in the table that match the query filter.

queryTableRowsResponse_workbookCursor :: Lens' QueryTableRowsResponse 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.