Skip to content

update_provisioned_product

update_provisioned_product(
    update_token: IdempotencyToken,
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
    accept_language: Optional[AcceptLanguage] = None,
    provisioned_product_name: Optional[ProvisionedProductNameOrArn] = None,
    provisioned_product_id: Optional[Id] = 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,
    provisioning_parameters: Optional[UpdateProvisioningParameters] = None,
    provisioning_preferences: Optional[UpdateProvisioningPreferences] = None,
    tags: Optional[Tags] = None,
) -> UpdateProvisionedProductOutput

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • provisioned_product_name (Optional[ProvisionedProductNameOrArn], default: None ) –

    The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

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

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

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

    The identifier of the product. You must provide the 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.

  • 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. This value is optional if the product has a default path, and required if the product has more than one path. 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.

  • provisioning_parameters (Optional[UpdateProvisioningParameters], default: None ) –

    The new parameters.

  • provisioning_preferences (Optional[UpdateProvisioningPreferences], default: None ) –

    An object that contains information about the provisioning preferences for a stack set.

  • tags (Optional[Tags], default: None ) –

    One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

  • update_token (IdempotencyToken) –

    The idempotency token that uniquely identifies the provisioning update request.

Raises:

Source code in docs_src/capo_service_catalog/_services/service_catalog.py
def update_provisioned_product(
    self,
    update_token: "capo_service_catalog.types.idempotency_token.IdempotencyToken",
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
    accept_language: Optional[
        "capo_service_catalog.types.accept_language.AcceptLanguage"
    ] = None,
    provisioned_product_name: Optional[
        "capo_service_catalog.types.provisioned_product_name_or_arn.ProvisionedProductNameOrArn"
    ] = None,
    provisioned_product_id: Optional["capo_service_catalog.types.id.Id"] = 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,
    provisioning_parameters: Optional[
        "capo_service_catalog.types.update_provisioning_parameters.UpdateProvisioningParameters"
    ] = None,
    provisioning_preferences: Optional[
        "capo_service_catalog.types.update_provisioning_preferences.UpdateProvisioningPreferences"
    ] = None,
    tags: Optional["capo_service_catalog.types.tags.Tags"] = None,
) -> "capo_service_catalog.types.update_provisioned_product_output.UpdateProvisionedProductOutput":
    """<p>Requests updates to the configuration of the specified provisioned product.</p> <p>If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.</p> <p>You can check the status of this request using <a>DescribeRecord</a>.</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>
        provisioned_product_name: <p>The name of the provisioned product. You cannot specify both <code>ProvisionedProductName</code> and <code>ProvisionedProductId</code>.</p>
        provisioned_product_id: <p>The identifier of the provisioned product. You must provide the name or ID, but not both.</p>
        product_id: <p>The identifier of the product. You must provide the 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.</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. This value is optional if the product has a default path, and required if the product has more than one path. 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>
        provisioning_parameters: <p>The new parameters.</p>
        provisioning_preferences: <p>An object that contains information about the provisioning preferences for a stack set.</p>
        tags: <p>One or more tags. Requires the product to have <code>RESOURCE_UPDATE</code> constraint with <code>TagUpdatesOnProvisionedProduct</code> set to <code>ALLOWED</code> to allow tag updates.</p>
        update_token: <p>The idempotency token that uniquely identifies the provisioning update request.</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.update_provisioned_product_input.UpdateProvisionedProductInput]",
    ) -> OperationResponse[
        "capo_service_catalog.types.update_provisioned_product_output.UpdateProvisionedProductOutput"
    ]:
        import capo_service_catalog._operations.aws242_service_catalog_service.update_provisioned_product

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateProvisionedProduct")
    )
    input_: capo_service_catalog.types.update_provisioned_product_input.UpdateProvisionedProductInput = {
        "update_token": update_token
    }
    if accept_language is not None:
        input_["accept_language"] = accept_language
    if provisioned_product_name is not None:
        input_["provisioned_product_name"] = provisioned_product_name
    if provisioned_product_id is not None:
        input_["provisioned_product_id"] = provisioned_product_id
    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
    if provisioning_parameters is not None:
        input_["provisioning_parameters"] = provisioning_parameters
    if provisioning_preferences is not None:
        input_["provisioning_preferences"] = provisioning_preferences
    if tags is not None:
        input_["tags"] = tags

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