Transfer / Paginator / ListExecutions

ListExecutions

class Transfer.Paginator.ListExecutions

paginator = client.get_paginator('list_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Transfer.Client.list_executions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• WorkflowId (string) –

  [REQUIRED]

  A unique identifier for the workflow.

• 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

{
    'WorkflowId': 'string',
    'Executions': [
        {
            'ExecutionId': 'string',
            'InitialFileLocation': {
                'S3FileLocation': {
                    'Bucket': 'string',
                    'Key': 'string',
                    'VersionId': 'string',
                    'Etag': 'string'
                },
                'EfsFileLocation': {
                    'FileSystemId': 'string',
                    'Path': 'string'
                }
            },
            'ServiceMetadata': {
                'UserDetails': {
                    'UserName': 'string',
                    'ServerId': 'string',
                    'SessionId': 'string'
                }
            },
            'Status': 'IN_PROGRESS'|'COMPLETED'|'EXCEPTION'|'HANDLING_EXCEPTION'
        },
    ]
}

Response Structure

• (dict) –

  • WorkflowId (string) –

    A unique identifier for the workflow.

  • Executions (list) –

    Returns the details for each execution, in a ListedExecution array.

    • (dict) –

      Returns properties of the execution that is specified.

      • ExecutionId (string) –

        A unique identifier for the execution of a workflow.

      • InitialFileLocation (dict) –

        A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

        • S3FileLocation (dict) –

          Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.

          • Bucket (string) –

            Specifies the S3 bucket that contains the file being used.

          • Key (string) –

            The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.

          • VersionId (string) –

            Specifies the file version.

          • Etag (string) –

            The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

        • EfsFileLocation (dict) –

          Specifies the Amazon EFS identifier and the path for the file being used.

          • FileSystemId (string) –

            The identifier of the file system, assigned by Amazon EFS.

          • Path (string) –

            The pathname for the folder being used by a workflow.

      • ServiceMetadata (dict) –

        A container object for the session details that are associated with a workflow.

        • UserDetails (dict) –

          The Server ID ( ServerId), Session ID ( SessionId) and user ( UserName) make up the UserDetails.

          • UserName (string) –

            A unique string that identifies a Transfer Family user associated with a server.

          • ServerId (string) –

            The system-assigned unique identifier for a Transfer server instance.

          • SessionId (string) –

            The system-assigned unique identifier for a session that corresponds to the workflow.

      • Status (string) –

        The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.