Skip to content

Docs: Parameter Store aliases documentation incorrect #6213

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

Closed
1 task done
speshak opened this issue Mar 4, 2025 · 5 comments
Closed
1 task done

Docs: Parameter Store aliases documentation incorrect #6213

speshak opened this issue Mar 4, 2025 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@speshak
Copy link
Contributor

speshak commented Mar 4, 2025

What were you searching in the docs?

I wanted to look up the layer ARN using a Terraform data resource. When following the example in the documentation I was getting parameter not found errors. I found that when SSM parameter store aliases were introduced in 3.4.0, the release notes state that the python version in the SSM path should include the .:

<python_version> with your desired Python version (e.g., "python3.8", "python3.9", etc.).

The current documentation about using the SSM parameters states

{python_version} is the Python version without the period (.), e.g., python313 for Python 3.13

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/python/latest/#aws-ssm-parameter-store

How can we improve?

I believe the documentation should be updated to reflect that the parameter name includes the period in the python version. When I switched my TF code to include it, the parameter was found as expected.

Got a suggestion in mind?

I believe the documentation should be updated to reflect that the parameter name includes the period in the python version.

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@speshak speshak added documentation Improvements or additions to documentation triage Pending triage from maintainers labels Mar 4, 2025
Copy link

boring-cyborg bot commented Mar 4, 2025

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@leandrodamascena
Copy link
Contributor

Hey @speshak! Thanks for opening this issue to improve our documentation. You're right, we need to update our documentation to reflect the correct parameter name and avoid customers wasting time with incorrect information.

Would you like to send a pull request to update this? I'd really appreciate your contribution here.

@leandrodamascena leandrodamascena removed the triage Pending triage from maintainers label Mar 4, 2025
@leandrodamascena leandrodamascena moved this from Triage to Pending customer in Powertools for AWS Lambda (Python) Mar 4, 2025
@speshak
Copy link
Contributor Author

speshak commented Mar 4, 2025

Yeah, I'd be happy to get something sent over.

@leandrodamascena
Copy link
Contributor

Yeah, I'd be happy to get something sent over.

Super nice! Please let me know if you need any help.

Copy link
Contributor

github-actions bot commented Mar 5, 2025

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments 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.

@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Mar 7, 2025
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
Status: Shipped
Development

No branches or pull requests

2 participants