Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
Parameters:
-
accept_language
(Optional[AcceptLanguage], default:
None
)
–
The language code.
-
jp - Japanese
-
zh - Chinese
-
product_id
(Id)
–
-
page_size
(Optional[PageSize], default:
None
)
–
The maximum number of items to return with this call.
-
page_token
(Optional[PageToken], default:
None
)
–
The page token for the next set of results. To retrieve the first set of results, use null.
Raises:
Source code in docs_src/capo_service_catalog/_services/async_service_catalog.py
| async def list_launch_paths(
self,
product_id: "capo_service_catalog.types.id.Id",
*,
config_overrides: Optional[AsyncServiceCatalogClientConfig] = None,
accept_language: Optional[
"capo_service_catalog.types.accept_language.AcceptLanguage"
] = None,
page_size: Optional["capo_service_catalog.types.page_size.PageSize"] = None,
page_token: Optional["capo_service_catalog.types.page_token.PageToken"] = None,
) -> "capo_service_catalog.types.list_launch_paths_output.ListLaunchPathsOutput":
"""<p> Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal. </p> <note> <p> When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html">Granting users access</a> in the <i>Service Catalog User Guide</i>. </p> </note>
Args:
accept_language: <p>The language code.</p> <ul> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>
product_id: <p>The product identifier.</p>
page_size: <p>The maximum number of items to return with this call.</p>
page_token: <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
Raises:
capo_service_catalog.errors.invalid_parameters_exception.InvalidParametersException: <p>One or more parameters provided to the operation are not valid.</p>
capo_service_catalog.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
capo_service_catalog.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_service_catalog.types.list_launch_paths_input.ListLaunchPathsInput]",
) -> AsyncOperationResponse[
"capo_service_catalog.types.list_launch_paths_output.ListLaunchPathsOutput"
]:
import capo_service_catalog._operations.aws242_service_catalog_service.list_launch_paths
(
output,
http_response,
) = await capo_service_catalog._operations.aws242_service_catalog_service.list_launch_paths.async_list_launch_paths(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListLaunchPaths")
)
input_: capo_service_catalog.types.list_launch_paths_input.ListLaunchPathsInput = {
"product_id": product_id
}
if accept_language is not None:
input_["accept_language"] = accept_language
if page_size is not None:
input_["page_size"] = page_size
if page_token is not None:
input_["page_token"] = page_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|