NovaActService / Client / list_acts

list_acts¶

NovaActService.Client.list_acts(**kwargs)¶

Lists all acts within a specific session with their current status and execution details.

Request Syntax

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

Parameters:

workflowDefinitionName (string) –
[REQUIRED]

The name of the workflow definition containing the session.
workflowRunId (string) – The unique identifier of the workflow run containing the session.
sessionId (string) – The unique identifier of the session to list acts for.
maxResults (integer) – The maximum number of acts 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 acts (ascending or descending).

Return type:

dict

Returns:

Response Syntax

{
    'actSummaries': [
        {
            'workflowRunId': 'string',
            'sessionId': 'string',
            'actId': 'string',
            'status': 'RUNNING'|'PENDING_CLIENT_ACTION'|'PENDING_HUMAN_ACTION'|'SUCCEEDED'|'FAILED'|'TIMED_OUT',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'traceLocation': {
                'locationType': 'S3',
                'location': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- actSummaries (list) –
  
  A list of summary information for acts in the session.
  - (dict) –
    
    Summary information about an act, including its status and execution timing.
    - workflowRunId (string) –
      
      The unique identifier of the workflow run containing this act.
    - sessionId (string) –
      
      The unique identifier of the session containing this act.
    - actId (string) –
      
      The unique identifier of the act.
    - status (string) –
      
      The current execution status of the act.
    - startedAt (datetime) –
      
      The timestamp when the act started execution.
    - endedAt (datetime) –
      
      The timestamp when the act completed execution, if applicable.
    - traceLocation (dict) –
      
      The location where trace information for this act is stored.
      - locationType (string) –
        
        The type of storage location for the trace data.
      - location (string) –
        
        The specific location where the trace data is stored.
- 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