SupplyChain / Paginator / ListDataIntegrationFlowExecutions

ListDataIntegrationFlowExecutions

class SupplyChain.Paginator.ListDataIntegrationFlowExecutions

paginator = client.get_paginator('list_data_integration_flow_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SupplyChain.Client.list_data_integration_flow_executions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• instanceId (string) –

  [REQUIRED]

  The AWS Supply Chain instance identifier.

• flowName (string) –

  [REQUIRED]

  The flow name.

• 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

{
    'flowExecutions': [
        {
            'instanceId': 'string',
            'flowName': 'string',
            'executionId': 'string',
            'status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED',
            'sourceInfo': {
                'sourceType': 'S3'|'DATASET',
                's3Source': {
                    'bucketName': 'string',
                    'key': 'string'
                },
                'datasetSource': {
                    'datasetIdentifier': 'string'
                }
            },
            'message': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'outputMetadata': {
                'diagnosticReportsRootS3URI': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response parameters of ListFlowExecutions.

  • flowExecutions (list) –

    The list of flow executions.

    • (dict) –

      The flow execution details.

      • instanceId (string) –

        The flow execution’s instanceId.

      • flowName (string) –

        The flow execution’s flowName.

      • executionId (string) –

        The flow executionId.

      • status (string) –

        The status of flow execution.

      • sourceInfo (dict) –

        The source information for a flow execution.

        • sourceType (string) –

          The data integration flow execution source type.

        • s3Source (dict) –

          The source details of a flow execution with S3 source.

          • bucketName (string) –

            The S3 bucket name of the S3 source.

          • key (string) –

            The S3 object key of the S3 source.

        • datasetSource (dict) –

          The source details of a flow execution with dataset source.

          • datasetIdentifier (string) –

            The ARN of the dataset source.

      • message (string) –

        The failure message (if any) of failed flow execution.

      • startTime (datetime) –

        The flow execution start timestamp.

      • endTime (datetime) –

        The flow execution end timestamp.

      • outputMetadata (dict) –

        The flow execution output metadata.

        • diagnosticReportsRootS3URI (string) –

          The S3 URI under which all diagnostic files (such as deduped records if any) are stored.

  • NextToken (string) –

    A token to resume pagination.