NovaActService / Client / list_workflow_definitions

list_workflow_definitions¶

NovaActService.Client.list_workflow_definitions(**kwargs)¶

Lists all workflow definitions in your account with optional filtering and pagination.

Request Syntax

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

Parameters:

maxResults (integer) – The maximum number of workflow definitions 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 workflow definitions (ascending or descending).

Return type:

dict

Returns:

Response Syntax

{
    'workflowDefinitionSummaries': [
        {
            'workflowDefinitionArn': 'string',
            'workflowDefinitionName': 'string',
            'createdAt': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'DELETING'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- workflowDefinitionSummaries (list) –
  
  A list of summary information for workflow definitions.
  - (dict) –
    
    Summary information about a workflow definition, used in list operations.
    - workflowDefinitionArn (string) –
      
      The Amazon Resource Name (ARN) of the workflow definition.
    - workflowDefinitionName (string) –
      
      The name of the workflow definition.
    - createdAt (datetime) –
      
      The timestamp when the workflow definition was created.
    - status (string) –
      
      The current status of the workflow definition.
- nextToken (string) –
  
  The token for retrieving the next page of results, if available.

Exceptions

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