Amazonka.HoneyCode.ListTableColumns

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

This operation returns paginated results.

Creating a Request

data ListTableColumns

See: newListTableColumns smart constructor.

Constructors

ListTableColumns'

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.

• workbookId :: Text

  The ID of the workbook that contains the table whose columns 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 columns are being retrieved.

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

Instances

ToHeaders ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

toHeaders :: ListTableColumns -> [Header]

ToPath ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

toPath :: ListTableColumns -> ByteString

ToQuery ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

toQuery :: ListTableColumns -> QueryString

AWSPager ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

page :: ListTableColumns -> AWSResponse ListTableColumns -> Maybe ListTableColumns

AWSRequest ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Associated Types

type AWSResponse ListTableColumns

Methods

request :: (Service -> Service) -> ListTableColumns -> Request ListTableColumns

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTableColumns -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTableColumns)))

Generic ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Associated Types

type Rep ListTableColumns :: Type -> Type

Methods

from :: ListTableColumns -> Rep ListTableColumns x

to :: Rep ListTableColumns x -> ListTableColumns

Read ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

readsPrec :: Int -> ReadS ListTableColumns

readList :: ReadS [ListTableColumns]

readPrec :: ReadPrec ListTableColumns

readListPrec :: ReadPrec [ListTableColumns]

Show ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

showsPrec :: Int -> ListTableColumns -> ShowS

show :: ListTableColumns -> String

showList :: [ListTableColumns] -> ShowS

NFData ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

rnf :: ListTableColumns -> ()

Eq ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

(==) :: ListTableColumns -> ListTableColumns -> Bool

(/=) :: ListTableColumns -> ListTableColumns -> Bool

Hashable ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

hashWithSalt :: Int -> ListTableColumns -> Int

hash :: ListTableColumns -> Int

type AWSResponse ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

type AWSResponse ListTableColumns = ListTableColumnsResponse

type Rep ListTableColumns

Defined in Amazonka.HoneyCode.ListTableColumns

type Rep ListTableColumns = D1 ('MetaData "ListTableColumns" "Amazonka.HoneyCode.ListTableColumns" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "ListTableColumns'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "workbookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListTableColumns

Arguments

:: Text

$sel:workbookId:ListTableColumns'

-> Text

ListTableColumns

-> ListTableColumns

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

ListTableColumns, listTableColumns_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:workbookId:ListTableColumns', listTableColumns_workbookId - The ID of the workbook that contains the table whose columns are being retrieved.

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

ListTableColumns, listTableColumns_tableId - The ID of the table whose columns are being retrieved.

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

Request Lenses

listTableColumns_nextToken :: Lens' ListTableColumns (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.

listTableColumns_workbookId :: Lens' ListTableColumns Text

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

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

listTableColumns_tableId :: Lens' ListTableColumns Text

The ID of the table whose columns are being retrieved.

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

Destructuring the Response

data ListTableColumnsResponse

See: newListTableColumnsResponse smart constructor.

Constructors

ListTableColumnsResponse'

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.

• workbookCursor :: Maybe 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.

• httpStatus :: Int

  The response's http status code.

• tableColumns :: [TableColumn]

  The list of columns in the table.

Instances

Generic ListTableColumnsResponse

Defined in Amazonka.HoneyCode.ListTableColumns

Associated Types

type Rep ListTableColumnsResponse :: Type -> Type

Methods

from :: ListTableColumnsResponse -> Rep ListTableColumnsResponse x

to :: Rep ListTableColumnsResponse x -> ListTableColumnsResponse

Read ListTableColumnsResponse

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

readsPrec :: Int -> ReadS ListTableColumnsResponse

readList :: ReadS [ListTableColumnsResponse]

readPrec :: ReadPrec ListTableColumnsResponse

readListPrec :: ReadPrec [ListTableColumnsResponse]

Show ListTableColumnsResponse

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

showsPrec :: Int -> ListTableColumnsResponse -> ShowS

show :: ListTableColumnsResponse -> String

showList :: [ListTableColumnsResponse] -> ShowS

NFData ListTableColumnsResponse

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

rnf :: ListTableColumnsResponse -> ()

Eq ListTableColumnsResponse

Defined in Amazonka.HoneyCode.ListTableColumns

Methods

(==) :: ListTableColumnsResponse -> ListTableColumnsResponse -> Bool

(/=) :: ListTableColumnsResponse -> ListTableColumnsResponse -> Bool

type Rep ListTableColumnsResponse

Defined in Amazonka.HoneyCode.ListTableColumns

type Rep ListTableColumnsResponse = D1 ('MetaData "ListTableColumnsResponse" "Amazonka.HoneyCode.ListTableColumns" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "ListTableColumnsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workbookCursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "tableColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TableColumn]))))

newListTableColumnsResponse

Arguments

:: Int

$sel:httpStatus:ListTableColumnsResponse'

-> ListTableColumnsResponse

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

ListTableColumns, listTableColumnsResponse_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:workbookCursor:ListTableColumnsResponse', listTableColumnsResponse_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.

$sel:httpStatus:ListTableColumnsResponse', listTableColumnsResponse_httpStatus - The response's http status code.

$sel:tableColumns:ListTableColumnsResponse', listTableColumnsResponse_tableColumns - The list of columns in the table.

Response Lenses

listTableColumnsResponse_nextToken :: Lens' ListTableColumnsResponse (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.

listTableColumnsResponse_workbookCursor :: Lens' ListTableColumnsResponse (Maybe 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.

listTableColumnsResponse_httpStatus :: Lens' ListTableColumnsResponse Int

The response's http status code.

listTableColumnsResponse_tableColumns :: Lens' ListTableColumnsResponse [TableColumn]

The list of columns in the table.