Using begins_with attribute with lib-dynamodb

[jhughes982]

I would like to know if it is possible to use the GetCommand from lib-dynamodb while specifying a begins_with attribute. I am able to do this successfully with the V2 AWS SDK, but I cannot see from the docs that this is possible using V3 with lib-dynamodb.

Any help would be very much appreciated.

Code example using the V3 SDK:

import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
import { DynamoDBDocumentClient, GetCommand } from "@aws-sdk/lib-dynamodb"

...

const command = new GetCommand({
      TableName: TABLE_NAME,
      Key: {
        pk: userId,
        // I want to send the command specifying that `sk: begins_with 'user'`
      }
  })
  
try {
    const response = await docClient.send(command);
    console.log(response)
 } catch (error) {
    throw error
 }

And this is how I achieve it using the V2 SDK:

const params = {
  TableName: TABLE_NAME,
  KeyConditionExpression: '#pk = :pk and begins_with(#sk, :sk)',
  ExpressionAttributeNames: {
      '#pk': 'pk',
      '#sk': 'sk',
  },
  ExpressionAttributeValues: {
      ':pk': userId,
      ':sk': 'user',
  },
};

try {
  response = await dynamoClient.query(params).promise();
} catch (error) {
  console.log(error);
}

[jhughes982]

Closed due to my mistake mixing up GetCommand and QueryCommand. You can indeed filter with begins_with using the V3 SDK when you use QueryCommand but not with GetCommand. Solution below:

  const command = new QueryCommand({
    TableName: TABLE_NAME,
    KeyConditionExpression: '#pk = :pk and begins_with(#sk, :sk)',
    ExpressionAttributeNames: {
      '#pk': 'pk',
      '#sk': 'sk',
    },
    ExpressionAttributeValues: {
      ':pk': userId,
      ':sk': 'user',
    },
  });

[github-actions[bot]]

Hello! Reopening this discussion to make it searchable.