:doc:`DeadlineCloud <../../deadline>` / Paginator / ListSessionActions

******************
ListSessionActions
******************



.. py:class:: DeadlineCloud.Paginator.ListSessionActions

  ::

    
    paginator = client.get_paginator('list_session_actions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DeadlineCloud.Client.list_session_actions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListSessionActions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          farmId='string',
          queueId='string',
          jobId='string',
          sessionId='string',
          taskId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type farmId: string
    :param farmId: **[REQUIRED]** 

      The farm ID for the session actions list.

      

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

      The queue ID for the session actions list.

      

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

      The job ID for the session actions list.

      

    
    :type sessionId: string
    :param sessionId: 

      The session ID to include on the sessions action list.

      

    
    :type taskId: string
    :param taskId: 

      The task ID for the session actions list.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'sessionActions': [
                {
                    'sessionActionId': 'string',
                    'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED',
                    'startedAt': datetime(2015, 1, 1),
                    'endedAt': datetime(2015, 1, 1),
                    'workerUpdatedAt': datetime(2015, 1, 1),
                    'progressPercent': ...,
                    'definition': {
                        'envEnter': {
                            'environmentId': 'string'
                        },
                        'envExit': {
                            'environmentId': 'string'
                        },
                        'taskRun': {
                            'taskId': 'string',
                            'stepId': 'string',
                            'parameters': {
                                'string': {
                                    'int': 'string',
                                    'float': 'string',
                                    'string': 'string',
                                    'path': 'string',
                                    'chunkInt': 'string'
                                }
                            }
                        },
                        'syncInputJobAttachments': {
                            'stepId': 'string'
                        }
                    },
                    'manifests': [
                        {
                            'outputManifestPath': 'string',
                            'outputManifestHash': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **sessionActions** *(list) --* 

          The session actions.

          
          

          - *(dict) --* 

            The details of a session action.

            
            

            - **sessionActionId** *(string) --* 

              The session action ID.

              
            

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

              The status of the session action.

              
            

            - **startedAt** *(datetime) --* 

              The date and time the resource started running.

              
            

            - **endedAt** *(datetime) --* 

              The date and time the resource ended running.

              
            

            - **workerUpdatedAt** *(datetime) --* 

              The Linux timestamp of the last date and time that the session action was updated.

              
            

            - **progressPercent** *(float) --* 

              The completion percentage for the session action.

              
            

            - **definition** *(dict) --* 

              The session action definition.

              .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``envEnter``, ``envExit``, ``taskRun``, ``syncInputJobAttachments``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


            
              

              - **envEnter** *(dict) --* 

                The environment to enter into.

                
                

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

                  The environment ID.

                  
            
              

              - **envExit** *(dict) --* 

                The environment to exit from.

                
                

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

                  The environment ID.

                  
            
              

              - **taskRun** *(dict) --* 

                The task run.

                
                

                - **taskId** *(string) --* 

                  The task ID.

                  
                

                - **stepId** *(string) --* 

                  The step ID.

                  
                

                - **parameters** *(dict) --* 

                  The parameters of a task run in a session action.

                  
                  

                  - *(string) --* 
                    

                    - *(dict) --* 

                      The data types for the task parameters.

                      .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``int``, ``float``, ``string``, ``path``, ``chunkInt``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                    
                      

                      - **int** *(string) --* 

                        A signed integer represented as a string.

                        
                      

                      - **float** *(string) --* 

                        A double precision IEEE-754 floating point number represented as a string.

                        
                      

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

                        A UTF-8 string.

                        
                      

                      - **path** *(string) --* 

                        A file system path represented as a string.

                        
                      

                      - **chunkInt** *(string) --* 

                        A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.

                        
                  
              
            
            
              

              - **syncInputJobAttachments** *(dict) --* 

                The session action definition summary for syncing input job attachments.

                
                

                - **stepId** *(string) --* 

                  The step ID for the sync input job attachments session action summary.

                  
            
          
            

            - **manifests** *(list) --* 

              The list of manifest properties that describe file attachments for the task run.

              
              

              - *(dict) --* 

                The manifest properties for a task run, corresponding to the manifest properties in the job.

                
                

                - **outputManifestPath** *(string) --* 

                  The manifest file path.

                  
                

                - **outputManifestHash** *(string) --* 

                  The hash value of the file.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    