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

All references to boto3.client in bedrock documentation use incorrect keyword name of region #3882

Closed
redsting opened this issue Sep 28, 2023 · 5 comments
Assignees
Labels
documentation This is a problem with documentation.

Comments

@redsting
Copy link

Describe the issue

All references to boto3.client() in the user guide online giving sample python code users region instead of region_name

Generates a TypeError Session.client() got an unexpected keyword argument 'region'
bedrock = boto3.client(service_name='bedrock', region='us-east-1', endpoint_url='https://invoke-bedrock.us-east-1.amazonaws.com')

No errors
bedrock = boto3.client(service_name='bedrock', region_name='us-east-1', endpoint_url='https://invoke-bedrock.us-east-1.amazonaws.com')

Links

https://d2eo22ngex1n9g.cloudfront.net/Documentation/BedrockUserGuide.pdf

@redsting redsting added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Sep 28, 2023
@redsting redsting changed the title All references to boto3.client use incorrect parameter name of region All references to boto3.client in bedrock documentation use incorrect parameter name of region Sep 28, 2023
@redsting redsting changed the title All references to boto3.client in bedrock documentation use incorrect parameter name of region All references to boto3.client in bedrock documentation use incorrect keyword name of region Sep 28, 2023
@tim-finnigan tim-finnigan self-assigned this Sep 28, 2023
@tim-finnigan
Copy link
Contributor

Hi @redsting thanks for reporting this. I think the link you provided is outdated. Here is the Amazon Bedrock - User Guide I found from searching on Google: https://docs.aws.amazon.com/pdfs/bedrock/latest/userguide/bedrock-ug.pdf. It appears the region vs region_name issues with the boto3 examples are fixed there.

@tim-finnigan tim-finnigan added closing-soon This issue will automatically close in 4 days unless further comments are made. and removed needs-triage This issue or PR still needs to be triaged. labels Sep 28, 2023
@redsting
Copy link
Author

Thanks. That also "fixes" the bug that seemed to be with invoke. I'll see if I can find the reference to where the user guide came from.

@redsting
Copy link
Author

The bad user guide link is here on the first link on the page

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/bedrock-runtime/client/invoke_model.html#

@tim-finnigan
Copy link
Contributor

@redsting thanks for letting us know — the Boto3 docs are largely auto-generated by service APIs. So in this case the InvokeModel API documentation needs to be updated so that the change will be updated in various AWS SDKs. I reported this issue to the Bedrock team so it should be fixed soon.

@github-actions github-actions bot removed the closing-soon This issue will automatically close in 4 days unless further comments are made. label Sep 29, 2023
@github-actions
Copy link

⚠️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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

2 participants