Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DynamoDB Client delete_item has incorrect request syntax #4339

Open
tylerapplebaum opened this issue Nov 9, 2024 · 1 comment
Open

DynamoDB Client delete_item has incorrect request syntax #4339

tylerapplebaum opened this issue Nov 9, 2024 · 1 comment
Assignees
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation. dynamodb p3 This is a minor priority issue service-api This issue is caused by the service API, not the SDK implementation.

Comments

@tylerapplebaum
Copy link

Describe the issue

The Request Syntax shows these ReturnValues:

ReturnValues='NONE'|'ALL_OLD'|'UPDATED_OLD'|'ALL_NEW'|'UPDATED_NEW',

This is not true. If I attempt to return UPDATED_NEW, I receive this error:

[ERROR] ClientError: An error occurred (ValidationException) when calling the DeleteItem operation: ReturnValues can only be ALL_OLD or NONE

The correct return value options are: ALL_OLD or NONE.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/delete_item.html

@tylerapplebaum tylerapplebaum added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 9, 2024
@RyanFitzSimmonsAK RyanFitzSimmonsAK self-assigned this Nov 11, 2024
@RyanFitzSimmonsAK RyanFitzSimmonsAK added investigating This issue is being investigated and/or work is in progress to resolve the issue. dynamodb p3 This is a minor priority issue bug This issue is a confirmed bug. service-api This issue is caused by the service API, not the SDK implementation. and removed needs-triage This issue or PR still needs to be triaged. investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Nov 11, 2024
@RyanFitzSimmonsAK
Copy link
Contributor

RyanFitzSimmonsAK commented Nov 15, 2024

Hi @tylerapplebaum, thanks for reaching out. This behavior is documented.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

However, I understand why it'd be misleading for the request syntax to reflect all possible values. This happens because the ReturnValues enum is used in multiple places in the DynamoDB model file. I've reached out to the DynamoDB about possibly fixing this, but given how thoroughly this is documented, I suspect this is a purposeful design decision that they'd hesitate to change. I'll let you know when I hear back. Thanks!

Ticket # for internal use : P170246187

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation. dynamodb p3 This is a minor priority issue service-api This issue is caused by the service API, not the SDK implementation.
Projects
None yet
Development

No branches or pull requests

2 participants