Delete item in DynamoDB

The Delete Item In Dynamo DB extension deletes an item from an Amazon DynamoDB table from inside a Virtuoso journey.

This is useful when your test needs to clean up test records, remove temporary database data, or reset DynamoDB-backed test state by using a known primary key.

Parameters:

• region required, string, the AWS region where the DynamoDB table is located, for example us-west-2;
• accessKey required, string, the AWS access key ID used to connect to DynamoDB. Store this as an environment variable where possible;
• secreteKey required, string, the AWS secret access key used to connect to DynamoDB. This input name follows the source code spelling. Store this as an environment variable where possible;
• tablename1 required, string, the name of the DynamoDB table where the item should be deleted;
• primaryKey1 required, JSON string, the DynamoDB primary key to delete. This should include the partition key and, where required by the table, the sort key.

How to apply this to your journey

Use the extension in a journey by calling Delete Item In Dynamo DB with the execute command. Pass each value to the matching extension input using as inputName.

To delete an item from a DynamoDB table:

execute "Delete Item In Dynamo DB" using "us-west-2" as region, "$awsAccessKey" as accessKey, "$awsSecretKey" as secreteKey, "TableName" as tablename1, '{"partitionKey":"PrimaryKeyValue","sortKey":"SortKeyValue"}' as primaryKey1 returning $response

To delete an item using only a partition key:

execute "Delete Item In Dynamo DB" using "us-west-2" as region, "$awsAccessKey" as accessKey, "$awsSecretKey" as secreteKey, "TableName" as tablename1, '{"id":"PrimaryKeyValue"}' as primaryKey1 returning $response

You can also use Virtuoso variables to make the same step reusable across different AWS regions, tables, credentials, or primary keys:

execute "Delete Item In Dynamo DB" using "$region" as region, "$accessKey" as accessKey, "$secretKey" as secreteKey, "$tableName" as tablename1, "$primaryKey" as primaryKey1 returning $response

Example setup using variables before calling the extension:

store value "us-west-2" in $region
store value "TableName" in $tableName
store value '{"partitionKey":"PrimaryKeyValue","sortKey":"SortKeyValue"}' in $primaryKey
execute "Delete Item In Dynamo DB" using "$region" as region, "$accessKey" as accessKey, "$secretKey" as secreteKey, "$tableName" as tablename1, "$primaryKey" as primaryKey1 returning $response

When the delete request is successful, the extension returns the HTTP status code from the DynamoDB response. For example:

200

This extension requires the following resource:

• https://cdnjs.cloudflare.com/ajax/libs/aws-sdk/2.1386.0/aws-sdk.min.js 

The extension should be configured as:

• Run asynchronously: No
• Scope: Global

Add the extension to your Virtuoso instance

Select the domain that matches your Virtuoso account.

async function deleteDynamoDBItem(region, accessKey, secretKey, tableName, primaryKey) {
  // Configure the AWS SDK with your credentials and region
  AWS.config.update({
    region: region,
    credentials: new AWS.Credentials({
      accessKeyId: accessKey,
      secretAccessKey: secretKey
    })
  });

  // Create a DynamoDB document client
  const dynamoDB = new AWS.DynamoDB.DocumentClient();

  try {
    // Construct the DeleteItem request parameters
    const params = {
      TableName: tableName,
      Key: primaryKey
    };

    // Delete the item from DynamoDB
    const response = await dynamoDB.delete(params).promise();
    const statusCode = response.$response.httpResponse.statusCode;

    console.log("Item deleted successfully");
    return statusCode;
  } catch (error) {
    throw error;
  }
}

// Example usage:
const awsRegion = region;
const awsAccessKey = accessKey;
const awsSecretKey = secreteKey;
const tableName = tablename1;
const primaryKey = JSON.parse(primaryKey1);
// update this to the primary key value for which you wish to delete the item in DynamoDB

return deleteDynamoDBItem(awsRegion, awsAccessKey, awsSecretKey, tableName, primaryKey);