AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . servicecatalog ]
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
See also: AWS API Documentation
describe-provisioning-artifact
[--accept-language <value>]
[--provisioning-artifact-id <value>]
[--product-id <value>]
[--provisioning-artifact-name <value>]
[--product-name <value>]
[--verbose | --no-verbose]
[--include-provisioning-artifact-parameters | --no-include-provisioning-artifact-parameters]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--accept-language
(string)
The language code.
jp
- Japanesezh
- 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.
--include-provisioning-artifact-parameters
| --no-include-provisioning-artifact-parameters
(boolean)
Indicates if the API call response does or does not include additional details about the provisioning parameters.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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 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"
}
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 templateTERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration fileTERRAFORM_CLOUD
- Terraform Cloud configuration fileEXTERNAL
- External configuration fileCreatedTime -> (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.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 forCreateProduct
,UpdateProduct
,DescribeProductAsAdmin
,DescribeProvisioningArtifact
,ListProvisioningArtifact
, andUpdateProvisioningArticat
APIs.This field only exists for Repo-Synced products.
Info -> (map)
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
key -> (string)
value -> (string)
Status -> (string)
The status of the current request.
ProvisioningArtifactParameters -> (list)
Information about the parameters used to provision the product.
(structure)
Information about a parameter used to provision a product.
ParameterKey -> (string)
The parameter key.DefaultValue -> (string)
The default value.ParameterType -> (string)
The parameter type.IsNoEcho -> (boolean)
If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.Description -> (string)
The description of the parameter.ParameterConstraints -> (structure)
Constraints that the administrator has put on a parameter.
AllowedValues -> (list)
The values that the administrator has allowed for the parameter.
(string)
AllowedPattern -> (string)
A regular expression that represents the patterns that allow forString
types. The pattern must match the entire parameter value provided.ConstraintDescription -> (string)
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of
[A-Za-z0-9]+
displays the following error message when the user specifies an invalid value:Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
MaxLength -> (string)
An integer value that determines the largest number of characters you want to allow forString
types.MinLength -> (string)
An integer value that determines the smallest number of characters you want to allow forString
types.MaxValue -> (string)
A numeric value that determines the largest numeric value you want to allow forNumber
types.MinValue -> (string)
A numeric value that determines the smallest numeric value you want to allow forNumber
types.