Skip to content

DataTransferApi

Source code in docs_src/capo_appflow/types/data_transfer_api.py 
12
13
14
15
16
17
18
class DataTransferApi(TypedDict, closed=True):
    name: NotRequired[
        "capo_appflow.types.data_transfer_api_type_name.DataTransferApiTypeName"
    ]
    """<p>The name of the connector application API.</p>"""
    type: NotRequired["capo_appflow.types.data_transfer_api_type.DataTransferApiType"]
    """<p>You can specify one of the following types:</p> <dl> <dt>AUTOMATIC</dt> <dd> <p>The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.</p> </dd> <dt>SYNC</dt> <dd> <p>A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.</p> </dd> <dt>ASYNC</dt> <dd> <p>An asynchronous API. This type of API optimizes a flow for large datasets.</p> </dd> </dl>"""

name instance-attribute 

name: NotRequired[DataTransferApiTypeName]

The name of the connector application API.

type instance-attribute 

type: NotRequired[DataTransferApiType]

You can specify one of the following types:

AUTOMATIC

The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.

SYNC

A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.

ASYNC

An asynchronous API. This type of API optimizes a flow for large datasets.