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

Docs: Idempotency - Syntax error in Reusing a DynamoDB table that uses a composite primary key example #1217

Closed
michaelbrewer opened this issue May 19, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@michaelbrewer
Copy link
Contributor

Expected Behaviour

Reusing a DynamoDB table that uses a composite primary key example should be valid python syntax

Current Behaviour

Current code example has syntax errors

Screen Shot 2022-05-19 at 10 04 10 AM

Code snippet

from aws_lambda_powertools.utilities.idempotency import DynamoDBPersistenceLayer, idempotent

persistence_layer = DynamoDBPersistenceLayer(
    table_name="IdempotencyTable",
    sort_key_attr='sort_key')


@idempotent(persistence_store=persistence_layer)
def handler(event, context):
    return {"message": "success": "id": event['body']['id]}

Possible Solution

Fix code example like in PR #1119 , example deployed at https://gyft.github.io/aws-lambda-powertools-python/latest/utilities/idempotency/#using-a-dynamodb-table-with-a-composite-primary-key

from aws_lambda_powertools.utilities.idempotency import DynamoDBPersistenceLayer, idempotent

persistence_layer = DynamoDBPersistenceLayer(
    table_name="IdempotencyTable",
    sort_key_attr="sort_key",
)


@idempotent(persistence_store=persistence_layer)
def handler(event, context):
    return {"message": "success", "id": event["body"]["id"]}

Steps to Reproduce

  1. Go to https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/idempotency/#using-a-dynamodb-table-with-a-composite-primary-key
  2. Copy example Reusing a DynamoDB table that uses a composite primary key
  3. Try to compile

AWS Lambda Powertools for Python version

latest

AWS Lambda function runtime

3.9

Packaging format used

PyPi

Debugging logs

N/A
@michaelbrewer michaelbrewer added bug Something isn't working triage Pending triage from maintainers labels May 19, 2022
@sthulb sthulb changed the title Bug: Idempotency - Syntax error in Reusing a DynamoDB table that uses a composite primary key example docs: Idempotency - Syntax error in Reusing a DynamoDB table that uses a composite primary key example May 19, 2022
@heitorlessa heitorlessa added documentation Improvements or additions to documentation and removed bug Something isn't working labels May 20, 2022
@michaelbrewer michaelbrewer changed the title docs: Idempotency - Syntax error in Reusing a DynamoDB table that uses a composite primary key example Docs: Idempotency - Syntax error in Reusing a DynamoDB table that uses a composite primary key example May 20, 2022
@sthulb sthulb closed this as completed Jun 14, 2022
@github-actions
Copy link
Contributor

Comments on closed issues are hard for our team to see.

@heitorlessa heitorlessa removed the triage Pending triage from maintainers label Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants