DynamoDB Delete Table Item

Snap type:

Write

Description:

This Snap deletes an item or a bunch of items (based on batch size) from an existing table in AWS DynamoDB.

Expected upstream Snaps: Any Snap that provides a document output view, such as Structure or a JSON Generator Snap.
Expected downstream Snaps: Any Snap that has a document input view, such as Filter or Data or JSON Formatter.
Expected input: The table's key schema is suggested on input view. The values for the record keys are passed from the input view.
Expected output: This Snap returns an HTTP response code 200 on success.

Note: The delete operation performed by this Snap is Idempotent, that means even when the given input records do not exist, the Snap still gives an HTTP 200 response.

Prerequisites:

[None]

Support and limitations:

Ultra pipelines: May work in Ultra Pipelines.
Spark mode(Deprecated): Not supported in Spark - Deprecated mode.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint.

See DynamoDB Account for information on setting up this type of account.

Views:

Input	This Snap has exactly one document input view.
Output	This Snap has exactly one document output view.
Error	This Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Table name

Required. The name of the table to delete the data from. This property is suggestible, that shows the list of the tables in the database.
Example: Thread
Default value: [None]

Delete condition

Specifies a condition to be used on non-key attributes for performing the delete operation.

Applicable only when batch size is 1.

Default value: [None]

Batch size

Specifies the number of records to be deleted in a single request.

Default value:1

Output deleted records

Specifies whether or not to display the original records in the output view.
Default value: Not selected

Expression attribute values

This property is used to specify the placeholders to be used in delete condition property above. Refer here for more information.

Example:

Attribute	Type	Value
:val1	S	Amazon DynamoDB

Attribute name must always begin with a colon(:val1)
Type will be S for string, N for number and so on
The Value is the actual literal to be used in the delete condition

Scenario:

Suppose, a table T1 has two columns A1 and A2 where A1 is a key- attribute and A2 is a non-key attribute. A record having value for A2 as 'Snap' needs to be deleted. We cannot enter A2=Snap in the delete condition directly , instead assign a placeholder for the value and hence, we define an Attribute :v1 of Type S, and Value as Snap. We will then give A2=:v1 in the delete condition.

Attribute	Type	Value
:v1	S	Snap

Execute during preview

This property enables you to execute the Snap during the Save operation so that the output view can produce the preview data.

Default value: Not selected

Example

In this pipeline, the DynamoDB Delete Item Snap, deletes a record from the table DynamoDB_Delete1 using a delete condition by defining a placeholder.

In the upstream Mapper Snap, supply the key (737314009510) of an item to be deleted and define its placeholder value ($values1) for the attribute to be used in the delete condition.

In the DynamoDb Delete Table Item Snap, we want to delete a record from the table DynamoDB_Delete1, when the delete condition is Product = :val1, where the attribute :val1 = $Values1.

Successful execution of the pipeline displays the HTTP status code 200 in the output view:

Snap History

4.8.0

Introduced the Snap in this release.