describe_provisioning_artifact

ServiceCatalog.Client.describe_provisioning_artifact(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_provisioning_artifact(
    AcceptLanguage='string',
    ProvisioningArtifactId='string',
    ProductId='string',
    ProvisioningArtifactName='string',
    ProductName='string',
    Verbose=True|False
)

Parameters

• AcceptLanguage (string) --

  The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese
• ProvisioningArtifactId (string) -- The identifier of the provisioning artifact.
• ProductId (string) -- The product identifier.
• ProvisioningArtifactName (string) -- The provisioning artifact name.
• ProductName (string) -- The product name.
• Verbose (boolean) -- Indicates whether a verbose level of detail is enabled.

Return type

dict

Returns

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
        '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
      • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI
      • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

    • 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

• ServiceCatalog.Client.exceptions.ResourceNotFoundException
• ServiceCatalog.Client.exceptions.InvalidParametersException