:doc:`ServiceCatalog <../../servicecatalog>` / Client / describe_provisioning_artifact

******************************
describe_provisioning_artifact
******************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribeProvisioningArtifact>`_  


  **Request Syntax**
  ::

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

    The language code.

     

    
    * ``jp`` - Japanese
     
    * ``zh`` - Chinese
    

    

  
  :type ProvisioningArtifactId: string
  :param ProvisioningArtifactId: 

    The identifier of the provisioning artifact.

    

  
  :type ProductId: string
  :param ProductId: 

    The product identifier.

    

  
  :type ProvisioningArtifactName: string
  :param ProvisioningArtifactName: 

    The provisioning artifact name.

    

  
  :type ProductName: string
  :param ProductName: 

    The product name.

    

  
  :type Verbose: boolean
  :param Verbose: 

    Indicates whether a verbose level of detail is enabled.

    

  
  :type IncludeProvisioningArtifactParameters: boolean
  :param IncludeProvisioningArtifactParameters: 

    Indicates if the API call response does or does not include additional details about the provisioning parameters.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ProvisioningArtifactDetail': {
              'Id': 'string',
              'Name': 'string',
              'Description': 'string',
              'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD'|'EXTERNAL',
              'CreatedTime': datetime(2015, 1, 1),
              'Active': True|False,
              'Guidance': 'DEFAULT'|'DEPRECATED',
              'SourceRevision': 'string'
          },
          'Info': {
              'string': 'string'
          },
          'Status': 'AVAILABLE'|'CREATING'|'FAILED',
          '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'
                  }
              },
          ]
      }
      
    **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
           
          * ``TERRAFORM_OPEN_SOURCE`` - Terraform Open Source configuration file
           
          * ``TERRAFORM_CLOUD`` - Terraform Cloud configuration file
           
          * ``EXTERNAL`` - External configuration file
          

          
        

        - **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.

        
      

      - **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.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`ServiceCatalog.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ServiceCatalog.Client.exceptions.InvalidParametersException`

  