MWAAServerless / Paginator / ListWorkflowVersions

ListWorkflowVersions

class MWAAServerless.Paginator.ListWorkflowVersions

paginator = client.get_paginator('list_workflow_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MWAAServerless.Client.list_workflow_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    WorkflowArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• WorkflowArn (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  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.

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'
        },
    ],

}

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.