ServiceCatalog / Client / describe_provisioning_parameters

describe_provisioning_parameters#

ServiceCatalog.Client.describe_provisioning_parameters(**kwargs)#

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error “Parameter validation failed: Missing required parameter in Tags[N]:Value”. Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

See also: AWS API Documentation

Request Syntax

response = client.describe_provisioning_parameters(
    AcceptLanguage='string',
    ProductId='string',
    ProductName='string',
    ProvisioningArtifactId='string',
    ProvisioningArtifactName='string',
    PathId='string',
    PathName='string'
)

Parameters:

AcceptLanguage (string) –
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
ProductId (string) – The product identifier. You must provide the product name or ID, but not both.
ProductName (string) – The name of the product. You must provide the name or ID, but not both.
ProvisioningArtifactId (string) – The identifier of the provisioning artifact. You must provide the name or ID, but not both.
ProvisioningArtifactName (string) – The name of the provisioning artifact. You must provide the name or ID, but not both.
PathId (string) – The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
PathName (string) – The name of the path. You must provide the name or ID, but not both.

Return type:

dict

Returns:

Response Syntax

{
    'ProvisioningArtifactParameters': [
        {
            'ParameterKey': 'string',
            'DefaultValue': 'string',
            'ParameterType': 'string',
            'IsNoEcho': True|False,
            'Description': 'string',
            'ParameterConstraints': {
                'AllowedValues': [
                    'string',
                ],
                'AllowedPattern': 'string',
                'ConstraintDescription': 'string',
                'MaxLength': 'string',
                'MinLength': 'string',
                'MaxValue': 'string',
                'MinValue': 'string'
            }
        },
    ],
    'ConstraintSummaries': [
        {
            'Type': 'string',
            'Description': 'string'
        },
    ],
    'UsageInstructions': [
        {
            'Type': 'string',
            'Value': 'string'
        },
    ],
    'TagOptions': [
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    'ProvisioningArtifactPreferences': {
        'StackSetAccounts': [
            'string',
        ],
        'StackSetRegions': [
            'string',
        ]
    },
    'ProvisioningArtifactOutputs': [
        {
            'Key': 'string',
            'Description': 'string'
        },
    ],
    'ProvisioningArtifactOutputKeys': [
        {
            'Key': 'string',
            'Description': 'string'
        },
    ]
}

Response Structure

(dict) –
- ProvisioningArtifactParameters (list) –
  
  Information about the parameters used to provision the product.
  - (dict) –
    
    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 (dict) –
      
      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 for String 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 for String types.
      - MinLength (string) –
        
        An integer value that determines the smallest number of characters you want to allow for String types.
      - MaxValue (string) –
        
        A numeric value that determines the largest numeric value you want to allow for Number types.
      - MinValue (string) –
        
        A numeric value that determines the smallest numeric value you want to allow for Number types.
- ConstraintSummaries (list) –
  
  Information about the constraints used to provision the product.
  - (dict) –
    
    Summary information about a constraint.
    - Type (string) –
      
      The type of constraint.
      - LAUNCH
      - NOTIFICATION
      - STACKSET
      - TEMPLATE
    - Description (string) –
      
      The description of the constraint.
- UsageInstructions (list) –
  
  Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.
  - (dict) –
    
    Additional information provided by the administrator.
    - Type (string) –
      
      The usage instruction type for the value.
    - Value (string) –
      
      The usage instruction value for this type.
- TagOptions (list) –
  
  Information about the TagOptions associated with the resource.
  - (dict) –
    
    Summary information about a TagOption.
    - Key (string) –
      
      The TagOption key.
    - Values (list) –
      
      The TagOption value.
      - (string) –
- ProvisioningArtifactPreferences (dict) –
  
  An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.
  - StackSetAccounts (list) –
    
    One or more Amazon Web Services accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.
    
    Applicable only to a CFN_STACKSET provisioned product type.
    - (string) –
  - StackSetRegions (list) –
    
    One or more Amazon Web Services Regions where stack instances are deployed from the stack set. These Regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.
    
    Applicable only to a CFN_STACKSET provisioned product type.
    - (string) –
- ProvisioningArtifactOutputs (list) –
  
  The output of the provisioning artifact.
  - (dict) –
    
    Provisioning artifact output.
    - Key (string) –
      
      The provisioning artifact output key.
    - Description (string) –
      
      Description of the provisioning artifact output key.
- ProvisioningArtifactOutputKeys (list) –
  
  A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.
  - (dict) –
    
    Provisioning artifact output.
    - Key (string) –
      
      The provisioning artifact output key.
    - Description (string) –
      
      Description of the provisioning artifact output key.

Exceptions

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