• 沒有找到結果。

Amazon Honeycode

N/A
N/A
Protected

Academic year: 2022

Share "Amazon Honeycode"

Copied!
94
0
0

加載中.... (立即查看全文)

全文

(1)

Amazon Honeycode

API Reference

API Version 2020-03-01

(2)

Amazon Honeycode: API Reference

Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

(3)

Table of Contents

Welcome ... 1

Actions ... 2

BatchCreateTableRows ... 3

Request Syntax ... 3

URI Request Parameters ... 3

Request Body ... 4

Response Syntax ... 4

Response Elements ... 4

Errors ... 5

See Also ... 6

BatchDeleteTableRows ... 7

Request Syntax ... 7

URI Request Parameters ... 7

Request Body ... 7

Response Syntax ... 8

Response Elements ... 8

Errors ... 9

See Also ... 9

BatchUpdateTableRows ... 11

Request Syntax ... 11

URI Request Parameters ... 11

Request Body ... 12

Response Syntax ... 12

Response Elements ... 12

Errors ... 13

See Also ... 14

BatchUpsertTableRows ... 15

Request Syntax ... 15

URI Request Parameters ... 15

Request Body ... 16

Response Syntax ... 16

Response Elements ... 17

Errors ... 17

See Also ... 18

DescribeTableDataImportJob ... 19

Request Syntax ... 19

URI Request Parameters ... 19

Request Body ... 19

Response Syntax ... 19

Response Elements ... 20

Errors ... 21

See Also ... 21

GetScreenData ... 23

Request Syntax ... 23

URI Request Parameters ... 23

Request Body ... 23

Response Syntax ... 24

Response Elements ... 25

Errors ... 25

See Also ... 26

InvokeScreenAutomation ... 27

Request Syntax ... 27

URI Request Parameters ... 27

Request Body ... 28

(4)

Response Syntax ... 29

Response Elements ... 29

Errors ... 29

See Also ... 30

ListTableColumns ... 31

Request Syntax ... 31

URI Request Parameters ... 31

Request Body ... 31

Response Syntax ... 31

Response Elements ... 32

Errors ... 32

See Also ... 33

ListTableRows ... 34

Request Syntax ... 34

URI Request Parameters ... 34

Request Body ... 34

Response Syntax ... 35

Response Elements ... 36

Errors ... 36

See Also ... 37

ListTables ... 38

Request Syntax ... 38

URI Request Parameters ... 38

Request Body ... 38

Response Syntax ... 38

Response Elements ... 39

Errors ... 39

See Also ... 40

ListTagsForResource ... 41

Request Syntax ... 41

URI Request Parameters ... 41

Request Body ... 41

Response Syntax ... 41

Response Elements ... 41

Errors ... 42

See Also ... 42

QueryTableRows ... 44

Request Syntax ... 44

URI Request Parameters ... 44

Request Body ... 44

Response Syntax ... 45

Response Elements ... 45

Errors ... 46

See Also ... 47

StartTableDataImportJob ... 48

Request Syntax ... 48

URI Request Parameters ... 48

Request Body ... 49

Response Syntax ... 49

Response Elements ... 50

Errors ... 50

See Also ... 51

TagResource ... 52

Request Syntax ... 52

URI Request Parameters ... 52

Request Body ... 52

Response Syntax ... 52

(5)

Response Elements ... 53

Errors ... 53

See Also ... 53

UntagResource ... 55

Request Syntax ... 55

URI Request Parameters ... 55

Request Body ... 55

Response Syntax ... 55

Response Elements ... 55

Errors ... 55

See Also ... 56

Data Types ... 57

Cell ... 58

Contents ... 58

See Also ... 60

CellInput ... 61

Contents ... 61

See Also ... 61

ColumnMetadata ... 62

Contents ... 62

See Also ... 62

CreateRowData ... 63

Contents ... 63

See Also ... 63

DataItem ... 64

Contents ... 64

See Also ... 64

DelimitedTextImportOptions ... 65

Contents ... 65

See Also ... 65

DestinationOptions ... 66

Contents ... 66

See Also ... 66

FailedBatchItem ... 67

Contents ... 67

See Also ... 67

Filter ... 68

Contents ... 68

See Also ... 68

ImportDataSource ... 69

Contents ... 69

See Also ... 69

ImportDataSourceConfig ... 70

Contents ... 70

See Also ... 70

ImportJobSubmitter ... 71

Contents ... 71

See Also ... 71

ImportOptions ... 72

Contents ... 72

See Also ... 72

ResultRow ... 73

Contents ... 73

See Also ... 73

ResultSet ... 74

Contents ... 74

See Also ... 74

(6)

SourceDataColumnProperties ... 75

Contents ... 75

See Also ... 75

Table ... 76

Contents ... 76

See Also ... 76

TableColumn ... 77

Contents ... 77

See Also ... 77

TableDataImportJobMetadata ... 78

Contents ... 78

See Also ... 78

TableRow ... 79

Contents ... 79

See Also ... 79

UpdateRowData ... 80

Contents ... 80

See Also ... 80

UpsertRowData ... 81

Contents ... 81

See Also ... 81

UpsertRowsResult ... 83

Contents ... 83

See Also ... 83

VariableValue ... 84

Contents ... 84

See Also ... 84

Common Parameters ... 85

Common Errors ... 87

(7)

Welcome

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

This document was last published on March 6, 2022.

(8)

Actions

The following actions are supported:

• BatchCreateTableRows (p. 3)

• BatchDeleteTableRows (p. 7)

• BatchUpdateTableRows (p. 11)

• BatchUpsertTableRows (p. 15)

• DescribeTableDataImportJob (p. 19)

• GetScreenData (p. 23)

• InvokeScreenAutomation (p. 27)

• ListTableColumns (p. 31)

• ListTableRows (p. 34)

• ListTables (p. 38)

• ListTagsForResource (p. 41)

• QueryTableRows (p. 44)

• StartTableDataImportJob (p. 48)

• TagResource (p. 52)

• UntagResource (p. 55)

(9)

BatchCreateTableRows

BatchCreateTableRows

The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a

workbook. The API allows you to specify the values to set in some or all of the columns in the new rows.

If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.

Request Syntax

POST /workbooks/workbookId/tables/tableId/rows/batchcreate HTTP/1.1 Content-type: application/json

{ "clientRequestToken": "string", "rowsToCreate": [

{

"batchItemId": "string", "cellsToCreate": { "string" : { "fact": "string", "facts": [ "string" ] }

} } ]}

URI Request Parameters

The request uses the following URI parameters.

tableId (p. 3)

The ID of the table where the new rows are being added.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 3)

The ID of the workbook where the new rows are being added.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

(10)

Request Body

Request Body

The request accepts the following data in JSON format.

clientRequestToken (p. 3)

The request token for performing the batch create operation. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the operation again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No rowsToCreate (p. 3)

The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.

Type: Array of CreateRowData (p. 63) objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"createdRows": { "string" : "string"

},

"failedBatchItems": [ {

"errorMessage": "string", "id": "string"

} ],

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

(11)

Errors

The following data is returned in JSON format by the service.

createdRows (p. 4)

The map of batch item id to the row id that was created for that item.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^(?!\s*$).+

Value Length Constraints: Fixed length of 77.

Value Pattern: row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}- [0-9a-fA-F]{12}\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]

{4}-[0-9a-fA-F]{12}

failedBatchItems (p. 4)

The list of batch items in the request that could not be added to the table. Each element in this list contains one item from the request that could not be added to the table along with the reason why that item could not be added.

Type: Array of FailedBatchItem (p. 67) objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

workbookCursor (p. 4)

The updated workbook cursor after adding the new rows at the end of the table.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404

(12)

See Also

ServiceQuotaExceededException

The request caused service quota to be breached.

HTTP Status Code: 402 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(13)

BatchDeleteTableRows

BatchDeleteTableRows

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table.

Request Syntax

POST /workbooks/workbookId/tables/tableId/rows/batchdelete HTTP/1.1 Content-type: application/json

{ "clientRequestToken": "string", "rowIds": [ "string" ]

}

URI Request Parameters

The request uses the following URI parameters.

tableId (p. 7)

The ID of the table where the rows are being deleted.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 7)

The ID of the workbook where the rows are being deleted.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken (p. 7)

The request token for performing the delete action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

(14)

Response Syntax

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No rowIds (p. 7)

The list of row ids to delete from the table. You need to specify at least one row id in this list.

Note that if one of the row ids provided in the request does not exist in the table, then the request fails and no rows are deleted from the table.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Fixed length of 77.

Pattern: row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}- [0-9a-fA-F]{12}\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]

{4}-[0-9a-fA-F]{12}

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "failedBatchItems": [ {

"errorMessage": "string", "id": "string"

} ],

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failedBatchItems (p. 8)

The list of row ids in the request that could not be deleted from the table. Each element in this list contains one row id from the request that could not be deleted along with the reason why that item could not be deleted.

Type: Array of FailedBatchItem (p. 67) objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

(15)

Errors

workbookCursor (p. 8)

The updated workbook cursor after deleting the rows from the table.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

(16)

See Also

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(17)

BatchUpdateTableRows

BatchUpdateTableRows

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row.

To clear out the data in a specific cell, you need to set the value as an empty string ("").

Request Syntax

POST /workbooks/workbookId/tables/tableId/rows/batchupdate HTTP/1.1 Content-type: application/json

{

"clientRequestToken": "string", "rowsToUpdate": [

{

"cellsToUpdate": { "string" : { "fact": "string", "facts": [ "string" ] }

},

"rowId": "string"

} ]}

URI Request Parameters

The request uses the following URI parameters.

tableId (p. 11)

The ID of the table where the rows are being updated.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 11)

The ID of the workbook where the rows are being updated.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

(18)

Request Body

Request Body

The request accepts the following data in JSON format.

clientRequestToken (p. 11)

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No rowsToUpdate (p. 11)

The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

Type: Array of UpdateRowData (p. 80) objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "failedBatchItems": [ {

"errorMessage": "string", "id": "string"

} ],

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

(19)

Errors

failedBatchItems (p. 12)

The list of batch items in the request that could not be updated in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated.

Type: Array of FailedBatchItem (p. 67) objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

workbookCursor (p. 12)

The updated workbook cursor after adding the new rows at the end of the table.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException

The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

(20)

See Also

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(21)

BatchUpsertTableRows

BatchUpsertTableRows

The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.

You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

Request Syntax

POST /workbooks/workbookId/tables/tableId/rows/batchupsert HTTP/1.1 Content-type: application/json

{ "clientRequestToken": "string", "rowsToUpsert": [

{

"batchItemId": "string", "cellsToUpdate": { "string" : { "fact": "string", "facts": [ "string" ] }

},

"filter": {

"contextRowId": "string", "formula": "string"

} } ]}

URI Request Parameters

The request uses the following URI parameters.

tableId (p. 15)

The ID of the table where the rows are being upserted.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 15)

The ID of the workbook where the rows are being upserted.

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

(22)

Request Body

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken (p. 15)

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No rowsToUpsert (p. 15)

The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.

Type: Array of UpsertRowData (p. 81) objects Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "failedBatchItems": [ {

"errorMessage": "string", "id": "string"

} ],

"rows": { "string" : {

(23)

Response Elements

"rowIds": [ "string" ], "upsertAction": "string"

} },

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failedBatchItems (p. 16)

The list of batch items in the request that could not be updated or appended in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated or appended.

Type: Array of FailedBatchItem (p. 67) objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

rows (p. 16)

A map with the batch item id as the key and the result of the upsert operation as the value. The result of the upsert operation specifies whether existing rows were updated or a new row was appended, along with the list of row ids that were affected.

Type: String to UpsertRowsResult (p. 83) object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^(?!\s*$).+

workbookCursor (p. 16)

The updated workbook cursor after updating or appending rows in the table.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

(24)

See Also

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceQuotaExceededException

The request caused service quota to be breached.

HTTP Status Code: 402 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(25)

DescribeTableDataImportJob

DescribeTableDataImportJob

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Request Syntax

GET /workbooks/workbookId/tables/tableId/import/jobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobId (p. 19)

The ID of the job that was returned by the StartTableDataImportJob request.

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[^\n\r\x00\x08\x0B\x0C\x0E\x1F]*$

Required: Yes tableId (p. 19)

The ID of the table into which data was imported.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 19)

The ID of the workbook into which data was imported.

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

(26)

Response Elements

Content-type: application/json { "errorCode": "string", "jobMetadata": { "dataSource": {

"dataSourceConfig": { "dataSourceUrl": "string"

} },

"importOptions": {

"delimitedTextOptions": {

"dataCharacterEncoding": "string", "delimiter": "string",

"hasHeaderRow": boolean, "ignoreEmptyRows": boolean },

"destinationOptions": { "columnMap": { "string" : {

"columnIndex": number }

} } },

"submitter": { "email": "string", "userArn": "string"

},

"submitTime": number },

"jobStatus": "string", "message": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

errorCode (p. 19)

If job status is failed, error code to understand reason for the failure.

Type: String

Valid Values: ACCESS_DENIED | INVALID_URL_ERROR | INVALID_IMPORT_OPTIONS_ERROR

| INVALID_TABLE_ID_ERROR | INVALID_TABLE_COLUMN_ID_ERROR |

TABLE_NOT_FOUND_ERROR | FILE_EMPTY_ERROR | INVALID_FILE_TYPE_ERROR | FILE_PARSING_ERROR | FILE_SIZE_LIMIT_ERROR | FILE_NOT_FOUND_ERROR | UNKNOWN_ERROR | RESOURCE_NOT_FOUND_ERROR | SYSTEM_LIMIT_ERROR jobMetadata (p. 19)

The metadata about the job that was submitted for import.

Type: TableDataImportJobMetadata (p. 78) object jobStatus (p. 19)

The current status of the import job.

Type: String

(27)

Errors

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED message (p. 19)

A message providing more details about the current status of the import job.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

(28)

See Also

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(29)

GetScreenData

GetScreenData

The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

Request Syntax

POST /screendata HTTP/1.1 Content-type: application/json { "appId": "string",

"maxResults": number, "nextToken": "string", "screenId": "string", "variables": { "string" : {

"rawValue": "string"

} },

"workbookId": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

appId (p. 23)

The ID of the app that contains the screen.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes maxResults (p. 23)

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No nextToken (p. 23)

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

(30)

Response Syntax

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

Required: No screenId (p. 23)

The ID of the screen.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes variables (p. 23)

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Type: String to VariableValue (p. 84) object map

Key Length Constraints: Minimum length of 1. Maximum length of 255.

Key Pattern: ^(?!\s*$).+

Required: No workbookId (p. 23)

The ID of the workbook that contains the screen.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "nextToken": "string", "results": {

"string" : { "headers": [

(31)

Response Elements

{

"format": "string", "name": "string"

} ],

"rows": [ {

"dataItems": [ {

"formattedValue": "string", "overrideFormat": "string", "rawValue": "string"

} ],

"rowId": "string"

} ] } },

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken (p. 24)

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 query has been loaded.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

results (p. 24)

A map of all the rows on the screen keyed by block name.

Type: String to ResultSet (p. 74) object map workbookCursor (p. 24)

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

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

(32)

See Also

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(33)

InvokeScreenAutomation

InvokeScreenAutomation

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

Request Syntax

POST /workbooks/workbookId/apps/appId/screens/screenId/automations/automationId HTTP/1.1 Content-type: application/json

{

"clientRequestToken": "string", "rowId": "string",

"variables": { "string" : {

"rawValue": "string"

} }}

URI Request Parameters

The request uses the following URI parameters.

appId (p. 27)

The ID of the app that contains the screen automation.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes automationId (p. 27)

The ID of the automation action to be performed.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes screenId (p. 27)

The ID of the screen that contains the screen automation.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

(34)

Request Body

workbookId (p. 27)

The ID of the workbook that contains the screen automation.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken (p. 27)

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No rowId (p. 27)

The row ID for the automation if the automation is defined inside a block with source or list.

Type: String

Length Constraints: Fixed length of 77.

Pattern: row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}- [0-9a-fA-F]{12}\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]

{4}-[0-9a-fA-F]{12}

Required: No variables (p. 27)

Variables are specified as a map where the key is the name of the variable as defined on the screen.

The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.

Type: String to VariableValue (p. 84) object map

Key Length Constraints: Minimum length of 1. Maximum length of 255.

Key Pattern: ^(?!\s*$).+

Required: No

(35)

Response Syntax

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

workbookCursor (p. 29)

The updated workbook cursor after performing the automation action.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 AutomationExecutionException

The automation execution did not end successfully.

HTTP Status Code: 400

AutomationExecutionTimeoutException The automation execution timed out.

HTTP Status Code: 504 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404

(36)

See Also

ServiceQuotaExceededException

The request caused service quota to be breached.

HTTP Status Code: 402 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(37)

ListTableColumns

ListTableColumns

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

Request Syntax

GET /workbooks/workbookId/tables/tableId/columns?nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

nextToken (p. 31)

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.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

tableId (p. 31)

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 31)

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

(38)

Response Elements

Content-type: application/json { "nextToken": "string", "tableColumns": [ {

"format": "string", "tableColumnId": "string", "tableColumnName": "string"

} ],

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken (p. 31)

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

tableColumns (p. 31)

The list of columns in the table.

Type: Array of TableColumn (p. 77) objects workbookCursor (p. 31)

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.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500

(39)

See Also

RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(40)

ListTableRows

ListTableRows

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

Request Syntax

POST /workbooks/workbookId/tables/tableId/rows/list HTTP/1.1 Content-type: application/json

{

"maxResults": number, "nextToken": "string", "rowIds": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

tableId (p. 34)

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 34)

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults (p. 34)

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

(41)

Response Syntax

Required: No nextToken (p. 34)

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

Required: No rowIds (p. 34)

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Fixed length of 77.

Pattern: row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}- [0-9a-fA-F]{12}\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]

{4}-[0-9a-fA-F]{12}

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "columnIds": [ "string" ], "nextToken": "string",

"rowIdsNotFound": [ "string" ], "rows": [

{

"cells": [ {

"format": "string",

"formattedValue": "string", "formattedValues": [ "string" ], "formula": "string",

"rawValue": "string"

} ],

"rowId": "string"

} ],

"workbookCursor": number }

(42)

Response Elements

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

columnIds (p. 35)

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

nextToken (p. 35)

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

rowIdsNotFound (p. 35)

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Fixed length of 77.

Pattern: row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}- [0-9a-fA-F]{12}\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]

{4}-[0-9a-fA-F]{12}

rows (p. 35)

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

Type: Array of TableRow (p. 79) objects workbookCursor (p. 35)

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.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

(43)

See Also

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(44)

ListTables

ListTables

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

Request Syntax

GET /workbooks/workbookId/tables?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 38)

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

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 38)

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.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

workbookId (p. 38)

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"nextToken": "string", "tables": [

{

"tableId": "string", "tableName": "string"

(45)

Response Elements

} ],

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken (p. 38)

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

tables (p. 38)

The list of tables in the workbook.

Type: Array of Table (p. 76) objects workbookCursor (p. 38)

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.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

(46)

See Also

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(47)

ListTagsForResource

ListTagsForResource

The ListTagsForResource API allows you to return a resource's tags.

Request Syntax

GET /tags/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 41)

The resource's Amazon Resource Name (ARN).

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws:honeycode:.+:[0-9]{12}:.+:.+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "tags": {

"string" : "string"

} }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

tags (p. 41)

The resource's tags.

Type: String to string map

Map Entries: Maximum number of 100 items.

Key Length Constraints: Minimum length of 1. Maximum length of 100.

Key Pattern: ^[^\n\r\x00\x08\x0B\x0C\x0E\x1F]*$

(48)

Errors

Value Length Constraints: Minimum length of 1. Maximum length of 100.

Value Pattern: ^[^\n\r\x00\x08\x0B\x0C\x0E\x1F]*$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503 ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429 ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

(49)

See Also

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(50)

QueryTableRows

QueryTableRows

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

Request Syntax

POST /workbooks/workbookId/tables/tableId/rows/query HTTP/1.1 Content-type: application/json

{ "filterFormula": {

"contextRowId": "string", "formula": "string"

},

"maxResults": number, "nextToken": "string"

}

URI Request Parameters

The request uses the following URI parameters.

tableId (p. 44)

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes workbookId (p. 44)

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

filterFormula (p. 44)

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

Type: Filter (p. 68) object

(51)

Response Syntax

Required: Yes maxResults (p. 44)

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No nextToken (p. 44)

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "columnIds": [ "string" ], "nextToken": "string", "rows": [

{

"cells": [ {

"format": "string",

"formattedValue": "string", "formattedValues": [ "string" ], "formula": "string",

"rawValue": "string"

} ],

"rowId": "string"

} ],

"workbookCursor": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

columnIds (p. 45)

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

(52)

Errors

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

nextToken (p. 45)

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

rows (p. 45)

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

Type: Array of TableRow (p. 79) objects workbookCursor (p. 45)

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.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors (p. 87).

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403 InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500 RequestTimeoutException The request timed out.

HTTP Status Code: 504 ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404 ServiceUnavailableException

Remote service is unreachable.

參考文獻

相關文件

A network technician reports that he receives a “Request timed out” error message when he attempts to use the ping utility to connect to Server1 from his client computer.. The

 If I buy a call option from you, I am paying you a certain amount of money in return for the right to force you to sell me a share of the stock, if I want it, at the strike price,

* Before making a request from Interlibrary Loan service, please check the N TU Library online catalog to make sure the items are not NTU libraries' holdings.. * For

If necessary, you might like to guide students to read over the notes and discuss the roles and language required of a chairperson or secretary to prepare them for the activity9.

Following the supply by the school of a copy of personal data in compliance with a data access request, the requestor is entitled to ask for correction of the personal data

Otherwise, if a principle of conduct passes only the universal test but fails to pass this test, then it is an “imperfect duty.” For example, the principle “takes care of

request even if the header is absent), O (optional), T (the header should be included in the request if a stream-based transport is used), C (the presence of the header depends on

n The information contained in the Record-Route: header is used in the subsequent requests related to the same call. n The Route: header is used to record the path that the request