DynamoDbMapper getItem not working by providing key as String

[chung-yan-leung]

Describe the bug

Using getItem(partitionKey: PK) where the partitionKey is a String in the data class which generates the schema produces the following error:

kotlin.NotImplementedError: An operation is not implemented: not yet implemented
	at aws.sdk.kotlin.hll.dynamodbmapper.model.internal.TableImplKt$tableImpl$1.getItem(TableImpl.kt:38) ~[dynamodb-mapper-jvm-1.4.58-beta.jar:na]

Trying to use getItem { key = "a-string-key" } following the example on the blog, it said the type of the key required is the class which generates the schemas, instead of String.

Regression Issue

• Select this option if this issue appears to be a regression.

Expected behavior

• Calling getItem() without any error.

• The type of the key in getItem builder block should be the type of DynamoDbPartitionKey defined in the class.

Current behavior

• Calling getItem() throws NotImplementedError

• key in getItem builder block only accepts the class which generate the schemas, instead of the type of DynamoDbPartitionKey defined in the class.

Steps to Reproduce

Using Java 23 and Kotlin 2.1.10

Data class to generate Schema

@DynamoDbItem
data class Planet(
    @DynamoDbPartitionKey
    val name: String,
    val id: Long
)

Use getItem(), calling the getPlanet() with a Spring boot controller gives the error

    suspend fun getPlanet(): Planet? {
        val planetTable = mapper.getTable("planet-table", PlanetSchema)
        return planetTable.getItem("Jupiter")
    }

Use getItem { }

    suspend fun getPlanet(): Planet? {
        val planetTable = mapper.getTable("planet-table", PlanetSchema)
        return planetTable.getItem { key = "Jupiter" }.item
    }

Possible Solution

No response

Context

No response

AWS SDK for Kotlin version

1.4.58

Platform (JVM/JS/Native)

JVM

Operating system and version

macOS

[ianbotsf]

Hi @chung-yan-leung, thanks for submitting this bug. I apologize but it appears the blog post is in error and getItem { key = "a-string-key" } is not a valid method call. The getItem method has two overloads:

• getItem(request: GetItemRequest<T>) which allows calling with a lambda block to specify a full request object. In this case, key would be an instance of T with the required key values specified.
• getItem(partitionKey: PK) (for single key schemas) or getItem(partitionKey: PK, sortKey: SK) (for composite key schemas) which allows calling with simply a raw value(s). In this case, partitionKey would be an instance of the PK type like "Jupiter". This overload currently throws NotImplementedError because it wasn't completed in time for Developer Preview.

We'll need to update that blog post to avoid future confusion. I think we can also implement support for the simplified getItem overloads to streamline calling code.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[ianbotsf]

The getItem(partitionKey: PK) feature has been released in SDK version v1.4.70. The blog post has been updated to correct the erroneous syntax:

// Get a Planet instance from an item with the key "Jupiter"
val jupiter = planetsTable.getItem("Jupiter").item