MWAAServerless / Client / list_workflow_versions

list_workflow_versions¶

MWAAServerless.Client.list_workflow_versions(**kwargs)¶

Lists all versions of a specified workflow, with optional pagination support.

Request Syntax

response = client.list_workflow_versions(
    MaxResults=123,
    NextToken='string',
    WorkflowArn='string'
)

Parameters:

MaxResults (integer) – The maximum number of workflow versions to return in a single response.
NextToken (string) – The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ListWorkflowVersions.
WorkflowArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the workflow for which you want to list versions.

Return type:

dict

Returns:

Response Syntax

{
    'WorkflowVersions': [
        {
            'WorkflowVersion': 'string',
            'WorkflowArn': 'string',
            'IsLatestVersion': True|False,
            'CreatedAt': datetime(2015, 1, 1),
            'ModifiedAt': datetime(2015, 1, 1),
            'DefinitionS3Location': {
                'Bucket': 'string',
                'ObjectKey': 'string',
                'VersionId': 'string'
            },
            'ScheduleConfiguration': {
                'CronExpression': 'string'
            },
            'TriggerMode': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- WorkflowVersions (list) –
  
  A list of workflow version summaries for the specified workflow.
  - (dict) –
    
    Summary information about a workflow version, including identification and configuration details.
    - WorkflowVersion (string) –
      
      The version identifier of the workflow version.
    - WorkflowArn (string) –
      
      The Amazon Resource Name (ARN) of the workflow that contains this version.
    - IsLatestVersion (boolean) –
      
      Boolean flag that indicates whether this is the latest version of the workflow.
    - CreatedAt (datetime) –
      
      The timestamp when the workflow version was created, in ISO 8601 date-time format.
    - ModifiedAt (datetime) –
      
      The timestamp when the workflow version was last modified, in ISO 8601 date-time format.
    - DefinitionS3Location (dict) –
      
      The Amazon S3 location of the workflow definition file for this version.
      - Bucket (string) –
        
        The name of the Amazon S3 bucket that contains the workflow definition file.
      - ObjectKey (string) –
        
        The key (name) of the workflow definition file within the S3 bucket.
      - VersionId (string) –
        
        Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.
    - ScheduleConfiguration (dict) –
      
      The schedule configuration for this workflow version.
      - CronExpression (string) –
        
        A cron expression that defines when the workflow is automatically executed. Uses standard cron syntax.
    - TriggerMode (string) –
      
      The trigger mode for the workflow execution.
- NextToken (string) –
  
  The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.

Exceptions

MWAAServerless.Client.exceptions.ThrottlingException
MWAAServerless.Client.exceptions.ValidationException
MWAAServerless.Client.exceptions.AccessDeniedException
MWAAServerless.Client.exceptions.InternalServerException
MWAAServerless.Client.exceptions.OperationTimeoutException