Fix map shorthand docs issue, struct in a map should be wrapped in cu…

[wangshu3000]

Issue #: #3637

Description of changes:

This PR is to fix a shorthand doc issue. The struct type in the map should be wrapped in curly braces {}.

Doc url: https://docs.aws.amazon.com/cli/latest/reference/sqs/send-message.html

Before the change:
KeyName1=DataType=string,StringValue=string,BinaryValue=blob

After the change:
KeyName1={DataType=string,StringValue=string,BinaryValue=blob}

[wangshu3000]

Can anybody please have a review? Is this repo still open to external contribution? Thanks.

[brianwarner]

Hi @kdaily and @dlm6693, would it be possible to have a look at this?

[wangshu3000]

Hi @tim-finnigan @kyleknap @kdaily

Would you please have a review on this PR? This it to fix the shorthand syntax issue in the cli doc. Both v1 and v2 all have this issue.

Thanks.

[Me042589]

Yes. I will do the math and get back to you

…

On Tue, May 28, 2024, 02:21 Shu.Wang ***@***.***> wrote: Hi @tim-finnigan <https://github.com/tim-finnigan> @kyleknap <https://github.com/kyleknap> @kdaily <https://github.com/kdaily> Would you please have a review on this PR? This it to fix the shorthand syntax issue in the cli doc. Both v1 and v2 all have this issue. Thanks. — Reply to this email directly, view it on GitHub <#7286 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A4D26XPRW6HX3EDKTDQTZB3ZEQWATAVCNFSM6AAAAAAQRTKZHOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZUGUYTIMBSG4> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[tim-finnigan]

Thanks for creating this PR and for your patience here. Linking related issues/documentation:

• SQS Message Attributes Shorthand error #3637 - sqs send-message
• SNS publiish documentation incorrect #5129 - sns publish
• iot update-event-configurations shorthand syntax mismatch between docs and actual functionality #7433 - iot update-event-configurations

So taking sqs send-message for example, the Shorthand Syntax in the documentation currently looks like:

And with your changes:

And that looks like the right format to use, for example this works for me:

aws sqs send-message --queue-url https://sqs.us-west-2.amazonaws.com/account-id/test --message-body TestBody --message-attributes "TenantID={StringValue=TestTenant,DataType=String},TenantName={StringValue=Bob,DataType=String}"

---

I brought this up for discussion with the team, and there were a couple more things that we wanted to look into prior to submitting a fix. For example, we want to test that the text still renders correctly when running aws sqs send-message help in different shells for example, which it looks like it does at least in macOS Terminal:

So from what I can tell these changes look good, but we may just need to verify in a couple more places prior to approving the PR.

[aemous]

Thank you for your submission. This PR has been superseded by #9982.

The issue is now already fixed as of versions 1.44.25 and 2.33.7. Closing PR.