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

******************
list_kx_changesets
******************



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

  

  Returns a list of all the changesets for a database.

  

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


  **Request Syntax**
  ::

    response = client.list_kx_changesets(
        environmentId='string',
        databaseName='string',
        nextToken='string',
        maxResults=123
    )
    
  :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 nextToken: string
  :param nextToken: 

    A token that indicates where a results page should begin.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in this request.

    

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

    
    ::

      {
          'kxChangesets': [
              {
                  'changesetId': 'string',
                  'createdTimestamp': datetime(2015, 1, 1),
                  'activeFromTimestamp': datetime(2015, 1, 1),
                  'lastModifiedTimestamp': datetime(2015, 1, 1),
                  'status': 'PENDING'|'PROCESSING'|'FAILED'|'COMPLETED'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **kxChangesets** *(list) --* 

        A list of changesets for a database.

        
        

        - *(dict) --* 

          Details of changeset.

          
          

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

            A unique identifier for the changeset.

            
          

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

             

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

            
      
    
      

      - **nextToken** *(string) --* 

        A token that indicates where a results page should begin.

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

  