Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

SQS.ReceiveMessage has the wrong list of valid values for AttributeName request parameter #56

Closed
luislew opened this issue Apr 4, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation service-api This issue pertains to the AWS API sqs

Comments

@luislew
Copy link

luislew commented Apr 4, 2021

Original issue: aws/aws-sdk-go-v2#1194
Comment redirecting to open an issue here: aws/aws-sdk-go-v2#1194 (comment)

Summary: The API documentation for SQS.ReceiveMessage has the wrong set of valid values for the AttributeName. This is propagated through to the various SDKs as well, so it appears to be misconfigured in the underlying API model.

Details: The detailed list of supported AttributeName values is correct:

AttributeName.N
A list of attributes that need to be returned along with each message. These attributes include:

All – Returns all values.

ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).

ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.

AWSTraceHeader – Returns the AWS X-Ray trace header string.

SenderId

For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.

For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).

MessageDeduplicationId – Returns the value provided by the producer that calls the SendMessage action.

MessageGroupId – Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

SequenceNumber – Returns the value provided by Amazon SQS.

Unfortunately, the "Valid Values" list is wrong - it points at the set of valid values for SQS.GetQueueAttributes's AttributeName request parameter:

Type: Array of strings

Valid Values: All | Policy | VisibilityTimeout | MaximumMessageSize | MessageRetentionPeriod | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | CreatedTimestamp | LastModifiedTimestamp | QueueArn | ApproximateNumberOfMessagesDelayed | DelaySeconds | ReceiveMessageWaitTimeSeconds | RedrivePolicy | FifoQueue | ContentBasedDeduplication | KmsMasterKeyId | KmsDataKeyReusePeriodSeconds | DeduplicationScope | FifoThroughputLimit

@ajredniwja ajredniwja added documentation Improvements or additions to documentation service-api This issue pertains to the AWS API labels May 3, 2021
@KaibaLopez
Copy link

KaibaLopez commented Jun 15, 2021

P48708340

@stobrien89 stobrien89 added service-docs Issue relates to missing information in service documentation and removed service-api This issue pertains to the AWS API labels Jul 21, 2021
@kdaily kdaily added the sqs label Jul 21, 2021
@stobrien89 stobrien89 removed the service-docs Issue relates to missing information in service documentation label Jul 26, 2021
@vudh1 vudh1 assigned vudh1 and unassigned KaibaLopez Mar 14, 2022
@vudh1 vudh1 assigned RanVaknin and unassigned vudh1 Sep 9, 2022
@stobrien89
Copy link
Member

Followed up on this again today. Will update once I've heard back.

@RanVaknin
Copy link

This is now fixed.

Copy link

This issue is now closed.

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 subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation service-api This issue pertains to the AWS API sqs
Projects
None yet
Development

No branches or pull requests

8 participants