Skip to content

describe_provisioning_artifact

describe_provisioning_artifact(
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
    accept_language: Optional[AcceptLanguage] = None,
    provisioning_artifact_id: Optional[Id] = None,
    product_id: Optional[Id] = None,
    provisioning_artifact_name: Optional[ProvisioningArtifactName] = None,
    product_name: Optional[ProductViewName] = None,
    verbose: Optional[Verbose] = None,
    include_provisioning_artifact_parameters: Optional[Boolean] = None,
) -> DescribeProvisioningArtifactOutput

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

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

    The identifier of the provisioning artifact.

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

    The product identifier.

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

    The provisioning artifact name.

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

    The product name.

  • verbose (Optional[Verbose], default: None ) –

    Indicates whether a verbose level of detail is enabled.

  • include_provisioning_artifact_parameters (Optional[Boolean], default: None ) –

    Indicates if the API call response does or does not include additional details about the provisioning parameters.

Raises:

Source code in docs_src/capo_service_catalog/_services/service_catalog.py
def describe_provisioning_artifact(
    self,
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
    accept_language: Optional[
        "capo_service_catalog.types.accept_language.AcceptLanguage"
    ] = None,
    provisioning_artifact_id: Optional["capo_service_catalog.types.id.Id"] = None,
    product_id: Optional["capo_service_catalog.types.id.Id"] = None,
    provisioning_artifact_name: Optional[
        "capo_service_catalog.types.provisioning_artifact_name.ProvisioningArtifactName"
    ] = None,
    product_name: Optional[
        "capo_service_catalog.types.product_view_name.ProductViewName"
    ] = None,
    verbose: Optional["capo_service_catalog.types.verbose.Verbose"] = None,
    include_provisioning_artifact_parameters: Optional[
        "capo_service_catalog.types.boolean.Boolean"
    ] = None,
) -> "capo_service_catalog.types.describe_provisioning_artifact_output.DescribeProvisioningArtifactOutput":
    """<p>Gets information about the specified provisioning artifact (also known as a version) for the specified product.</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>
        provisioning_artifact_id: <p>The identifier of the provisioning artifact.</p>
        product_id: <p>The product identifier.</p>
        provisioning_artifact_name: <p>The provisioning artifact name.</p>
        product_name: <p>The product name.</p>
        verbose: <p>Indicates whether a verbose level of detail is enabled.</p>
        include_provisioning_artifact_parameters: <p>Indicates if the API call response does or does not include additional details about the provisioning parameters. </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_artifact_input.DescribeProvisioningArtifactInput]",
    ) -> OperationResponse[
        "capo_service_catalog.types.describe_provisioning_artifact_output.DescribeProvisioningArtifactOutput"
    ]:
        import capo_service_catalog._operations.aws242_service_catalog_service.describe_provisioning_artifact

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeProvisioningArtifact")
    )
    input_: capo_service_catalog.types.describe_provisioning_artifact_input.DescribeProvisioningArtifactInput = {}
    if accept_language is not None:
        input_["accept_language"] = accept_language
    if provisioning_artifact_id is not None:
        input_["provisioning_artifact_id"] = provisioning_artifact_id
    if product_id is not None:
        input_["product_id"] = product_id
    if provisioning_artifact_name is not None:
        input_["provisioning_artifact_name"] = provisioning_artifact_name
    if product_name is not None:
        input_["product_name"] = product_name
    if verbose is not None:
        input_["verbose"] = verbose
    if include_provisioning_artifact_parameters is not None:
        input_["include_provisioning_artifact_parameters"] = (
            include_provisioning_artifact_parameters
        )

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