[ aws . servicecatalog ]

describe-provisioning-artifact

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-provisioning-artifact
[--accept-language <value>]
[--provisioning-artifact-id <value>]
[--product-id <value>]
[--provisioning-artifact-name <value>]
[--product-name <value>]
[--verbose | --no-verbose]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--provisioning-artifact-id (string)

The identifier of the provisioning artifact.

--product-id (string)

The product identifier.

--provisioning-artifact-name (string)

The provisioning artifact name.

--product-name (string)

The product name.

--verbose | --no-verbose (boolean)

Indicates whether a verbose level of detail is enabled.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a provisioning artifact

The following describe-provisioning-artifact example displays details for the specified provisioning artifact.

aws servicecatalog describe-provisioning-artifact \
    --provisioning-artifact-id pa-pcz347abcdcfm \
    --product-id prod-abcdfz3syn2rg

Output:

{
    "Info": {
        "TemplateUrl": "https://awsdocs.s3.amazonaws.com/servicecatalog/myexampledevelopment-environment.template"
    },
    "ProvisioningArtifactDetail": {
        "Id": "pa-pcz347abcdcfm",
        "Active": true,
        "Type": "CLOUD_FORMATION_TEMPLATE",
        "Description": "updated description",
        "CreatedTime": 1562097906.0,
        "Name": "updated name"
    },
    "Status": "AVAILABLE"
}

Output

ProvisioningArtifactDetail -> (structure)

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 - AWS CloudFormation template

• MARKETPLACE_AMI - AWS Marketplace AMI

• MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

CreatedTime -> (timestamp)

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.

Info -> (map)

The URL of the CloudFormation template in Amazon S3.

key -> (string)

value -> (string)

Status -> (string)

The status of the current request.