:doc:`finspace <../../finspace>` / Client / get_kx_changeset

****************
get_kx_changeset
****************



.. py:method:: finspace.Client.get_kx_changeset(**kwargs)

  

  Returns information about a kdb changeset.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxChangeset>`_  


  **Request Syntax**
  ::

    response = client.get_kx_changeset(
        environmentId='string',
        databaseName='string',
        changesetId='string'
    )
    
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    A unique identifier for the kdb environment.

    

  
  :type databaseName: string
  :param databaseName: **[REQUIRED]** 

    The name of the kdb database.

    

  
  :type changesetId: string
  :param changesetId: **[REQUIRED]** 

    A unique identifier of the changeset for which you want to retrieve data.

    

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

    
    ::

      {
          'changesetId': 'string',
          'databaseName': 'string',
          'environmentId': 'string',
          'changeRequests': [
              {
                  'changeType': 'PUT'|'DELETE',
                  's3Path': 'string',
                  'dbPath': 'string'
              },
          ],
          'createdTimestamp': datetime(2015, 1, 1),
          'activeFromTimestamp': datetime(2015, 1, 1),
          'lastModifiedTimestamp': datetime(2015, 1, 1),
          'status': 'PENDING'|'PROCESSING'|'FAILED'|'COMPLETED',
          'errorInfo': {
              'errorMessage': 'string',
              'errorType': 'The inputs to this request are invalid.'|'Service limits have been exceeded.'|'Missing required permission to perform this request.'|'One or more inputs to this request were not found.'|'The system temporarily lacks sufficient resources to process the request.'|'An internal error has occurred.'|'Cancelled'|'A user recoverable error has occurred'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **changesetId** *(string) --* 

        A unique identifier for the changeset.

        
      

      - **databaseName** *(string) --* 

        The name of the kdb database.

        
      

      - **environmentId** *(string) --* 

        A unique identifier for the kdb environment.

        
      

      - **changeRequests** *(list) --* 

        A list of change request objects that are run in order.

        
        

        - *(dict) --* 

          A list of change request objects.

          
          

          - **changeType** *(string) --* 

            Defines the type of change request. A ``changeType`` can have the following values:

             

            
            * PUT – Adds or updates files in a database.
             
            * DELETE – Deletes files in a database.
            

            
          

          - **s3Path** *(string) --* 

            Defines the S3 path of the source file that is required to add or update files in a database.

            
          

          - **dbPath** *(string) --* 

            Defines the path within the database directory.

            
      
    
      

      - **createdTimestamp** *(datetime) --* 

        The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        
      

      - **activeFromTimestamp** *(datetime) --* 

        Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        
      

      - **lastModifiedTimestamp** *(datetime) --* 

        The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        
      

      - **status** *(string) --* 

        Status of the changeset creation process.

         

        
        * Pending – Changeset creation is pending.
         
        * Processing – Changeset creation is running.
         
        * Failed – Changeset creation has failed.
         
        * Complete – Changeset creation has succeeded.
        

        
      

      - **errorInfo** *(dict) --* 

        Provides details in the event of a failed flow, including the error type and the related error message.

        
        

        - **errorMessage** *(string) --* 

          Specifies the error message that appears if a flow fails.

          
        

        - **errorType** *(string) --* 

          Specifies the type of error.

          
    
  
  **Exceptions**
  
  *   :py:class:`finspace.Client.exceptions.InternalServerException`

  
  *   :py:class:`finspace.Client.exceptions.ValidationException`

  
  *   :py:class:`finspace.Client.exceptions.ThrottlingException`

  
  *   :py:class:`finspace.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`finspace.Client.exceptions.ResourceNotFoundException`

  