GetItem (reading single item) in DynamoDB

Introduction

GetItem lets you quickly find one specific item in a DynamoDB table using its unique key.

When you want to look up a user's profile by their user ID.

When you need to get details of a single order using the order number.

When you want to check the status of a specific product by its product ID.

When you want to retrieve a single record without scanning the whole table.

Syntax

DynamoDB

GetItem {
  TableName: "TableName",
  Key: {
    "PrimaryKeyName": { "S": "PrimaryKeyValue" }
  }
}

The Key must include the primary key attributes exactly as defined in your table.

Use S for string type, N for number type, and B for binary type values.

Examples

Get the user with ID 'user123' from the 'Users' table.

DynamoDB

GetItem {
  TableName: "Users",
  Key: {
    "UserID": { "S": "user123" }
  }
}

Get the order with numeric ID 101 from the 'Orders' table.

DynamoDB

GetItem {
  TableName: "Orders",
  Key: {
    "OrderID": { "N": "101" }
  }
}

Sample Program

This query fetches the product with ID 'P1001' from the 'Products' table.

DynamoDB

GetItem {
  TableName: "Products",
  Key: {
    "ProductID": { "S": "P1001" }
  }
}

Important Notes

If the item does not exist, the response will not include an Item field.

GetItem is fast because it uses the primary key directly, no scanning needed.

Summary

GetItem fetches one item by its primary key from a DynamoDB table.

It is efficient and quick for retrieving single records.

Always provide the exact key attributes in the request.

Practice

1. What does the GetItem operation in DynamoDB do?

easy

A. Retrieves a single item by its primary key from a table

B. Deletes multiple items from a table

C. Updates all items in a table

D. Scans the entire table for matching items

Solution

1. Step 1: Understand the purpose of GetItem

   GetItem is designed to fetch exactly one item using its primary key, making it efficient for single record retrieval.

2. Step 2: Compare with other operations

   Other operations like Scan or Update affect multiple items or the whole table, unlike GetItem which targets one item.

3. Final Answer:

   Retrieves a single item by its primary key from a table -> Option A

4. Quick Check:

   GetItem = single item fetch [OK]

Hint: GetItem always fetches one item by key [OK]

Common Mistakes:

• Confusing GetItem with Scan or Query
• Thinking GetItem updates or deletes items
• Assuming GetItem returns multiple items

2. Which of the following is the correct syntax to call GetItem in AWS SDK for JavaScript v3?

easy

A. client.getItem({ TableName: 'Users', Key: { UserId: '123' } })

B. client.getItem({ Table: 'Users', Key: { UserId: '123' } })

C. client.get({ TableName: 'Users', Key: { UserId: '123' } })

D. client.getItem({ TableName: 'Users', Keys: { UserId: '123' } })

Solution

1. Step 1: Identify correct parameter names

   The correct parameter for the table is TableName and the key attribute is Key (singular), not Keys.

2. Step 2: Check method name and parameters

   The method is getItem, and the object must include TableName and Key with the primary key value.

3. Final Answer:

   client.getItem({ TableName: 'Users', Key: { UserId: '123' } }) -> Option A

4. Quick Check:

   Correct method and parameters = client.getItem({ TableName: 'Users', Key: { UserId: '123' } }) [OK]

Hint: Use TableName and Key (singular) in getItem call [OK]

Common Mistakes:

• Using 'Table' instead of 'TableName'
• Using 'Keys' instead of 'Key'
• Calling method 'get' instead of 'getItem'

3. Given the DynamoDB table 'Products' with primary key 'ProductId', what will the following GetItem call return if the item exists?

client.getItem({ TableName: 'Products', Key: { ProductId: 'P100' } })

medium

A. An error because the key attribute is missing

B. An empty object because GetItem returns no data

C. The item with ProductId 'P100' including all its attributes

D. All items in the 'Products' table

Solution

1. Step 1: Understand GetItem behavior

   GetItem returns the item matching the exact primary key if it exists, including all attributes stored.

2. Step 2: Analyze the given call

   The call specifies the correct table and key, so it will return the full item with ProductId 'P100'.

3. Final Answer:

   The item with ProductId 'P100' including all its attributes -> Option C

4. Quick Check:

   GetItem returns matching item data [OK]

Hint: GetItem returns full item if key matches [OK]

Common Mistakes:

• Expecting GetItem to return multiple items
• Thinking GetItem returns empty if item exists
• Confusing GetItem with Scan or Query

4. You wrote this code to get an item from DynamoDB but it throws an error:

client.getItem({ TableName: 'Orders', Key: { orderId: 'O123' } })

What is the most likely cause?

medium

A. The client object does not support getItem method

B. The TableName should be 'orders' in lowercase

C. GetItem requires a list of keys, not a single key

D. The key attribute name 'orderId' does not match the table's primary key name

Solution

1. Step 1: Check key attribute name case sensitivity

   DynamoDB keys are case sensitive and must exactly match the primary key attribute name defined in the table schema.

2. Step 2: Identify mismatch in key name

   If the table's primary key is 'OrderId' (capital O), using 'orderId' (lowercase o) causes an error because the key is incorrect.

3. Final Answer:

   The key attribute name 'orderId' does not match the table's primary key name -> Option D

4. Quick Check:

   Key names must match exactly [OK]

Hint: Match key attribute names exactly, including case [OK]

Common Mistakes:

• Ignoring case sensitivity in key names
• Assuming TableName is case insensitive
• Thinking GetItem needs multiple keys

5. You want to fetch a single item from a DynamoDB table 'Employees' where the primary key is a composite key: DepartmentId (partition key) and EmployeeId (sort key). Which GetItem call is correct?

hard

A. client.getItem({ TableName: 'Employees', Key: { EmployeeId: 'E123' } })

B. client.getItem({ TableName: 'Employees', Key: { DepartmentId: 'D01', EmployeeId: 'E123' } })

C. client.getItem({ TableName: 'Employees', Key: { DepartmentId: 'D01' } })

D. client.getItem({ TableName: 'Employees', Key: { 'D01', 'E123' } })

Solution

1. Step 1: Understand composite primary key requirements

   For tables with composite keys, both partition key and sort key must be provided in the Key object to uniquely identify the item.

2. Step 2: Analyze the Key parameter

   The correct call must include both DepartmentId (partition key) and EmployeeId (sort key) as named properties in the Key object. Providing only one key or incorrect syntax like non-named values will fail.

3. Final Answer:

   client.getItem({ TableName: 'Employees', Key: { DepartmentId: 'D01', EmployeeId: 'E123' } }) -> Option B

4. Quick Check:

   Composite key requires both keys in Key object [OK]

Hint: Provide all key attributes for composite keys in Key [OK]

Common Mistakes:

• Providing only one key attribute for composite key
• Using incorrect syntax for Key object
• Assuming GetItem works without full key