ListLaunchPaths
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.
Note
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.
Request Syntax
{
"AcceptLanguage": "string",
"PageSize": number,
"PageToken": "string",
"ProductId": "string"
}Request Parameters
The request accepts the following data in JSON format.
- AcceptLanguage
-
The language code.
-
jp- Japanese -
zh- Chinese
Type: String
Length Constraints: Maximum length of 100.
Required: No
-
- PageSize
-
The maximum number of items to return with this call.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 20.
Required: No
- PageToken
-
The page token for the next set of results. To retrieve the first set of results, use null.
Type: String
Length Constraints: Maximum length of 2024.
Pattern:
[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*Required: No
- ProductId
-
The product identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9_\-]*Required: Yes
Response Syntax
{
"LaunchPathSummaries": [
{
"ConstraintSummaries": [
{
"Description": "string",
"Type": "string"
}
],
"Id": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"NextPageToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LaunchPathSummaries
-
Information about the launch path.
Type: Array of LaunchPathSummary objects
- NextPageToken
-
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Type: String
Length Constraints: Maximum length of 2024.
Pattern:
[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*
Errors
- InvalidParametersException
-
One or more parameters provided to the operation are not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
