:doc:`Glue <../../glue>` / Client / get_blueprint

*************
get_blueprint
*************



.. py:method:: Glue.Client.get_blueprint(**kwargs)

  

  Retrieves the details of a blueprint.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetBlueprint>`_  


  **Request Syntax**
  ::

    response = client.get_blueprint(
        Name='string',
        IncludeBlueprint=True|False,
        IncludeParameterSpec=True|False
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name of the blueprint.

    

  
  :type IncludeBlueprint: boolean
  :param IncludeBlueprint: 

    Specifies whether or not to include the blueprint in the response.

    

  
  :type IncludeParameterSpec: boolean
  :param IncludeParameterSpec: 

    Specifies whether or not to include the parameter specification.

    

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

    
    ::

      {
          'Blueprint': {
              'Name': 'string',
              'Description': 'string',
              'CreatedOn': datetime(2015, 1, 1),
              'LastModifiedOn': datetime(2015, 1, 1),
              'ParameterSpec': 'string',
              'BlueprintLocation': 'string',
              'BlueprintServiceLocation': 'string',
              'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED',
              'ErrorMessage': 'string',
              'LastActiveDefinition': {
                  'Description': 'string',
                  'LastModifiedOn': datetime(2015, 1, 1),
                  'ParameterSpec': 'string',
                  'BlueprintLocation': 'string',
                  'BlueprintServiceLocation': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Blueprint** *(dict) --* 

        Returns a ``Blueprint`` object.

        
        

        - **Name** *(string) --* 

          The name of the blueprint.

          
        

        - **Description** *(string) --* 

          The description of the blueprint.

          
        

        - **CreatedOn** *(datetime) --* 

          The date and time the blueprint was registered.

          
        

        - **LastModifiedOn** *(datetime) --* 

          The date and time the blueprint was last modified.

          
        

        - **ParameterSpec** *(string) --* 

          A JSON string that indicates the list of parameter specifications for the blueprint.

          
        

        - **BlueprintLocation** *(string) --* 

          Specifies the path in Amazon S3 where the blueprint is published.

          
        

        - **BlueprintServiceLocation** *(string) --* 

          Specifies a path in Amazon S3 where the blueprint is copied when you call ``CreateBlueprint/UpdateBlueprint`` to register the blueprint in Glue.

          
        

        - **Status** *(string) --* 

          The status of the blueprint registration.

           

          
          * Creating — The blueprint registration is in progress.
           
          * Active — The blueprint has been successfully registered.
           
          * Updating — An update to the blueprint registration is in progress.
           
          * Failed — The blueprint registration failed.
          

          
        

        - **ErrorMessage** *(string) --* 

          An error message.

          
        

        - **LastActiveDefinition** *(dict) --* 

          When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.

          
          

          - **Description** *(string) --* 

            The description of the blueprint.

            
          

          - **LastModifiedOn** *(datetime) --* 

            The date and time the blueprint was last modified.

            
          

          - **ParameterSpec** *(string) --* 

            A JSON string specifying the parameters for the blueprint.

            
          

          - **BlueprintLocation** *(string) --* 

            Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.

            
          

          - **BlueprintServiceLocation** *(string) --* 

            Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Glue.Client.exceptions.EntityNotFoundException`

  
  *   :py:class:`Glue.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Glue.Client.exceptions.OperationTimeoutException`

  
  *   :py:class:`Glue.Client.exceptions.InternalServiceException`

  