Where is aws servicecatalog list-products?

[john-aws]

I'm raising this issue to help future readers work out how to get a list of Service Catalog products from the awscli.

There are closely-related commands:

• aws servicecatalog list-portfolios
• aws servicecatalog list-portfolios-for-product

But there is no:

• aws servicecatalog list-products

Instead, it looks like you use:

• aws servicecatalog search-products-as-admin

[kdaily]

Hi @john-aws, this looks like a request for better documentation on how to perform the task of getting a list of service catalog products. The main developer documentation does not describe this for any scenario, let alone the CLI or SDKs.

Would you say that the user experience suffers because of the name of this command? Or are more examples and high level documentation appropriate?

I will open an issue for the Service Catalog team as the documentation in the CLI (except for the examples) comes from the API.

[john-aws]

Hi, I'm really just trying to leave some breadcrumbs for the average awscli user who is familiar with the naming conventions used in almost every other service to list resources -- typically aws <service> list-<resource-type> and, less frequently, aws <service> describe-<resource-type>.

I have no issue with the name of the awscli command search-products-as-admin -- as with all API-passthrough commands, it's derived from the underlying API SearchProductsAsAdmin, and that consistency is a good thing.

It's just difficult to work out how to list Service Catalog products when you're so familiar with other list-xyz commands.

[kdaily]

Thanks @john-aws. I imagine that users of other SDKs who are familiar with list-<resource-type> might also struggle with this.

Sounds like the appropriate solution is an example use and overview at the "What is AWS Service Catalog?" section of the Developer Guide (https://docs.aws.amazon.com/servicecatalog/latest/dg/what-is-service-catalog.html). It looks like the example workflow there has more detail on what actions end users would use and not what administrators would use.

[kdaily]

This hasn't been resolved, but since it is related to the API documentation, I'm going to move it to the central aws-sdk repository for tracking.

[shdobxr]

Also FWIW, I also naturally performed list- and didn't find what I wanted. aws servicecatalog search-provisioned-products search doesn't make sense as it actually dumps a list.

[tim-finnigan]

It is confusing that the API pattern is search-* rather than list-* or describe-* as most other services use. But since it was released this way the API likely won't change in order to maintain backwards compatibility. And in the Developer Guide there is a now an example workflow that highlights using the SearchProducts API. So since that was completed I will go ahead and close this issue. If there's anything further you'd like to discuss related to this please let us know here or consider reaching out to AWS Support. Thanks!

[github-actions[bot]]

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.

[fitz-res]

This is a very confusing experience. Is there no way to list products owned by my account or products associated with a portfolio?