aws / aws-sdk-js-v3

Modularized AWS SDK for JavaScript.
Apache License 2.0
3.03k stars 568 forks source link

FileIds is limited to 10 items in the array per call #6255

Closed jusnye closed 3 weeks ago

jusnye commented 2 months ago

Describe the issue

It is not documented that the 'FileIds' property is limited to 10 items within the array. Exceeding this threshold generates the error below which is also not documented in the APIs 'Throws' section.

{ "error": "Caught error: There has been a validation error with the request" }

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/BatchGetAttachedFileMetadataCommand/

jusnye commented 2 months ago

The AssociatedResourceArn description for this and other APIs refers to 'The resource to which the attached file is (being) uploaded) to. ' This is misleading for this and the DeleteAttachedFileCommand and GetAttachedFileCommand, as these APIs are not uploading attachments but are retrieving information for prepping a download or deletion.

aBurmeseDev commented 1 month ago

Hi @jusnye - thanks for reaching out and sharing feedback on our docs.

I wanted to firstly mention that most of our SDK docs are generated upstream by service teams. In this case, here's the service team docs page for BatchGetAttachedFileMetada, and notice FileIds under Request Body, it has Maximum length of 256.

I've also reached out to service team to address your feedback on your behalf for AssociatedResourceArn description and will post when I hear back. (ref: P139821983)

jusnye commented 1 month ago

Hi John,

Thanks very much for the reply and feedback, I checked the service team docs and they do indeed state a maximum length of 256 for FileIds. This in my experience in not the case, 10 is the maximum therefore perhaps they could check this.

Also the error “ "error": "Caught error: There has been a validation error with the request" “ received on going over 10 is not documented as a possible return error in the Service teams documentation either.

Thanks again,

Kindest Regards Justin

From: John L. @.> Date: Monday, 8 July 2024 at 20:14 To: aws/aws-sdk-js-v3 @.> Cc: Nye, Justin esure_Reigate @.>, Mention @.> Subject: Re: [aws/aws-sdk-js-v3] FileIds is limited to 10 items in the array per call (Issue #6255) Hi @jusnye - thanks for reaching out and sharing feedback on our docs.I wanted to firstly mention that most of our SDK docs are generated upstream by service teams. In this case, here's the service team docs page for BatchGetAttachedFileMetada, and notice FileIds under Request Bo ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌

https://uk.report.cybergraph.mimecast.com/alert-details/?dep=TFxBEB6cSVJMyITcImL2fg%3D%3DVt9MZhdvKQs5XZSaxBJVBlsw9byDuBbvPO545eZc825X9bXQNfGK8p5BHI3ObWJWqxklTy8eMaDDkfXkXDtku%2Fp0eQUUt%2BJBLCMOF9XhJV3oGkEOKsj%2BEk7pkme21N0qCEYl7riAktb2UVsIz%2FlQmn7VrvVglGSuYgrYJR5jx1lnqcdlSk4dzTDSDmXvF4CPk548y9U%2BszvDugEwS4e0dA07DnkwfuXK1uKM0EmVZGZxa3xQsUSipDvH1ttL4RichFsIFQgyasQJnTQXsWgR2%2BLIP2tT99C5LVic70dHveKhObxqgoZB8RnuujWNYNVi8d6WDBM6wp5zuPEaeTiw477ndfho7Q9p6BbM9JFOYmwauEXL9WtObYeVv2nY6uY2KBjJn0Zy2cwXIND6f8bsA14BDyxbnlyA21eGP2ZgRE42Du7oPMF%2BZAndxewe4oqpmKa%2FA%2BFLNndUSBOEsnICuhWYqF4yZYzaIKKfcuvzKROxt11Z7yoQzSKX0%2FWkjPacvgGBHnV282iwZUmVG02zcIVYYVcGRZyxDcODcXbXK8AOuXKVNok2BmGiacBj9XlsfmMWi%2B1OgZHOghaO90KrE7sgA3ACdZSHtudlGz9Lvh3dPCio9oCsX0Nnlc2Sl1nJnqd4YFXoxVZNV0aRpagBteI1Z2keRzNFDzdk6beUQD7x6IkfqfKQ9gYtMflnyAg8I%2F9RQX3FjA3wsJDDkBOQt2m7o3NVrCvANYRIhsQbSag8PqYKPWxeO2HBztqXUc6%2B55PWj0iOLY5v3eokMZvxk1Cn9hyxNbWANckGNVq%2F2azSjw23nhGazr041WScbioNFMEUPNm7LFLsZlnqIGElmhxw8Tdo6ZZOVZQnUWhOn2RzV%2B3j8FXMWx2UrBM9ljiJ

Hi @jusnyehttps://github.com/jusnye - thanks for reaching out and sharing feedback on our docs.

I wanted to firstly mention that most of our SDK docs are generated upstream by service teams. In this case, here's the service team docs page for BatchGetAttachedFileMetadahttps://docs.aws.amazon.com/connect/latest/APIReference/API_BatchGetAttachedFileMetadata.html, and notice FileIds under Request Body, it has Maximum length of 256.

I've also reached out to service team to address your feedback on your behalf for AssociatedResourceArn description and will post when I hear back. (ref: P139821983)

— Reply to this email directly, view it on GitHubhttps://github.com/aws/aws-sdk-js-v3/issues/6255#issuecomment-2214985291, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A36JOQNEHWMSA4SF6RUEPY3ZLLQH3AVCNFSM6AAAAABKLTENQWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMJUHE4DKMRZGE. You are receiving this because you were mentioned.Message ID: @.***>

esure Services Limited is registered in England and Wales number 2135610 at The Observatory, Reigate, Surrey, RH2 0SG and is authorised and regulated by the Financial Conduct Authority, register number 312063. Please visit www.esure.com/disclaimer for important information concerning this message.

aBurmeseDev commented 1 month ago

Hi @jusnye - quick update with response from service team.

Service team confirmed that current max item is 10, Amazon Connect would bump the number and change the public doc accordingly in next release targeted late this year.

Sorry for the confusion and inconvenience. Best, John

github-actions[bot] commented 1 month ago

This issue has not received a response in 1 week. If you still think there is a problem, please leave a comment to avoid the issue from automatically closing.

github-actions[bot] commented 1 week ago

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.