ServiceCatalog / Client / update_provisioning_artifact

update_provisioning_artifact#

ServiceCatalog.Client.update_provisioning_artifact(**kwargs)#

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

See also: AWS API Documentation

Request Syntax

response = client.update_provisioning_artifact(
    AcceptLanguage='string',
    ProductId='string',
    ProvisioningArtifactId='string',
    Name='string',
    Description='string',
    Active=True|False,
    Guidance='DEFAULT'|'DEPRECATED'
)
Parameters:

  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • ProductId (string) –

    [REQUIRED]

    The product identifier.

  • ProvisioningArtifactId (string) –

    [REQUIRED]

    The identifier of the provisioning artifact.

  • Name (string) – The updated name of the provisioning artifact.

  • Description (string) – The updated description of the provisioning artifact.

  • Active (boolean) –

    Indicates whether the product version is active.

    Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

  • Guidance (string) –

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    The DEFAULT value indicates that the product version is active.

    The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

Return type:

dict

Returns:

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD'|'EXTERNAL',
        'CreatedTime': datetime(2015, 1, 1),
        'Active': True|False,
        'Guidance': 'DEFAULT'|'DEPRECATED',
        'SourceRevision': 'string'
    },
    'Info': {
        'string': 'string'
    },
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

  • (dict) –

    • ProvisioningArtifactDetail (dict) –

      Information about the provisioning artifact.

      • Id (string) –

        The identifier of the provisioning artifact.

      • Name (string) –

        The name of the provisioning artifact.

      • Description (string) –

        The description of the provisioning artifact.

      • Type (string) –

        The type of provisioning artifact.

        • CLOUD_FORMATION_TEMPLATE - CloudFormation template

        • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

        • TERRAFORM_CLOUD - Terraform Cloud configuration file

        • EXTERNAL - External configuration file

      • CreatedTime (datetime) –

        The UTC time stamp of the creation time.

      • Active (boolean) –

        Indicates whether the product version is active.

      • Guidance (string) –

        Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

      • SourceRevision (string) –

        Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

        This field only exists for Repo-Synced products.

    • Info (dict) –

      The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

      • (string) –

        • (string) –

    • Status (string) –

      The status of the current request.

Exceptions