Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.HoneyCode.BatchDeleteTableRows

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data BatchDeleteTableRows = BatchDeleteTableRows' {
- clientRequestToken :: Maybe Text
- workbookId :: Text
- tableId :: Text
- rowIds :: NonEmpty Text
}
newBatchDeleteTableRows :: Text -> Text -> NonEmpty Text -> BatchDeleteTableRows
batchDeleteTableRows_clientRequestToken :: Lens' BatchDeleteTableRows (Maybe Text)
batchDeleteTableRows_workbookId :: Lens' BatchDeleteTableRows Text
batchDeleteTableRows_tableId :: Lens' BatchDeleteTableRows Text
batchDeleteTableRows_rowIds :: Lens' BatchDeleteTableRows (NonEmpty Text)
data BatchDeleteTableRowsResponse = BatchDeleteTableRowsResponse' {
- failedBatchItems :: Maybe [FailedBatchItem]
- httpStatus :: Int
- workbookCursor :: Integer
}
newBatchDeleteTableRowsResponse :: Int -> Integer -> BatchDeleteTableRowsResponse
batchDeleteTableRowsResponse_failedBatchItems :: Lens' BatchDeleteTableRowsResponse (Maybe [FailedBatchItem])
batchDeleteTableRowsResponse_httpStatus :: Lens' BatchDeleteTableRowsResponse Int
batchDeleteTableRowsResponse_workbookCursor :: Lens' BatchDeleteTableRowsResponse Integer

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 Methods (==) :: BatchDeleteTableRows -> BatchDeleteTableRows -> Bool # (/=) :: BatchDeleteTableRows -> BatchDeleteTableRows -> Bool #
Read BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods readsPrec :: Int -> ReadS BatchDeleteTableRows # readList :: ReadS [BatchDeleteTableRows] # readPrec :: ReadPrec BatchDeleteTableRows # readListPrec :: ReadPrec [BatchDeleteTableRows] #
Show BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods showsPrec :: Int -> BatchDeleteTableRows -> ShowS # show :: BatchDeleteTableRows -> String # showList :: [BatchDeleteTableRows] -> ShowS #
Generic BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Associated Types type Rep BatchDeleteTableRows :: Type -> Type # Methods from :: BatchDeleteTableRows -> Rep BatchDeleteTableRows x # to :: Rep BatchDeleteTableRows x -> BatchDeleteTableRows #
NFData BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods rnf :: BatchDeleteTableRows -> () #
Hashable BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods hashWithSalt :: Int -> BatchDeleteTableRows -> Int # hash :: BatchDeleteTableRows -> Int #
ToJSON BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods toJSON :: BatchDeleteTableRows -> Value # toEncoding :: BatchDeleteTableRows -> Encoding # toJSONList :: [BatchDeleteTableRows] -> Value # toEncodingList :: [BatchDeleteTableRows] -> Encoding #
AWSRequest BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Associated Types type AWSResponse BatchDeleteTableRows # Methods request :: BatchDeleteTableRows -> Request BatchDeleteTableRows # response :: MonadResource m => Logger -> Service -> Proxy BatchDeleteTableRows -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchDeleteTableRows))) #
ToHeaders BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods toHeaders :: BatchDeleteTableRows -> [Header] #
ToPath BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods toPath :: BatchDeleteTableRows -> ByteString #
ToQuery BatchDeleteTableRows Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods toQuery :: BatchDeleteTableRows -> QueryString #
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 type AWSResponse BatchDeleteTableRows = BatchDeleteTableRowsResponse

newBatchDeleteTableRows Source #

Arguments

:: Text	`$sel:workbookId:BatchDeleteTableRows'`
-> Text	`$sel:tableId:BatchDeleteTableRows'`
-> NonEmpty Text	`$sel:rowIds:BatchDeleteTableRows'`
-> BatchDeleteTableRows

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 Methods (==) :: BatchDeleteTableRowsResponse -> BatchDeleteTableRowsResponse -> Bool # (/=) :: BatchDeleteTableRowsResponse -> BatchDeleteTableRowsResponse -> Bool #
Read BatchDeleteTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods readsPrec :: Int -> ReadS BatchDeleteTableRowsResponse # readList :: ReadS [BatchDeleteTableRowsResponse] # readPrec :: ReadPrec BatchDeleteTableRowsResponse # readListPrec :: ReadPrec [BatchDeleteTableRowsResponse] #
Show BatchDeleteTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods showsPrec :: Int -> BatchDeleteTableRowsResponse -> ShowS # show :: BatchDeleteTableRowsResponse -> String # showList :: [BatchDeleteTableRowsResponse] -> ShowS #
Generic BatchDeleteTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Associated Types type Rep BatchDeleteTableRowsResponse :: Type -> Type # Methods from :: BatchDeleteTableRowsResponse -> Rep BatchDeleteTableRowsResponse x # to :: Rep BatchDeleteTableRowsResponse x -> BatchDeleteTableRowsResponse #
NFData BatchDeleteTableRowsResponse Source #
Instance details Defined in Amazonka.HoneyCode.BatchDeleteTableRows Methods rnf :: BatchDeleteTableRowsResponse -> () #
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 #

Arguments

:: Int	`$sel:httpStatus:BatchDeleteTableRowsResponse'`
-> Integer	`$sel:workbookCursor:BatchDeleteTableRowsResponse'`
-> BatchDeleteTableRowsResponse

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_httpStatus :: Lens' BatchDeleteTableRowsResponse Int Source #

The response's http status code.

batchDeleteTableRowsResponse_workbookCursor :: Lens' BatchDeleteTableRowsResponse Integer Source #

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