NovaActService / Client / list_sessions

list_sessions¶

NovaActService.Client.list_sessions(**kwargs)¶

Lists all sessions within a specific workflow run.

Request Syntax

response = client.list_sessions(
    workflowDefinitionName='string',
    workflowRunId='string',
    maxResults=123,
    nextToken='string',
    sortOrder='Ascending'|'Descending'
)

Parameters:

workflowDefinitionName (string) –
[REQUIRED]

The name of the workflow definition containing the workflow run.
workflowRunId (string) –
[REQUIRED]

The unique identifier of the workflow run to list sessions for.
maxResults (integer) – The maximum number of sessions to return in a single response.
nextToken (string) – The token for retrieving the next page of results.
sortOrder (string) – The sort order for the returned sessions (ascending or descending).

Return type:

dict

Returns:

Response Syntax

{
    'sessionSummaries': [
        {
            'sessionId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- sessionSummaries (list) –
  
  A list of summary information for sessions in the workflow run.
  - (dict) –
    
    Summary information about a session within a workflow run.
    - sessionId (string) –
      
      The unique identifier of the session.
- nextToken (string) –
  
  The token for retrieving the next page of results, if available.

Exceptions

NovaActService.Client.exceptions.AccessDeniedException
NovaActService.Client.exceptions.ConflictException
NovaActService.Client.exceptions.ThrottlingException
NovaActService.Client.exceptions.ResourceNotFoundException
NovaActService.Client.exceptions.InternalServerException
NovaActService.Client.exceptions.ValidationException