Skip to content

ProvisioningArtifactDetail

Source code in docs_src/capo_service_catalog/types/provisioning_artifact_detail.py
class ProvisioningArtifactDetail(TypedDict, closed=True):
    id: NotRequired["capo_service_catalog.types.id.Id"]
    """<p>The identifier of the provisioning artifact.</p>"""
    name: NotRequired[
        "capo_service_catalog.types.provisioning_artifact_name.ProvisioningArtifactName"
    ]
    """<p>The name of the provisioning artifact.</p>"""
    description: NotRequired[
        "capo_service_catalog.types.provisioning_artifact_name.ProvisioningArtifactName"
    ]
    """<p>The description of the provisioning artifact.</p>"""
    type: NotRequired[
        "capo_service_catalog.types.provisioning_artifact_type.ProvisioningArtifactType"
    ]
    """<p>The type of provisioning artifact.</p> <ul> <li> <p> <code>CLOUD_FORMATION_TEMPLATE</code> - CloudFormation template</p> </li> <li> <p> <code>TERRAFORM_OPEN_SOURCE</code> - Terraform Open Source configuration file</p> </li> <li> <p> <code>TERRAFORM_CLOUD</code> - Terraform Cloud configuration file</p> </li> <li> <p> <code>EXTERNAL</code> - External configuration file</p> </li> </ul>"""
    created_time: NotRequired["capo_service_catalog.types.creation_time.CreationTime"]
    """<p>The UTC time stamp of the creation time.</p>"""
    active: NotRequired[
        "capo_service_catalog.types.provisioning_artifact_active.ProvisioningArtifactActive"
    ]
    """<p>Indicates whether the product version is active.</p>"""
    guidance: NotRequired[
        "capo_service_catalog.types.provisioning_artifact_guidance.ProvisioningArtifactGuidance"
    ]
    """<p>Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.</p>"""
    source_revision: NotRequired[
        "capo_service_catalog.types.source_revision.SourceRevision"
    ]
    """<p>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 <code>ProvisioningArtifactDetail</code> type, which is returned as part of the response for <code>CreateProduct</code>, <code>UpdateProduct</code>, <code>DescribeProductAsAdmin</code>, <code>DescribeProvisioningArtifact</code>, <code>ListProvisioningArtifact</code>, and <code>UpdateProvisioningArticat</code> APIs. </p> <p>This field only exists for Repo-Synced products. </p>"""

active instance-attribute

active: NotRequired[ProvisioningArtifactActive]

Indicates whether the product version is active.

created_time instance-attribute

created_time: NotRequired[CreationTime]

The UTC time stamp of the creation time.

description instance-attribute

description: NotRequired[ProvisioningArtifactName]

The description of the provisioning artifact.

guidance instance-attribute

guidance: NotRequired[ProvisioningArtifactGuidance]

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

id instance-attribute

id: NotRequired[Id]

The identifier of the provisioning artifact.

name instance-attribute

name: NotRequired[ProvisioningArtifactName]

The name of the provisioning artifact.

source_revision instance-attribute

source_revision: NotRequired[SourceRevision]

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.

type instance-attribute

type: NotRequired[ProvisioningArtifactType]

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