Amazonka.HoneyCode.ListTables

The ListTables API allows you to retrieve a list of all the tables in a workbook.

This operation returns paginated results.

Creating a Request

data ListTables

See: newListTables smart constructor.

Constructors

ListTables'

Fields

• maxResults :: Maybe Natural

  The maximum number of tables 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.

• workbookId :: Text

  The ID of the workbook whose tables are being retrieved.

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

Instances

ToHeaders ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

toHeaders :: ListTables -> [Header]

ToPath ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

toPath :: ListTables -> ByteString

ToQuery ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

toQuery :: ListTables -> QueryString

AWSPager ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

page :: ListTables -> AWSResponse ListTables -> Maybe ListTables

AWSRequest ListTables

Defined in Amazonka.HoneyCode.ListTables

Associated Types

type AWSResponse ListTables

Methods

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

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

Generic ListTables

Defined in Amazonka.HoneyCode.ListTables

Associated Types

type Rep ListTables :: Type -> Type

Methods

from :: ListTables -> Rep ListTables x

to :: Rep ListTables x -> ListTables

Read ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

readsPrec :: Int -> ReadS ListTables

readList :: ReadS [ListTables]

readPrec :: ReadPrec ListTables

readListPrec :: ReadPrec [ListTables]

Show ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

showsPrec :: Int -> ListTables -> ShowS

show :: ListTables -> String

showList :: [ListTables] -> ShowS

NFData ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

rnf :: ListTables -> ()

Eq ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

(==) :: ListTables -> ListTables -> Bool

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

Hashable ListTables

Defined in Amazonka.HoneyCode.ListTables

Methods

hashWithSalt :: Int -> ListTables -> Int

hash :: ListTables -> Int

type AWSResponse ListTables

Defined in Amazonka.HoneyCode.ListTables

type AWSResponse ListTables = ListTablesResponse

type Rep ListTables

Defined in Amazonka.HoneyCode.ListTables

type Rep ListTables = D1 ('MetaData "ListTables" "Amazonka.HoneyCode.ListTables" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "ListTables'" '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 "workbookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListTables

Arguments

:: Text

$sel:workbookId:ListTables'

-> 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 maximum number of tables to return in each page of the results.

ListTables, listTables_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:ListTables', listTables_workbookId - The ID of the workbook whose tables are being retrieved.

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

Request Lenses

listTables_maxResults :: Lens' ListTables (Maybe Natural)

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

listTables_nextToken :: Lens' ListTables (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.

listTables_workbookId :: Lens' ListTables Text

The ID of the workbook whose tables are being retrieved.

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

Destructuring the Response

data ListTablesResponse

See: newListTablesResponse smart constructor.

Constructors

ListTablesResponse'

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.

• tables :: [Table]

  The list of tables in the workbook.

Instances

Generic ListTablesResponse

Defined in Amazonka.HoneyCode.ListTables

Associated Types

type Rep ListTablesResponse :: Type -> Type

Methods

from :: ListTablesResponse -> Rep ListTablesResponse x

to :: Rep ListTablesResponse x -> ListTablesResponse

Read ListTablesResponse

Defined in Amazonka.HoneyCode.ListTables

Methods

readsPrec :: Int -> ReadS ListTablesResponse

readList :: ReadS [ListTablesResponse]

readPrec :: ReadPrec ListTablesResponse

readListPrec :: ReadPrec [ListTablesResponse]

Show ListTablesResponse

Defined in Amazonka.HoneyCode.ListTables

Methods

showsPrec :: Int -> ListTablesResponse -> ShowS

show :: ListTablesResponse -> String

showList :: [ListTablesResponse] -> ShowS

NFData ListTablesResponse

Defined in Amazonka.HoneyCode.ListTables

Methods

rnf :: ListTablesResponse -> ()

Eq ListTablesResponse

Defined in Amazonka.HoneyCode.ListTables

Methods

(==) :: ListTablesResponse -> ListTablesResponse -> Bool

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

type Rep ListTablesResponse

Defined in Amazonka.HoneyCode.ListTables

type Rep ListTablesResponse = D1 ('MetaData "ListTablesResponse" "Amazonka.HoneyCode.ListTables" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "ListTablesResponse'" '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 "tables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Table]))))

newListTablesResponse

Arguments

:: Int

$sel:httpStatus:ListTablesResponse'

-> ListTablesResponse

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 - 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:ListTablesResponse', listTablesResponse_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:ListTablesResponse', listTablesResponse_httpStatus - The response's http status code.

$sel:tables:ListTablesResponse', listTablesResponse_tables - The list of tables in the workbook.

Response Lenses

listTablesResponse_nextToken :: Lens' ListTablesResponse (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.

listTablesResponse_workbookCursor :: Lens' ListTablesResponse (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.

listTablesResponse_httpStatus :: Lens' ListTablesResponse Int

The response's http status code.

listTablesResponse_tables :: Lens' ListTablesResponse [Table]

The list of tables in the workbook.