Skip to content

describe_provisioning_parameters

describe_provisioning_parameters(
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
    accept_language: Optional[AcceptLanguage] = None,
    product_id: Optional[Id] = None,
    product_name: Optional[ProductViewName] = None,
    provisioning_artifact_id: Optional[Id] = None,
    provisioning_artifact_name: Optional[ProvisioningArtifactName] = None,
    path_id: Optional[Id] = None,
    path_name: Optional[PortfolioDisplayName] = None,
) -> DescribeProvisioningParametersOutput

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Parameters:

  • accept_language (Optional[AcceptLanguage], default: None ) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • product_id (Optional[Id], default: None ) –

    The product identifier. You must provide the product name or ID, but not both.

  • product_name (Optional[ProductViewName], default: None ) –

    The name of the product. You must provide the name or ID, but not both.

  • provisioning_artifact_id (Optional[Id], default: None ) –

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

  • provisioning_artifact_name (Optional[ProvisioningArtifactName], default: None ) –

    The name of the provisioning artifact. You must provide the name or ID, but not both.

  • path_id (Optional[Id], default: None ) –

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

  • path_name (Optional[PortfolioDisplayName], default: None ) –

    The name of the path. You must provide the name or ID, but not both.

Raises:

Source code in docs_src/capo_service_catalog/_services/service_catalog.py
def describe_provisioning_parameters(
    self,
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
    accept_language: Optional[
        "capo_service_catalog.types.accept_language.AcceptLanguage"
    ] = None,
    product_id: Optional["capo_service_catalog.types.id.Id"] = None,
    product_name: Optional[
        "capo_service_catalog.types.product_view_name.ProductViewName"
    ] = None,
    provisioning_artifact_id: Optional["capo_service_catalog.types.id.Id"] = None,
    provisioning_artifact_name: Optional[
        "capo_service_catalog.types.provisioning_artifact_name.ProvisioningArtifactName"
    ] = None,
    path_id: Optional["capo_service_catalog.types.id.Id"] = None,
    path_name: Optional[
        "capo_service_catalog.types.portfolio_display_name.PortfolioDisplayName"
    ] = None,
) -> "capo_service_catalog.types.describe_provisioning_parameters_output.DescribeProvisioningParametersOutput":
    """<p>Gets information about the configuration required to provision the specified product using the specified provisioning artifact.</p> <p>If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to <a>ProvisionProduct</a>, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[<i>N</i>]:<i>Value</i>". Tag the provisioned product with the value <code>sc-tagoption-conflict-portfolioId-productId</code>.</p>

    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. You must provide the product name or ID, but not both.</p>
        product_name: <p>The name of the product. You must provide the name or ID, but not both.</p>
        provisioning_artifact_id: <p>The identifier of the provisioning artifact. You must provide the name or ID, but not both.</p>
        provisioning_artifact_name: <p>The name of the provisioning artifact. You must provide the name or ID, but not both.</p>
        path_id: <p>The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use <a>ListLaunchPaths</a>. You must provide the name or ID, but not both.</p>
        path_name: <p>The name of the path. You must provide the name or ID, but not both.</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.
    """

    def _handler(
        req: "OperationRequest[capo_service_catalog.types.describe_provisioning_parameters_input.DescribeProvisioningParametersInput]",
    ) -> OperationResponse[
        "capo_service_catalog.types.describe_provisioning_parameters_output.DescribeProvisioningParametersOutput"
    ]:
        import capo_service_catalog._operations.aws242_service_catalog_service.describe_provisioning_parameters

        output, http_response = (
            capo_service_catalog._operations.aws242_service_catalog_service.describe_provisioning_parameters.describe_provisioning_parameters(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeProvisioningParameters")
    )
    input_: capo_service_catalog.types.describe_provisioning_parameters_input.DescribeProvisioningParametersInput = {}
    if accept_language is not None:
        input_["accept_language"] = accept_language
    if product_id is not None:
        input_["product_id"] = product_id
    if product_name is not None:
        input_["product_name"] = product_name
    if provisioning_artifact_id is not None:
        input_["provisioning_artifact_id"] = provisioning_artifact_id
    if provisioning_artifact_name is not None:
        input_["provisioning_artifact_name"] = provisioning_artifact_name
    if path_id is not None:
        input_["path_id"] = path_id
    if path_name is not None:
        input_["path_name"] = path_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output