Paginator for ECS DescribeCapacityProviders

[Nevon]

Describe the feature

DescribeCapacityProviders is a paginated operation but there is no paginator available for it.

Use Case

Having a paginator prevents bugs from incorrectly implementing pagination.

Proposed Solution

The ECS service team likely needs to add this to their model in order for a paginator to be generated.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

SDK version used

3.726.1

Environment details (OS name and version, etc.)

[zshzbh]

Hey @Nevon ,

Thanks for the feedback! However, DescribeCapacityProviders has nextToken, which could handle the pagination.

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

The usage in AWS JS SDK V3 is documented here -https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/DescribeCapacityProvidersCommand/

[Nevon]

I am of course aware that you can manually paginate this operation. What I am requesting is generating a function that does the pagination and returns an async generator. For example ListClustersPaginator.

The last time I requested this I was told that this was due to a problem in the API model that meant smithy wouldn't generate any paginator for the operation. I would expect that all paginated operations automatically also get pagination functions generated.

[zshzbh]

Thanks for the clarification, I have submitted a request to service team ref - V1834083556.

[aBurmeseDev]

The pagination functionality for AWS operations is defined in service models upstream using the paginated trait. Checking the service model, DescribeCapacityProviders does not have this trait.

aws-sdk-js-v3/codegen/sdk-codegen/aws-models/ecs.json

Line 5018 in 2e7d107

"com.amazonaws.ecs#DescribeCapacityProviders": {

To keep consistency across SDKs, this must be added to the model by service team.
Since there's no action item for SDK team and this repo is dedicated for SDK related issues, we're going to close it. I'll keep it posted when service team responds or feel free to reach out to service team directly via AWS Support.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.