QueueAttributeName type and description mismatch

[bfeltman]

Describe the issue

The type QueueAttributeName[] does not match the description for AttributeNames on ReceiveMessageCommand Input. Please fix.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ReceiveMessageCommand/

[aBurmeseDev]

Hi @bfeltman - thanks for reaching out.

Could you please clarify if you're referring to the type being List[] or the values described? If it's the values, please note that the ones described are valid but they're not the full list. Here's the complete list of Valid Values from the service API docs:

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

Sorry about the confusion on the doc but hope this helps,
John

[sosafe-anas-bakro]

@aBurmeseDev this is import, in some cases we need ApproximateReceiveCount but we can not include it in AttributeNames as QueueAttributeName does not have it, we had to stay with an older version where AttributeNames is a string or use All but we don't want all attributes we only need ApproximateReceiveCount.

This is not just a documentation issue, the library needs to updated or we can not use the latest version!

Notice here that the type does not include ApproximateReceiveCount which it should or use a string or a different type!
https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sqs/command/ReceiveMessageCommand/

Here is the code as well:

aws-sdk-js-v3/clients/client-sqs/src/models/models_0.ts

Line 1898 in a9e7da3

AttributeNames?: QueueAttributeName[];

[rawpixel-vincent]

But it works, receiving a message with
message.Attributes.ApproximateReceiveCount === '1'

the type should not be AttributeNames?: QueueAttributeName[]; but AttributeNames?: MessageSystemAttributeName[];

in @aws-sdk/client-sqs/dist-types/models/models_0.d.ts

thank you

[sosafe-anas-bakro]

@rawpixel-vincent Thanks, the CI pipeline will fail due to having the wrong type, I can add an ignore rule but it still looks ugly.
I believe it is a tiny fix and an important one.

[kristof-kasa]

When can we expect a release of this?

[kuhe]

We cannot accept a contribution for changes to service models. They are pushed from AWS services and will overwrite any changes made only in this repository.

If there is a type error it must be fixed by the SQS service team's initiative. @aBurmeseDev please merge with #5403 if this is the same issue.

[aBurmeseDev]

thanks @kuhe for pointing to the similar issue. It seems we already have communicated with service team to update their models and waiting for a fix from them. I will check in with the team for updates.

I'll mark this as duplicate and close in favor of tracking the issue in #5403

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.