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

SSM get_connection_status response doc doesn't match case #3662

Closed
mdavis-xyz opened this issue Apr 12, 2023 · 1 comment
Closed

SSM get_connection_status response doc doesn't match case #3662

mdavis-xyz opened this issue Apr 12, 2023 · 1 comment
Assignees
Labels
api-documentation bug This issue is a confirmed bug. documentation This is a problem with documentation. ssm

Comments

@mdavis-xyz
Copy link
Contributor

Describe the bug

The docs for SSM get_connection_status say the response can be 'Connected'|'NotConnected' (upper case first letter).

This is not the case. I'm getting a response with a lowercase.

Note that there's no waiters for this API. So I wrote my own while loop, waiting for status to be Connected. It was connected, so my while loop hangs forever.

Expected Behavior

Documented response and actual response match in a case sensitive way.

boto3.client('ssm').get_connection_status(Target='i-0da29bfd2959949cc')['Status']

gives:

'Connected'

Current Behavior

Actual response is lowercase. Docs say CamelCase.

Reproduction Steps

boto3.client('ssm').get_connection_status(Target='i-0da29bfd2959949cc')['Status']

gives:

'connected'

Possible Solution

Please ask the service team to update their documentation to reflect the correct case.

While you're at it, ask them to add a waiter for this call.

Additional Information/Context

No response

SDK version used

1.26.74

Environment details (OS name and version, etc.)

Mac

@mdavis-xyz mdavis-xyz added bug This issue is a confirmed bug. needs-triage This issue or PR still needs to be triaged. labels Apr 12, 2023
@aBurmeseDev aBurmeseDev self-assigned this Apr 12, 2023
@aBurmeseDev aBurmeseDev added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Apr 12, 2023
@aBurmeseDev
Copy link
Contributor

Hi @mdavis-xyz - thanks for reporting this behavior. I was able to reproduce it that status response came back notconnected where in the docs, it's written as NotConnected.

As you'd probably already know, these docs get generated upstream by Service API team which is why I'm going to create new issue in our shared repo (aws/aws-sdk) and reach out to corresponding team. Since I'm going to close this one, please check in for update here going forward.

Best,
John

@aBurmeseDev aBurmeseDev added documentation This is a problem with documentation. api-documentation ssm and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-documentation bug This issue is a confirmed bug. documentation This is a problem with documentation. ssm
Projects
None yet
Development

No branches or pull requests

2 participants