Honeycode / Client / batch_delete_table_rows

batch_delete_table_rows#

Honeycode.Client.batch_delete_table_rows(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_table_rows(
    workbookId='string',
    tableId='string',
    rowIds=[
        'string',
    ],
    clientRequestToken='string'
)
Parameters:

  • workbookId (string) –

    [REQUIRED]

    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.

  • tableId (string) –

    [REQUIRED]

    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.

  • rowIds (list) –

    [REQUIRED]

    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.

    • (string) –

  • clientRequestToken (string) –

    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.

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

Return type:

dict

Returns:

Response Syntax

{
    'workbookCursor': 123,
    'failedBatchItems': [
        {
            'id': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • workbookCursor (integer) –

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

    • failedBatchItems (list) –

      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.

      • (dict) –

        A single item in a batch that failed to perform the intended action because of an error preventing it from succeeding.

        • id (string) –

          The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.

        • errorMessage (string) –

          The error message that indicates why the batch item failed.

Exceptions

  • Honeycode.Client.exceptions.AccessDeniedException

  • Honeycode.Client.exceptions.InternalServerException

  • Honeycode.Client.exceptions.ResourceNotFoundException

  • Honeycode.Client.exceptions.ServiceUnavailableException

  • Honeycode.Client.exceptions.ValidationException

  • Honeycode.Client.exceptions.RequestTimeoutException

  • Honeycode.Client.exceptions.ThrottlingException