Get DynamoDB table details

The getDynamoDBTableDetails extension retrieves a matching item from an Amazon DynamoDB table from inside a Virtuoso journey.

This is useful when your test needs to fetch database values from DynamoDB and reuse the returned item in later journey steps, validations, or API-driven test flows.

Parameters:

• region required, the AWS region string where the DynamoDB table is located, for example us-west-2;
• accessKey required, the AWS access key ID used to connect to DynamoDB. Store this as an environment variable where possible;
• secretKey required, the AWS secret access key used to connect to DynamoDB. Store this as an environment variable where possible;
• tablename required, the DynamoDB table name string to query;
• primarykey1 required, the DynamoDB primary key as a valid JSON string. This should include the partition key and, where required by the table schema, the sort key.

How to apply this to your journey

Use the extension in a journey by calling getDynamoDBTableDetails with the execute command. Pass each value to the matching extension input using as inputName.

To fetch an item from a DynamoDB table using a partition key and sort key:

execute "getDynamoDBTableDetails" using "us-west-2" as region, "$awsAccessKey" as accessKey, "$awsSecretKey" as secretKey, "TableName" as tablename, '{"partitionKey":"PrimaryKeyValue","sortKey":"SortKeyValue"}' as primarykey1 returning $response

To fetch an item using only a partition key:

execute "getDynamoDBTableDetails" using "us-west-2" as region, "$awsAccessKey" as accessKey, "$awsSecretKey" as secretKey, "TableName" as tablename, '{"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 "getDynamoDBTableDetails" using "$region" as region, "$accessKey" as accessKey, "$secretKey" as secretKey, "$tableName" as tablename, "$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 "getDynamoDBTableDetails" using "$region" as region, "$accessKey" as accessKey, "$secretKey" as secretKey, "$tableName" as tablename, "$primaryKey" as primarykey1 returning $response

Example output when a matching item is found:

{
  "partitionKey": "PrimaryKeyValue",
  "sortKey": "SortKeyValue",
  "status": "Active"
}

If no matching item exists, the extension returns null.

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 getDynamoDBItem(awsRegion, awsAccessKey, awsSecretKey, tableName, primaryKey) {
  // Configure the AWS SDK with your credentials and region
  AWS.config.update({
    region: awsRegion,
    credentials: new AWS.Credentials({
      accessKeyId: awsAccessKey,
      secretAccessKey: awsSecretKey
    })
  });

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

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

    // Fetch the item from DynamoDB
    const response = await dynamoDB.get(params).promise();
    console.log("Item fetched successfully!");

    return response.Item || null;
  } catch (error) {
    throw error;
  }
}

// Example usage:
const awsRegion = region;
const awsAccessKey = accessKey;
const awsSecretKey = secretKey;
const tableName = tablename;
const primaryKey = JSON.parse(primarykey1);
console.log(primaryKey);

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