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

Description

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.

Synopsis

Creating a Request

data BatchDeleteTableRows Source #

See: newBatchDeleteTableRows smart constructor.

Constructors

BatchDeleteTableRows' 

Fields

  • clientRequestToken :: Maybe Text

    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.

  • workbookId :: Text

    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 :: Text

    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 :: NonEmpty Text

    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.

Instances

Instances details
Eq BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Read BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Show BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Generic BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Associated Types

type Rep BatchDeleteTableRows :: Type -> Type #

NFData BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Methods

rnf :: BatchDeleteTableRows -> () #

Hashable BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

ToJSON BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

AWSRequest BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Associated Types

type AWSResponse BatchDeleteTableRows #

ToHeaders BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

ToPath BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

ToQuery BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

type Rep BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

type Rep BatchDeleteTableRows = D1 ('MetaData "BatchDeleteTableRows" "Amazonka.HoneyCode.BatchDeleteTableRows" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "BatchDeleteTableRows'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workbookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "rowIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))
type AWSResponse BatchDeleteTableRows Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

newBatchDeleteTableRows Source #

Create a value of BatchDeleteTableRows 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:clientRequestToken:BatchDeleteTableRows', batchDeleteTableRows_clientRequestToken - 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.

$sel:workbookId:BatchDeleteTableRows', batchDeleteTableRows_workbookId - 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.

$sel:tableId:BatchDeleteTableRows', batchDeleteTableRows_tableId - 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.

$sel:rowIds:BatchDeleteTableRows', batchDeleteTableRows_rowIds - 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.

Request Lenses

batchDeleteTableRows_clientRequestToken :: Lens' BatchDeleteTableRows (Maybe Text) Source #

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.

batchDeleteTableRows_workbookId :: Lens' BatchDeleteTableRows Text Source #

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.

batchDeleteTableRows_tableId :: Lens' BatchDeleteTableRows Text Source #

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.

batchDeleteTableRows_rowIds :: Lens' BatchDeleteTableRows (NonEmpty Text) Source #

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.

Destructuring the Response

data BatchDeleteTableRowsResponse Source #

See: newBatchDeleteTableRowsResponse smart constructor.

Constructors

BatchDeleteTableRowsResponse' 

Fields

  • failedBatchItems :: Maybe [FailedBatchItem]

    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.

  • httpStatus :: Int

    The response's http status code.

  • workbookCursor :: Integer

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

Instances

Instances details
Eq BatchDeleteTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Read BatchDeleteTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Show BatchDeleteTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Generic BatchDeleteTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

Associated Types

type Rep BatchDeleteTableRowsResponse :: Type -> Type #

NFData BatchDeleteTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

type Rep BatchDeleteTableRowsResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.BatchDeleteTableRows

type Rep BatchDeleteTableRowsResponse = D1 ('MetaData "BatchDeleteTableRowsResponse" "Amazonka.HoneyCode.BatchDeleteTableRows" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "BatchDeleteTableRowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedBatchItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FailedBatchItem])) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workbookCursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))

newBatchDeleteTableRowsResponse Source #

Create a value of BatchDeleteTableRowsResponse 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:failedBatchItems:BatchDeleteTableRowsResponse', batchDeleteTableRowsResponse_failedBatchItems - 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.

$sel:httpStatus:BatchDeleteTableRowsResponse', batchDeleteTableRowsResponse_httpStatus - The response's http status code.

$sel:workbookCursor:BatchDeleteTableRowsResponse', batchDeleteTableRowsResponse_workbookCursor - The updated workbook cursor after deleting the rows from the table.

Response Lenses

batchDeleteTableRowsResponse_failedBatchItems :: Lens' BatchDeleteTableRowsResponse (Maybe [FailedBatchItem]) Source #

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.

batchDeleteTableRowsResponse_workbookCursor :: Lens' BatchDeleteTableRowsResponse Integer Source #

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