boto / boto3

AWS SDK for Python
https://aws.amazon.com/sdk-for-python/
Apache License 2.0
9.03k stars 1.87k forks source link

DynamoDB ExpressionAttributeNames documentation has no reference manual #4295

Open andreas-lundgren-qlucore opened 2 weeks ago

andreas-lundgren-qlucore commented 2 weeks ago

Describe the issue

Reading about ExpressionAttributeNames for example DynamoDB::update_item does not provide you with any information about what actually goes into this parameter. I can see that it's a dict, but there is no description of what's actually in the keys and what is in the values. If you don't know who to create this parameter, you will still not know after reading the description or the referenced Amazon DynamoDB Developer Guide

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/update_item.html

adev-code commented 1 week ago

Hello @andreas-lundgren-qlucore, thanks for reaching out. For the "ExpressionAttributeNames" in "update_item", the left string would be the alias for the right string (the documentation mentions a couple use cases for this). Beyond the syntax and intended type (string), how do you think this documentation could be improved? Thanks!

github-actions[bot] commented 8 hours ago

Greetings! It looks like this issue hasn’t been active in longer than five days. We encourage you to check if this is still an issue in the latest release. In the absence of more information, we will be closing this issue soon. If you find that this is still a problem, please feel free to provide a comment or upvote with a reaction on the initial post to prevent automatic closure. If the issue is already closed, please feel free to open a new one.