AWS CLI Command Reference

[ aws . servicecatalog ]

create-provisioning-artifact

Description

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

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

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-provisioning-artifact
[--accept-language <value>]
--product-id <value>
--parameters <value>
[--idempotency-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--accept-language (string)

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

--product-id (string)

The product identifier.

--parameters (structure)

The configuration for the provisioning artifact.

Name -> (string)

The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

Description -> (string)

The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

Info -> (map)

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ]

The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format. Specify the URL in JSON format as follows:

"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

ImportFromPhysicalId : The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

key -> (string)

value -> (string)

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

DisableTemplateValidation -> (boolean)

If set to true, Amazon Web Services Service Catalog stops validating the specified provisioning artifact even if it is invalid.

Shorthand Syntax:

Name=string,Description=string,Info={KeyName1=string,KeyName2=string},Type=string,DisableTemplateValidation=boolean

JSON Syntax:

{
  "Name": "string",
  "Description": "string",
  "Info": {"string": "string"
    ...},
  "Type": "CLOUD_FORMATION_TEMPLATE"|"MARKETPLACE_AMI"|"MARKETPLACE_CAR",
  "DisableTemplateValidation": true|false
}

--idempotency-token (string)

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a provisioning artifact

The following create-provisioning-artifact example creates a provisioning artifact, using a JSON file to pass parameters.

aws servicecatalog create-provisioning-artifact \
   --cli-input-json file://create-provisioning-artifact-input.json

Contents of create-provisioning-artifact-input.json:

{
    "ProductId": "prod-nfi2abcdefghi",
    "Parameters": {
        "Name": "test-provisioning-artifact",
        "Description": "test description",
        "Info": {
            "LoadTemplateFromURL": "https://s3-us-west-1.amazonaws.com/cloudformation-templates-us-west-1/my-cfn-template.template"
        },
        "Type": "CLOUD_FORMATION_TEMPLATE"
    }
}

Output:

{
    "Info": {
        "TemplateUrl": "https://s3-us-west-1.amazonaws.com/cloudformation-templates-us-west-1/my-cfn-template.template"
    },
    "Status": "CREATING",
    "ProvisioningArtifactDetail": {
        "Id": "pa-bb4abcdefwnaio",
        "Name": "test-provisioning-artifact",
        "Description": "test description",
        "Active": true,
        "Type": "CLOUD_FORMATION_TEMPLATE",
        "CreatedTime": 1576022545.0
    }
}

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

  • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

  • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services 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)

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ].

The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.

LoadTemplateFromURL

Use the URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.

ImportFromPhysicalId

Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.

key -> (string)

value -> (string)

Status -> (string)

The status of the current request.

© Copyright 2018, Amazon Web Services. Created using Sphinx.