Skip to content

Type definitions#

Index > Appflow > Type definitions

Auto-generated documentation for Appflow type annotations stubs module mypy-boto3-appflow.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AggregationConfigTypeDef#

# AggregationConfigTypeDef definition

class AggregationConfigTypeDef(TypedDict):
    aggregationType: NotRequired[AggregationTypeType],  # (1)
    targetFileSize: NotRequired[int],
  1. See AggregationTypeType

AmplitudeConnectorProfileCredentialsTypeDef#

# AmplitudeConnectorProfileCredentialsTypeDef definition

class AmplitudeConnectorProfileCredentialsTypeDef(TypedDict):
    apiKey: str,
    secretKey: str,

AmplitudeSourcePropertiesTypeDef#

# AmplitudeSourcePropertiesTypeDef definition

class AmplitudeSourcePropertiesTypeDef(TypedDict):
    object: str,

ApiKeyCredentialsTypeDef#

# ApiKeyCredentialsTypeDef definition

class ApiKeyCredentialsTypeDef(TypedDict):
    apiKey: str,
    apiSecretKey: NotRequired[str],

AuthParameterTypeDef#

# AuthParameterTypeDef definition

class AuthParameterTypeDef(TypedDict):
    key: NotRequired[str],
    isRequired: NotRequired[bool],
    label: NotRequired[str],
    description: NotRequired[str],
    isSensitiveField: NotRequired[bool],
    connectorSuppliedValues: NotRequired[List[str]],

BasicAuthCredentialsTypeDef#

# BasicAuthCredentialsTypeDef definition

class BasicAuthCredentialsTypeDef(TypedDict):
    username: str,
    password: str,

CancelFlowExecutionsRequestRequestTypeDef#

# CancelFlowExecutionsRequestRequestTypeDef definition

class CancelFlowExecutionsRequestRequestTypeDef(TypedDict):
    flowName: str,
    executionIds: NotRequired[Sequence[str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ConnectorRuntimeSettingTypeDef#

# ConnectorRuntimeSettingTypeDef definition

class ConnectorRuntimeSettingTypeDef(TypedDict):
    key: NotRequired[str],
    dataType: NotRequired[str],
    isRequired: NotRequired[bool],
    label: NotRequired[str],
    description: NotRequired[str],
    scope: NotRequired[str],
    connectorSuppliedValueOptions: NotRequired[List[str]],

DataTransferApiTypeDef#

# DataTransferApiTypeDef definition

class DataTransferApiTypeDef(TypedDict):
    Name: NotRequired[str],
    Type: NotRequired[DataTransferApiTypeType],  # (1)
  1. See DataTransferApiTypeType

ConnectorDetailTypeDef#

# ConnectorDetailTypeDef definition

class ConnectorDetailTypeDef(TypedDict):
    connectorDescription: NotRequired[str],
    connectorName: NotRequired[str],
    connectorOwner: NotRequired[str],
    connectorVersion: NotRequired[str],
    applicationType: NotRequired[str],
    connectorType: NotRequired[ConnectorTypeType],  # (1)
    connectorLabel: NotRequired[str],
    registeredAt: NotRequired[datetime],
    registeredBy: NotRequired[str],
    connectorProvisioningType: NotRequired[ConnectorProvisioningTypeType],  # (2)
    connectorModes: NotRequired[List[str]],
    supportedDataTransferTypes: NotRequired[List[SupportedDataTransferTypeType]],  # (3)
  1. See ConnectorTypeType
  2. See ConnectorProvisioningTypeType
  3. See SupportedDataTransferTypeType

DestinationFieldPropertiesTypeDef#

# DestinationFieldPropertiesTypeDef definition

class DestinationFieldPropertiesTypeDef(TypedDict):
    isCreatable: NotRequired[bool],
    isNullable: NotRequired[bool],
    isUpsertable: NotRequired[bool],
    isUpdatable: NotRequired[bool],
    isDefaultedOnCreate: NotRequired[bool],
    supportedWriteOperations: NotRequired[List[WriteOperationTypeType]],  # (1)
  1. See WriteOperationTypeType

SourceFieldPropertiesTypeDef#

# SourceFieldPropertiesTypeDef definition

class SourceFieldPropertiesTypeDef(TypedDict):
    isRetrievable: NotRequired[bool],
    isQueryable: NotRequired[bool],
    isTimestampFieldForIncrementalQueries: NotRequired[bool],

ConnectorEntityTypeDef#

# ConnectorEntityTypeDef definition

class ConnectorEntityTypeDef(TypedDict):
    name: str,
    label: NotRequired[str],
    hasNestedEntities: NotRequired[bool],

GoogleAnalyticsMetadataTypeDef#

# GoogleAnalyticsMetadataTypeDef definition

class GoogleAnalyticsMetadataTypeDef(TypedDict):
    oAuthScopes: NotRequired[List[str]],

HoneycodeMetadataTypeDef#

# HoneycodeMetadataTypeDef definition

class HoneycodeMetadataTypeDef(TypedDict):
    oAuthScopes: NotRequired[List[str]],

SalesforceMetadataTypeDef#

# SalesforceMetadataTypeDef definition

class SalesforceMetadataTypeDef(TypedDict):
    oAuthScopes: NotRequired[List[str]],
    dataTransferApis: NotRequired[List[SalesforceDataTransferApiType]],  # (1)
    oauth2GrantTypesSupported: NotRequired[List[OAuth2GrantTypeType]],  # (2)
  1. See SalesforceDataTransferApiType
  2. See OAuth2GrantTypeType

SlackMetadataTypeDef#

# SlackMetadataTypeDef definition

class SlackMetadataTypeDef(TypedDict):
    oAuthScopes: NotRequired[List[str]],

SnowflakeMetadataTypeDef#

# SnowflakeMetadataTypeDef definition

class SnowflakeMetadataTypeDef(TypedDict):
    supportedRegions: NotRequired[List[str]],

ZendeskMetadataTypeDef#

# ZendeskMetadataTypeDef definition

class ZendeskMetadataTypeDef(TypedDict):
    oAuthScopes: NotRequired[List[str]],

ConnectorOAuthRequestTypeDef#

# ConnectorOAuthRequestTypeDef definition

class ConnectorOAuthRequestTypeDef(TypedDict):
    authCode: NotRequired[str],
    redirectUri: NotRequired[str],

ConnectorOperatorTypeDef#

# ConnectorOperatorTypeDef definition

class ConnectorOperatorTypeDef(TypedDict):
    Amplitude: NotRequired[AmplitudeConnectorOperatorType],  # (1)
    Datadog: NotRequired[DatadogConnectorOperatorType],  # (2)
    Dynatrace: NotRequired[DynatraceConnectorOperatorType],  # (3)
    GoogleAnalytics: NotRequired[GoogleAnalyticsConnectorOperatorType],  # (4)
    InforNexus: NotRequired[InforNexusConnectorOperatorType],  # (5)
    Marketo: NotRequired[MarketoConnectorOperatorType],  # (6)
    S3: NotRequired[S3ConnectorOperatorType],  # (7)
    Salesforce: NotRequired[SalesforceConnectorOperatorType],  # (8)
    ServiceNow: NotRequired[ServiceNowConnectorOperatorType],  # (9)
    Singular: NotRequired[SingularConnectorOperatorType],  # (10)
    Slack: NotRequired[SlackConnectorOperatorType],  # (11)
    Trendmicro: NotRequired[TrendmicroConnectorOperatorType],  # (12)
    Veeva: NotRequired[VeevaConnectorOperatorType],  # (13)
    Zendesk: NotRequired[ZendeskConnectorOperatorType],  # (14)
    SAPOData: NotRequired[SAPODataConnectorOperatorType],  # (15)
    CustomConnector: NotRequired[OperatorType],  # (16)
    Pardot: NotRequired[PardotConnectorOperatorType],  # (17)
  1. See AmplitudeConnectorOperatorType
  2. See DatadogConnectorOperatorType
  3. See DynatraceConnectorOperatorType
  4. See GoogleAnalyticsConnectorOperatorType
  5. See InforNexusConnectorOperatorType
  6. See MarketoConnectorOperatorType
  7. See S3ConnectorOperatorType
  8. See SalesforceConnectorOperatorType
  9. See ServiceNowConnectorOperatorType
  10. See SingularConnectorOperatorType
  11. See SlackConnectorOperatorType
  12. See TrendmicroConnectorOperatorType
  13. See VeevaConnectorOperatorType
  14. See ZendeskConnectorOperatorType
  15. See SAPODataConnectorOperatorType
  16. See OperatorType
  17. See PardotConnectorOperatorType

DatadogConnectorProfileCredentialsTypeDef#

# DatadogConnectorProfileCredentialsTypeDef definition

class DatadogConnectorProfileCredentialsTypeDef(TypedDict):
    apiKey: str,
    applicationKey: str,

DynatraceConnectorProfileCredentialsTypeDef#

# DynatraceConnectorProfileCredentialsTypeDef definition

class DynatraceConnectorProfileCredentialsTypeDef(TypedDict):
    apiToken: str,

InforNexusConnectorProfileCredentialsTypeDef#

# InforNexusConnectorProfileCredentialsTypeDef definition

class InforNexusConnectorProfileCredentialsTypeDef(TypedDict):
    accessKeyId: str,
    userId: str,
    secretAccessKey: str,
    datakey: str,

RedshiftConnectorProfileCredentialsTypeDef#

# RedshiftConnectorProfileCredentialsTypeDef definition

class RedshiftConnectorProfileCredentialsTypeDef(TypedDict):
    username: NotRequired[str],
    password: NotRequired[str],

SingularConnectorProfileCredentialsTypeDef#

# SingularConnectorProfileCredentialsTypeDef definition

class SingularConnectorProfileCredentialsTypeDef(TypedDict):
    apiKey: str,

SnowflakeConnectorProfileCredentialsTypeDef#

# SnowflakeConnectorProfileCredentialsTypeDef definition

class SnowflakeConnectorProfileCredentialsTypeDef(TypedDict):
    username: str,
    password: str,

TrendmicroConnectorProfileCredentialsTypeDef#

# TrendmicroConnectorProfileCredentialsTypeDef definition

class TrendmicroConnectorProfileCredentialsTypeDef(TypedDict):
    apiSecretKey: str,

VeevaConnectorProfileCredentialsTypeDef#

# VeevaConnectorProfileCredentialsTypeDef definition

class VeevaConnectorProfileCredentialsTypeDef(TypedDict):
    username: str,
    password: str,

DatadogConnectorProfilePropertiesTypeDef#

# DatadogConnectorProfilePropertiesTypeDef definition

class DatadogConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

DynatraceConnectorProfilePropertiesTypeDef#

# DynatraceConnectorProfilePropertiesTypeDef definition

class DynatraceConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

InforNexusConnectorProfilePropertiesTypeDef#

# InforNexusConnectorProfilePropertiesTypeDef definition

class InforNexusConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

MarketoConnectorProfilePropertiesTypeDef#

# MarketoConnectorProfilePropertiesTypeDef definition

class MarketoConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

PardotConnectorProfilePropertiesTypeDef#

# PardotConnectorProfilePropertiesTypeDef definition

class PardotConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: NotRequired[str],
    isSandboxEnvironment: NotRequired[bool],
    businessUnitId: NotRequired[str],

RedshiftConnectorProfilePropertiesTypeDef#

# RedshiftConnectorProfilePropertiesTypeDef definition

class RedshiftConnectorProfilePropertiesTypeDef(TypedDict):
    bucketName: str,
    roleArn: str,
    databaseUrl: NotRequired[str],
    bucketPrefix: NotRequired[str],
    dataApiRoleArn: NotRequired[str],
    isRedshiftServerless: NotRequired[bool],
    clusterIdentifier: NotRequired[str],
    workgroupName: NotRequired[str],
    databaseName: NotRequired[str],

SalesforceConnectorProfilePropertiesTypeDef#

# SalesforceConnectorProfilePropertiesTypeDef definition

class SalesforceConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: NotRequired[str],
    isSandboxEnvironment: NotRequired[bool],
    usePrivateLinkForMetadataAndAuthorization: NotRequired[bool],

ServiceNowConnectorProfilePropertiesTypeDef#

# ServiceNowConnectorProfilePropertiesTypeDef definition

class ServiceNowConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

SlackConnectorProfilePropertiesTypeDef#

# SlackConnectorProfilePropertiesTypeDef definition

class SlackConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

SnowflakeConnectorProfilePropertiesTypeDef#

# SnowflakeConnectorProfilePropertiesTypeDef definition

class SnowflakeConnectorProfilePropertiesTypeDef(TypedDict):
    warehouse: str,
    stage: str,
    bucketName: str,
    bucketPrefix: NotRequired[str],
    privateLinkServiceName: NotRequired[str],
    accountName: NotRequired[str],
    region: NotRequired[str],

VeevaConnectorProfilePropertiesTypeDef#

# VeevaConnectorProfilePropertiesTypeDef definition

class VeevaConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

ZendeskConnectorProfilePropertiesTypeDef#

# ZendeskConnectorProfilePropertiesTypeDef definition

class ZendeskConnectorProfilePropertiesTypeDef(TypedDict):
    instanceUrl: str,

PrivateConnectionProvisioningStateTypeDef#

# PrivateConnectionProvisioningStateTypeDef definition

class PrivateConnectionProvisioningStateTypeDef(TypedDict):
    status: NotRequired[PrivateConnectionProvisioningStatusType],  # (1)
    failureMessage: NotRequired[str],
    failureCause: NotRequired[PrivateConnectionProvisioningFailureCauseType],  # (2)
  1. See PrivateConnectionProvisioningStatusType
  2. See PrivateConnectionProvisioningFailureCauseType

LambdaConnectorProvisioningConfigTypeDef#

# LambdaConnectorProvisioningConfigTypeDef definition

class LambdaConnectorProvisioningConfigTypeDef(TypedDict):
    lambdaArn: str,

CustomAuthCredentialsTypeDef#

# CustomAuthCredentialsTypeDef definition

class CustomAuthCredentialsTypeDef(TypedDict):
    customAuthenticationType: str,
    credentialsMap: NotRequired[Mapping[str, str]],

ErrorHandlingConfigTypeDef#

# ErrorHandlingConfigTypeDef definition

class ErrorHandlingConfigTypeDef(TypedDict):
    failOnFirstDestinationError: NotRequired[bool],
    bucketPrefix: NotRequired[str],
    bucketName: NotRequired[str],

OAuth2PropertiesTypeDef#

# OAuth2PropertiesTypeDef definition

class OAuth2PropertiesTypeDef(TypedDict):
    tokenUrl: str,
    oAuth2GrantType: OAuth2GrantTypeType,  # (1)
    tokenUrlCustomProperties: NotRequired[Mapping[str, str]],
  1. See OAuth2GrantTypeType

CustomerProfilesDestinationPropertiesTypeDef#

# CustomerProfilesDestinationPropertiesTypeDef definition

class CustomerProfilesDestinationPropertiesTypeDef(TypedDict):
    domainName: str,
    objectTypeName: NotRequired[str],

DatadogSourcePropertiesTypeDef#

# DatadogSourcePropertiesTypeDef definition

class DatadogSourcePropertiesTypeDef(TypedDict):
    object: str,

DeleteConnectorProfileRequestRequestTypeDef#

# DeleteConnectorProfileRequestRequestTypeDef definition

class DeleteConnectorProfileRequestRequestTypeDef(TypedDict):
    connectorProfileName: str,
    forceDelete: NotRequired[bool],

DeleteFlowRequestRequestTypeDef#

# DeleteFlowRequestRequestTypeDef definition

class DeleteFlowRequestRequestTypeDef(TypedDict):
    flowName: str,
    forceDelete: NotRequired[bool],

DescribeConnectorEntityRequestRequestTypeDef#

# DescribeConnectorEntityRequestRequestTypeDef definition

class DescribeConnectorEntityRequestRequestTypeDef(TypedDict):
    connectorEntityName: str,
    connectorType: NotRequired[ConnectorTypeType],  # (1)
    connectorProfileName: NotRequired[str],
    apiVersion: NotRequired[str],
  1. See ConnectorTypeType

DescribeConnectorProfilesRequestRequestTypeDef#

# DescribeConnectorProfilesRequestRequestTypeDef definition

class DescribeConnectorProfilesRequestRequestTypeDef(TypedDict):
    connectorProfileNames: NotRequired[Sequence[str]],
    connectorType: NotRequired[ConnectorTypeType],  # (1)
    connectorLabel: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See ConnectorTypeType

DescribeConnectorRequestRequestTypeDef#

# DescribeConnectorRequestRequestTypeDef definition

class DescribeConnectorRequestRequestTypeDef(TypedDict):
    connectorType: ConnectorTypeType,  # (1)
    connectorLabel: NotRequired[str],
  1. See ConnectorTypeType

DescribeConnectorsRequestRequestTypeDef#

# DescribeConnectorsRequestRequestTypeDef definition

class DescribeConnectorsRequestRequestTypeDef(TypedDict):
    connectorTypes: NotRequired[Sequence[ConnectorTypeType]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See ConnectorTypeType

DescribeFlowExecutionRecordsRequestRequestTypeDef#

# DescribeFlowExecutionRecordsRequestRequestTypeDef definition

class DescribeFlowExecutionRecordsRequestRequestTypeDef(TypedDict):
    flowName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

DescribeFlowRequestRequestTypeDef#

# DescribeFlowRequestRequestTypeDef definition

class DescribeFlowRequestRequestTypeDef(TypedDict):
    flowName: str,

ExecutionDetailsTypeDef#

# ExecutionDetailsTypeDef definition

class ExecutionDetailsTypeDef(TypedDict):
    mostRecentExecutionMessage: NotRequired[str],
    mostRecentExecutionTime: NotRequired[datetime],
    mostRecentExecutionStatus: NotRequired[ExecutionStatusType],  # (1)
  1. See ExecutionStatusType

DynatraceSourcePropertiesTypeDef#

# DynatraceSourcePropertiesTypeDef definition

class DynatraceSourcePropertiesTypeDef(TypedDict):
    object: str,

ErrorInfoTypeDef#

# ErrorInfoTypeDef definition

class ErrorInfoTypeDef(TypedDict):
    putFailuresCount: NotRequired[int],
    executionMessage: NotRequired[str],

RangeTypeDef#

# RangeTypeDef definition

class RangeTypeDef(TypedDict):
    maximum: NotRequired[float],
    minimum: NotRequired[float],

GlueDataCatalogConfigTypeDef#

# GlueDataCatalogConfigTypeDef definition

class GlueDataCatalogConfigTypeDef(TypedDict):
    roleArn: str,
    databaseName: str,
    tablePrefix: str,

GoogleAnalyticsSourcePropertiesTypeDef#

# GoogleAnalyticsSourcePropertiesTypeDef definition

class GoogleAnalyticsSourcePropertiesTypeDef(TypedDict):
    object: str,

IncrementalPullConfigTypeDef#

# IncrementalPullConfigTypeDef definition

class IncrementalPullConfigTypeDef(TypedDict):
    datetimeTypeFieldName: NotRequired[str],

InforNexusSourcePropertiesTypeDef#

# InforNexusSourcePropertiesTypeDef definition

class InforNexusSourcePropertiesTypeDef(TypedDict):
    object: str,

ListConnectorEntitiesRequestRequestTypeDef#

# ListConnectorEntitiesRequestRequestTypeDef definition

class ListConnectorEntitiesRequestRequestTypeDef(TypedDict):
    connectorProfileName: NotRequired[str],
    connectorType: NotRequired[ConnectorTypeType],  # (1)
    entitiesPath: NotRequired[str],
    apiVersion: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See ConnectorTypeType

ListConnectorsRequestRequestTypeDef#

# ListConnectorsRequestRequestTypeDef definition

class ListConnectorsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListFlowsRequestRequestTypeDef#

# ListFlowsRequestRequestTypeDef definition

class ListFlowsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

MarketoSourcePropertiesTypeDef#

# MarketoSourcePropertiesTypeDef definition

class MarketoSourcePropertiesTypeDef(TypedDict):
    object: str,

RegistrationOutputTypeDef#

# RegistrationOutputTypeDef definition

class RegistrationOutputTypeDef(TypedDict):
    message: NotRequired[str],
    result: NotRequired[str],
    status: NotRequired[ExecutionStatusType],  # (1)
  1. See ExecutionStatusType

OAuth2CustomParameterTypeDef#

# OAuth2CustomParameterTypeDef definition

class OAuth2CustomParameterTypeDef(TypedDict):
    key: NotRequired[str],
    isRequired: NotRequired[bool],
    label: NotRequired[str],
    description: NotRequired[str],
    isSensitiveField: NotRequired[bool],
    connectorSuppliedValues: NotRequired[List[str]],
    type: NotRequired[OAuth2CustomPropTypeType],  # (1)
  1. See OAuth2CustomPropTypeType

OAuthPropertiesTypeDef#

# OAuthPropertiesTypeDef definition

class OAuthPropertiesTypeDef(TypedDict):
    tokenUrl: str,
    authCodeUrl: str,
    oAuthScopes: Sequence[str],

PardotSourcePropertiesTypeDef#

# PardotSourcePropertiesTypeDef definition

class PardotSourcePropertiesTypeDef(TypedDict):
    object: str,

PrefixConfigTypeDef#

# PrefixConfigTypeDef definition

class PrefixConfigTypeDef(TypedDict):
    prefixType: NotRequired[PrefixTypeType],  # (1)
    prefixFormat: NotRequired[PrefixFormatType],  # (2)
    pathPrefixHierarchy: NotRequired[Sequence[PathPrefixType]],  # (3)
  1. See PrefixTypeType
  2. See PrefixFormatType
  3. See PathPrefixType

ResetConnectorMetadataCacheRequestRequestTypeDef#

# ResetConnectorMetadataCacheRequestRequestTypeDef definition

class ResetConnectorMetadataCacheRequestRequestTypeDef(TypedDict):
    connectorProfileName: NotRequired[str],
    connectorType: NotRequired[ConnectorTypeType],  # (1)
    connectorEntityName: NotRequired[str],
    entitiesPath: NotRequired[str],
    apiVersion: NotRequired[str],
  1. See ConnectorTypeType

S3InputFormatConfigTypeDef#

# S3InputFormatConfigTypeDef definition

class S3InputFormatConfigTypeDef(TypedDict):
    s3InputFileType: NotRequired[S3InputFileTypeType],  # (1)
  1. See S3InputFileTypeType

SuccessResponseHandlingConfigTypeDef#

# SuccessResponseHandlingConfigTypeDef definition

class SuccessResponseHandlingConfigTypeDef(TypedDict):
    bucketPrefix: NotRequired[str],
    bucketName: NotRequired[str],

SAPODataPaginationConfigTypeDef#

# SAPODataPaginationConfigTypeDef definition

class SAPODataPaginationConfigTypeDef(TypedDict):
    maxPageSize: int,

SAPODataParallelismConfigTypeDef#

# SAPODataParallelismConfigTypeDef definition

class SAPODataParallelismConfigTypeDef(TypedDict):
    maxParallelism: int,

SalesforceSourcePropertiesTypeDef#

# SalesforceSourcePropertiesTypeDef definition

class SalesforceSourcePropertiesTypeDef(TypedDict):
    object: str,
    enableDynamicFieldUpdate: NotRequired[bool],
    includeDeletedRecords: NotRequired[bool],
    dataTransferApi: NotRequired[SalesforceDataTransferApiType],  # (1)
  1. See SalesforceDataTransferApiType

ServiceNowSourcePropertiesTypeDef#

# ServiceNowSourcePropertiesTypeDef definition

class ServiceNowSourcePropertiesTypeDef(TypedDict):
    object: str,

SingularSourcePropertiesTypeDef#

# SingularSourcePropertiesTypeDef definition

class SingularSourcePropertiesTypeDef(TypedDict):
    object: str,

SlackSourcePropertiesTypeDef#

# SlackSourcePropertiesTypeDef definition

class SlackSourcePropertiesTypeDef(TypedDict):
    object: str,

TrendmicroSourcePropertiesTypeDef#

# TrendmicroSourcePropertiesTypeDef definition

class TrendmicroSourcePropertiesTypeDef(TypedDict):
    object: str,

VeevaSourcePropertiesTypeDef#

# VeevaSourcePropertiesTypeDef definition

class VeevaSourcePropertiesTypeDef(TypedDict):
    object: str,
    documentType: NotRequired[str],
    includeSourceFiles: NotRequired[bool],
    includeRenditions: NotRequired[bool],
    includeAllVersions: NotRequired[bool],

ZendeskSourcePropertiesTypeDef#

# ZendeskSourcePropertiesTypeDef definition

class ZendeskSourcePropertiesTypeDef(TypedDict):
    object: str,

StartFlowRequestRequestTypeDef#

# StartFlowRequestRequestTypeDef definition

class StartFlowRequestRequestTypeDef(TypedDict):
    flowName: str,
    clientToken: NotRequired[str],

StopFlowRequestRequestTypeDef#

# StopFlowRequestRequestTypeDef definition

class StopFlowRequestRequestTypeDef(TypedDict):
    flowName: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UnregisterConnectorRequestRequestTypeDef#

# UnregisterConnectorRequestRequestTypeDef definition

class UnregisterConnectorRequestRequestTypeDef(TypedDict):
    connectorLabel: str,
    forceDelete: NotRequired[bool],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

CustomAuthConfigTypeDef#

# CustomAuthConfigTypeDef definition

class CustomAuthConfigTypeDef(TypedDict):
    customAuthenticationType: NotRequired[str],
    authParameters: NotRequired[List[AuthParameterTypeDef]],  # (1)
  1. See AuthParameterTypeDef

CancelFlowExecutionsResponseTypeDef#

# CancelFlowExecutionsResponseTypeDef definition

class CancelFlowExecutionsResponseTypeDef(TypedDict):
    invalidExecutions: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateConnectorProfileResponseTypeDef#

# CreateConnectorProfileResponseTypeDef definition

class CreateConnectorProfileResponseTypeDef(TypedDict):
    connectorProfileArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateFlowResponseTypeDef#

# CreateFlowResponseTypeDef definition

class CreateFlowResponseTypeDef(TypedDict):
    flowArn: str,
    flowStatus: FlowStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterConnectorResponseTypeDef#

# RegisterConnectorResponseTypeDef definition

class RegisterConnectorResponseTypeDef(TypedDict):
    connectorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartFlowResponseTypeDef#

# StartFlowResponseTypeDef definition

class StartFlowResponseTypeDef(TypedDict):
    flowArn: str,
    flowStatus: FlowStatusType,  # (1)
    executionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowStatusType
  2. See ResponseMetadataTypeDef

StopFlowResponseTypeDef#

# StopFlowResponseTypeDef definition

class StopFlowResponseTypeDef(TypedDict):
    flowArn: str,
    flowStatus: FlowStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowStatusType
  2. See ResponseMetadataTypeDef

UpdateConnectorProfileResponseTypeDef#

# UpdateConnectorProfileResponseTypeDef definition

class UpdateConnectorProfileResponseTypeDef(TypedDict):
    connectorProfileArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateConnectorRegistrationResponseTypeDef#

# UpdateConnectorRegistrationResponseTypeDef definition

class UpdateConnectorRegistrationResponseTypeDef(TypedDict):
    connectorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateFlowResponseTypeDef#

# UpdateFlowResponseTypeDef definition

class UpdateFlowResponseTypeDef(TypedDict):
    flowStatus: FlowStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowStatusType
  2. See ResponseMetadataTypeDef

CustomConnectorSourcePropertiesTypeDef#

# CustomConnectorSourcePropertiesTypeDef definition

class CustomConnectorSourcePropertiesTypeDef(TypedDict):
    entityName: str,
    customProperties: NotRequired[Mapping[str, str]],
    dataTransferApi: NotRequired[DataTransferApiTypeDef],  # (1)
  1. See DataTransferApiTypeDef

ListConnectorsResponseTypeDef#

# ListConnectorsResponseTypeDef definition

class ListConnectorsResponseTypeDef(TypedDict):
    connectors: List[ConnectorDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorDetailTypeDef
  2. See ResponseMetadataTypeDef

ListConnectorEntitiesResponseTypeDef#

# ListConnectorEntitiesResponseTypeDef definition

class ListConnectorEntitiesResponseTypeDef(TypedDict):
    connectorEntityMap: Dict[str, List[ConnectorEntityTypeDef]],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorEntityTypeDef
  2. See ResponseMetadataTypeDef

ConnectorMetadataTypeDef#

# ConnectorMetadataTypeDef definition

class ConnectorMetadataTypeDef(TypedDict):
    Amplitude: NotRequired[Dict[str, Any]],
    Datadog: NotRequired[Dict[str, Any]],
    Dynatrace: NotRequired[Dict[str, Any]],
    GoogleAnalytics: NotRequired[GoogleAnalyticsMetadataTypeDef],  # (1)
    InforNexus: NotRequired[Dict[str, Any]],
    Marketo: NotRequired[Dict[str, Any]],
    Redshift: NotRequired[Dict[str, Any]],
    S3: NotRequired[Dict[str, Any]],
    Salesforce: NotRequired[SalesforceMetadataTypeDef],  # (2)
    ServiceNow: NotRequired[Dict[str, Any]],
    Singular: NotRequired[Dict[str, Any]],
    Slack: NotRequired[SlackMetadataTypeDef],  # (3)
    Snowflake: NotRequired[SnowflakeMetadataTypeDef],  # (4)
    Trendmicro: NotRequired[Dict[str, Any]],
    Veeva: NotRequired[Dict[str, Any]],
    Zendesk: NotRequired[ZendeskMetadataTypeDef],  # (5)
    EventBridge: NotRequired[Dict[str, Any]],
    Upsolver: NotRequired[Dict[str, Any]],
    CustomerProfiles: NotRequired[Dict[str, Any]],
    Honeycode: NotRequired[HoneycodeMetadataTypeDef],  # (6)
    SAPOData: NotRequired[Dict[str, Any]],
    Pardot: NotRequired[Dict[str, Any]],
  1. See GoogleAnalyticsMetadataTypeDef
  2. See SalesforceMetadataTypeDef
  3. See SlackMetadataTypeDef
  4. See SnowflakeMetadataTypeDef
  5. See ZendeskMetadataTypeDef
  6. See HoneycodeMetadataTypeDef

GoogleAnalyticsConnectorProfileCredentialsTypeDef#

# GoogleAnalyticsConnectorProfileCredentialsTypeDef definition

class GoogleAnalyticsConnectorProfileCredentialsTypeDef(TypedDict):
    clientId: str,
    clientSecret: str,
    accessToken: NotRequired[str],
    refreshToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
  1. See ConnectorOAuthRequestTypeDef

HoneycodeConnectorProfileCredentialsTypeDef#

# HoneycodeConnectorProfileCredentialsTypeDef definition

class HoneycodeConnectorProfileCredentialsTypeDef(TypedDict):
    accessToken: NotRequired[str],
    refreshToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
  1. See ConnectorOAuthRequestTypeDef

MarketoConnectorProfileCredentialsTypeDef#

# MarketoConnectorProfileCredentialsTypeDef definition

class MarketoConnectorProfileCredentialsTypeDef(TypedDict):
    clientId: str,
    clientSecret: str,
    accessToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
  1. See ConnectorOAuthRequestTypeDef

OAuth2CredentialsTypeDef#

# OAuth2CredentialsTypeDef definition

class OAuth2CredentialsTypeDef(TypedDict):
    clientId: NotRequired[str],
    clientSecret: NotRequired[str],
    accessToken: NotRequired[str],
    refreshToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
  1. See ConnectorOAuthRequestTypeDef

OAuthCredentialsTypeDef#

# OAuthCredentialsTypeDef definition

class OAuthCredentialsTypeDef(TypedDict):
    clientId: str,
    clientSecret: str,
    accessToken: NotRequired[str],
    refreshToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
  1. See ConnectorOAuthRequestTypeDef

PardotConnectorProfileCredentialsTypeDef#

# PardotConnectorProfileCredentialsTypeDef definition

class PardotConnectorProfileCredentialsTypeDef(TypedDict):
    accessToken: NotRequired[str],
    refreshToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
    clientCredentialsArn: NotRequired[str],
  1. See ConnectorOAuthRequestTypeDef

SalesforceConnectorProfileCredentialsTypeDef#

# SalesforceConnectorProfileCredentialsTypeDef definition

class SalesforceConnectorProfileCredentialsTypeDef(TypedDict):
    accessToken: NotRequired[str],
    refreshToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
    clientCredentialsArn: NotRequired[str],
    oAuth2GrantType: NotRequired[OAuth2GrantTypeType],  # (2)
    jwtToken: NotRequired[str],
  1. See ConnectorOAuthRequestTypeDef
  2. See OAuth2GrantTypeType

SlackConnectorProfileCredentialsTypeDef#

# SlackConnectorProfileCredentialsTypeDef definition

class SlackConnectorProfileCredentialsTypeDef(TypedDict):
    clientId: str,
    clientSecret: str,
    accessToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
  1. See ConnectorOAuthRequestTypeDef

ZendeskConnectorProfileCredentialsTypeDef#

# ZendeskConnectorProfileCredentialsTypeDef definition

class ZendeskConnectorProfileCredentialsTypeDef(TypedDict):
    clientId: str,
    clientSecret: str,
    accessToken: NotRequired[str],
    oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef],  # (1)
  1. See ConnectorOAuthRequestTypeDef

TaskTypeDef#

# TaskTypeDef definition

class TaskTypeDef(TypedDict):
    sourceFields: Sequence[str],
    taskType: TaskTypeType,  # (2)
    connectorOperator: NotRequired[ConnectorOperatorTypeDef],  # (1)
    destinationField: NotRequired[str],
    taskProperties: NotRequired[Mapping[OperatorPropertiesKeysType, str]],  # (3)
  1. See ConnectorOperatorTypeDef
  2. See TaskTypeType
  3. See OperatorPropertiesKeysType

ConnectorProvisioningConfigTypeDef#

# ConnectorProvisioningConfigTypeDef definition

class ConnectorProvisioningConfigTypeDef(TypedDict):
    lambda: NotRequired[LambdaConnectorProvisioningConfigTypeDef],  # (1)
  1. See LambdaConnectorProvisioningConfigTypeDef

CustomConnectorDestinationPropertiesTypeDef#

# CustomConnectorDestinationPropertiesTypeDef definition

class CustomConnectorDestinationPropertiesTypeDef(TypedDict):
    entityName: str,
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
    writeOperationType: NotRequired[WriteOperationTypeType],  # (2)
    idFieldNames: NotRequired[Sequence[str]],
    customProperties: NotRequired[Mapping[str, str]],
  1. See ErrorHandlingConfigTypeDef
  2. See WriteOperationTypeType

EventBridgeDestinationPropertiesTypeDef#

# EventBridgeDestinationPropertiesTypeDef definition

class EventBridgeDestinationPropertiesTypeDef(TypedDict):
    object: str,
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
  1. See ErrorHandlingConfigTypeDef

HoneycodeDestinationPropertiesTypeDef#

# HoneycodeDestinationPropertiesTypeDef definition

class HoneycodeDestinationPropertiesTypeDef(TypedDict):
    object: str,
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
  1. See ErrorHandlingConfigTypeDef

MarketoDestinationPropertiesTypeDef#

# MarketoDestinationPropertiesTypeDef definition

class MarketoDestinationPropertiesTypeDef(TypedDict):
    object: str,
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
  1. See ErrorHandlingConfigTypeDef

RedshiftDestinationPropertiesTypeDef#

# RedshiftDestinationPropertiesTypeDef definition

class RedshiftDestinationPropertiesTypeDef(TypedDict):
    object: str,
    intermediateBucketName: str,
    bucketPrefix: NotRequired[str],
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
  1. See ErrorHandlingConfigTypeDef

SalesforceDestinationPropertiesTypeDef#

# SalesforceDestinationPropertiesTypeDef definition

class SalesforceDestinationPropertiesTypeDef(TypedDict):
    object: str,
    idFieldNames: NotRequired[Sequence[str]],
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
    writeOperationType: NotRequired[WriteOperationTypeType],  # (2)
    dataTransferApi: NotRequired[SalesforceDataTransferApiType],  # (3)
  1. See ErrorHandlingConfigTypeDef
  2. See WriteOperationTypeType
  3. See SalesforceDataTransferApiType

SnowflakeDestinationPropertiesTypeDef#

# SnowflakeDestinationPropertiesTypeDef definition

class SnowflakeDestinationPropertiesTypeDef(TypedDict):
    object: str,
    intermediateBucketName: str,
    bucketPrefix: NotRequired[str],
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
  1. See ErrorHandlingConfigTypeDef

ZendeskDestinationPropertiesTypeDef#

# ZendeskDestinationPropertiesTypeDef definition

class ZendeskDestinationPropertiesTypeDef(TypedDict):
    object: str,
    idFieldNames: NotRequired[Sequence[str]],
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (1)
    writeOperationType: NotRequired[WriteOperationTypeType],  # (2)
  1. See ErrorHandlingConfigTypeDef
  2. See WriteOperationTypeType

CustomConnectorProfilePropertiesTypeDef#

# CustomConnectorProfilePropertiesTypeDef definition

class CustomConnectorProfilePropertiesTypeDef(TypedDict):
    profileProperties: NotRequired[Mapping[str, str]],
    oAuth2Properties: NotRequired[OAuth2PropertiesTypeDef],  # (1)
  1. See OAuth2PropertiesTypeDef

FlowDefinitionTypeDef#

# FlowDefinitionTypeDef definition

class FlowDefinitionTypeDef(TypedDict):
    flowArn: NotRequired[str],
    description: NotRequired[str],
    flowName: NotRequired[str],
    flowStatus: NotRequired[FlowStatusType],  # (1)
    sourceConnectorType: NotRequired[ConnectorTypeType],  # (2)
    sourceConnectorLabel: NotRequired[str],
    destinationConnectorType: NotRequired[ConnectorTypeType],  # (2)
    destinationConnectorLabel: NotRequired[str],
    triggerType: NotRequired[TriggerTypeType],  # (4)
    createdAt: NotRequired[datetime],
    lastUpdatedAt: NotRequired[datetime],
    createdBy: NotRequired[str],
    lastUpdatedBy: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    lastRunExecutionDetails: NotRequired[ExecutionDetailsTypeDef],  # (5)
  1. See FlowStatusType
  2. See ConnectorTypeType
  3. See ConnectorTypeType
  4. See TriggerTypeType
  5. See ExecutionDetailsTypeDef

ExecutionResultTypeDef#

# ExecutionResultTypeDef definition

class ExecutionResultTypeDef(TypedDict):
    errorInfo: NotRequired[ErrorInfoTypeDef],  # (1)
    bytesProcessed: NotRequired[int],
    bytesWritten: NotRequired[int],
    recordsProcessed: NotRequired[int],
    numParallelProcesses: NotRequired[int],
    maxPageSize: NotRequired[int],
  1. See ErrorInfoTypeDef

FieldTypeDetailsTypeDef#

# FieldTypeDetailsTypeDef definition

class FieldTypeDetailsTypeDef(TypedDict):
    fieldType: str,
    filterOperators: List[OperatorType],  # (1)
    supportedValues: NotRequired[List[str]],
    valueRegexPattern: NotRequired[str],
    supportedDateFormat: NotRequired[str],
    fieldValueRange: NotRequired[RangeTypeDef],  # (2)
    fieldLengthRange: NotRequired[RangeTypeDef],  # (2)
  1. See OperatorType
  2. See RangeTypeDef
  3. See RangeTypeDef

MetadataCatalogConfigTypeDef#

# MetadataCatalogConfigTypeDef definition

class MetadataCatalogConfigTypeDef(TypedDict):
    glueDataCatalog: NotRequired[GlueDataCatalogConfigTypeDef],  # (1)
  1. See GlueDataCatalogConfigTypeDef

MetadataCatalogDetailTypeDef#

# MetadataCatalogDetailTypeDef definition

class MetadataCatalogDetailTypeDef(TypedDict):
    catalogType: NotRequired[CatalogTypeType],  # (1)
    tableName: NotRequired[str],
    tableRegistrationOutput: NotRequired[RegistrationOutputTypeDef],  # (2)
    partitionRegistrationOutput: NotRequired[RegistrationOutputTypeDef],  # (2)
  1. See CatalogTypeType
  2. See RegistrationOutputTypeDef
  3. See RegistrationOutputTypeDef

OAuth2DefaultsTypeDef#

# OAuth2DefaultsTypeDef definition

class OAuth2DefaultsTypeDef(TypedDict):
    oauthScopes: NotRequired[List[str]],
    tokenUrls: NotRequired[List[str]],
    authCodeUrls: NotRequired[List[str]],
    oauth2GrantTypesSupported: NotRequired[List[OAuth2GrantTypeType]],  # (1)
    oauth2CustomProperties: NotRequired[List[OAuth2CustomParameterTypeDef]],  # (2)
  1. See OAuth2GrantTypeType
  2. See OAuth2CustomParameterTypeDef

SAPODataConnectorProfilePropertiesTypeDef#

# SAPODataConnectorProfilePropertiesTypeDef definition

class SAPODataConnectorProfilePropertiesTypeDef(TypedDict):
    applicationHostUrl: str,
    applicationServicePath: str,
    portNumber: int,
    clientNumber: str,
    logonLanguage: NotRequired[str],
    privateLinkServiceName: NotRequired[str],
    oAuthProperties: NotRequired[OAuthPropertiesTypeDef],  # (1)
    disableSSO: NotRequired[bool],
  1. See OAuthPropertiesTypeDef

S3OutputFormatConfigTypeDef#

# S3OutputFormatConfigTypeDef definition

class S3OutputFormatConfigTypeDef(TypedDict):
    fileType: NotRequired[FileTypeType],  # (1)
    prefixConfig: NotRequired[PrefixConfigTypeDef],  # (2)
    aggregationConfig: NotRequired[AggregationConfigTypeDef],  # (3)
    preserveSourceDataTyping: NotRequired[bool],
  1. See FileTypeType
  2. See PrefixConfigTypeDef
  3. See AggregationConfigTypeDef

UpsolverS3OutputFormatConfigTypeDef#

# UpsolverS3OutputFormatConfigTypeDef definition

class UpsolverS3OutputFormatConfigTypeDef(TypedDict):
    prefixConfig: PrefixConfigTypeDef,  # (2)
    fileType: NotRequired[FileTypeType],  # (1)
    aggregationConfig: NotRequired[AggregationConfigTypeDef],  # (3)
  1. See FileTypeType
  2. See PrefixConfigTypeDef
  3. See AggregationConfigTypeDef

S3SourcePropertiesTypeDef#

# S3SourcePropertiesTypeDef definition

class S3SourcePropertiesTypeDef(TypedDict):
    bucketName: str,
    bucketPrefix: NotRequired[str],
    s3InputFormatConfig: NotRequired[S3InputFormatConfigTypeDef],  # (1)
  1. See S3InputFormatConfigTypeDef

SAPODataDestinationPropertiesTypeDef#

# SAPODataDestinationPropertiesTypeDef definition

class SAPODataDestinationPropertiesTypeDef(TypedDict):
    objectPath: str,
    successResponseHandlingConfig: NotRequired[SuccessResponseHandlingConfigTypeDef],  # (1)
    idFieldNames: NotRequired[Sequence[str]],
    errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef],  # (2)
    writeOperationType: NotRequired[WriteOperationTypeType],  # (3)
  1. See SuccessResponseHandlingConfigTypeDef
  2. See ErrorHandlingConfigTypeDef
  3. See WriteOperationTypeType

SAPODataSourcePropertiesTypeDef#

# SAPODataSourcePropertiesTypeDef definition

class SAPODataSourcePropertiesTypeDef(TypedDict):
    objectPath: NotRequired[str],
    parallelismConfig: NotRequired[SAPODataParallelismConfigTypeDef],  # (1)
    paginationConfig: NotRequired[SAPODataPaginationConfigTypeDef],  # (2)
  1. See SAPODataParallelismConfigTypeDef
  2. See SAPODataPaginationConfigTypeDef

ScheduledTriggerPropertiesTypeDef#

# ScheduledTriggerPropertiesTypeDef definition

class ScheduledTriggerPropertiesTypeDef(TypedDict):
    scheduleExpression: str,
    dataPullMode: NotRequired[DataPullModeType],  # (1)
    scheduleStartTime: NotRequired[Union[datetime, str]],
    scheduleEndTime: NotRequired[Union[datetime, str]],
    timezone: NotRequired[str],
    scheduleOffset: NotRequired[int],
    firstExecutionFrom: NotRequired[Union[datetime, str]],
    flowErrorDeactivationThreshold: NotRequired[int],
  1. See DataPullModeType

CustomConnectorProfileCredentialsTypeDef#

# CustomConnectorProfileCredentialsTypeDef definition

class CustomConnectorProfileCredentialsTypeDef(TypedDict):
    authenticationType: AuthenticationTypeType,  # (1)
    basic: NotRequired[BasicAuthCredentialsTypeDef],  # (2)
    oauth2: NotRequired[OAuth2CredentialsTypeDef],  # (3)
    apiKey: NotRequired[ApiKeyCredentialsTypeDef],  # (4)
    custom: NotRequired[CustomAuthCredentialsTypeDef],  # (5)
  1. See AuthenticationTypeType
  2. See BasicAuthCredentialsTypeDef
  3. See OAuth2CredentialsTypeDef
  4. See ApiKeyCredentialsTypeDef
  5. See CustomAuthCredentialsTypeDef

ServiceNowConnectorProfileCredentialsTypeDef#

# ServiceNowConnectorProfileCredentialsTypeDef definition

class ServiceNowConnectorProfileCredentialsTypeDef(TypedDict):
    username: NotRequired[str],
    password: NotRequired[str],
    oAuth2Credentials: NotRequired[OAuth2CredentialsTypeDef],  # (1)
  1. See OAuth2CredentialsTypeDef

SAPODataConnectorProfileCredentialsTypeDef#

# SAPODataConnectorProfileCredentialsTypeDef definition

class SAPODataConnectorProfileCredentialsTypeDef(TypedDict):
    basicAuthCredentials: NotRequired[BasicAuthCredentialsTypeDef],  # (1)
    oAuthCredentials: NotRequired[OAuthCredentialsTypeDef],  # (2)
  1. See BasicAuthCredentialsTypeDef
  2. See OAuthCredentialsTypeDef

RegisterConnectorRequestRequestTypeDef#

# RegisterConnectorRequestRequestTypeDef definition

class RegisterConnectorRequestRequestTypeDef(TypedDict):
    connectorLabel: NotRequired[str],
    description: NotRequired[str],
    connectorProvisioningType: NotRequired[ConnectorProvisioningTypeType],  # (1)
    connectorProvisioningConfig: NotRequired[ConnectorProvisioningConfigTypeDef],  # (2)
    clientToken: NotRequired[str],
  1. See ConnectorProvisioningTypeType
  2. See ConnectorProvisioningConfigTypeDef

UpdateConnectorRegistrationRequestRequestTypeDef#

# UpdateConnectorRegistrationRequestRequestTypeDef definition

class UpdateConnectorRegistrationRequestRequestTypeDef(TypedDict):
    connectorLabel: str,
    description: NotRequired[str],
    connectorProvisioningConfig: NotRequired[ConnectorProvisioningConfigTypeDef],  # (1)
    clientToken: NotRequired[str],
  1. See ConnectorProvisioningConfigTypeDef

ListFlowsResponseTypeDef#

# ListFlowsResponseTypeDef definition

class ListFlowsResponseTypeDef(TypedDict):
    flows: List[FlowDefinitionTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FlowDefinitionTypeDef
  2. See ResponseMetadataTypeDef

SupportedFieldTypeDetailsTypeDef#

# SupportedFieldTypeDetailsTypeDef definition

class SupportedFieldTypeDetailsTypeDef(TypedDict):
    v1: FieldTypeDetailsTypeDef,  # (1)
  1. See FieldTypeDetailsTypeDef

ExecutionRecordTypeDef#

# ExecutionRecordTypeDef definition

class ExecutionRecordTypeDef(TypedDict):
    executionId: NotRequired[str],
    executionStatus: NotRequired[ExecutionStatusType],  # (1)
    executionResult: NotRequired[ExecutionResultTypeDef],  # (2)
    startedAt: NotRequired[datetime],
    lastUpdatedAt: NotRequired[datetime],
    dataPullStartTime: NotRequired[datetime],
    dataPullEndTime: NotRequired[datetime],
    metadataCatalogDetails: NotRequired[List[MetadataCatalogDetailTypeDef]],  # (3)
  1. See ExecutionStatusType
  2. See ExecutionResultTypeDef
  3. See MetadataCatalogDetailTypeDef

AuthenticationConfigTypeDef#

# AuthenticationConfigTypeDef definition

class AuthenticationConfigTypeDef(TypedDict):
    isBasicAuthSupported: NotRequired[bool],
    isApiKeyAuthSupported: NotRequired[bool],
    isOAuth2Supported: NotRequired[bool],
    isCustomAuthSupported: NotRequired[bool],
    oAuth2Defaults: NotRequired[OAuth2DefaultsTypeDef],  # (1)
    customAuthConfigs: NotRequired[List[CustomAuthConfigTypeDef]],  # (2)
  1. See OAuth2DefaultsTypeDef
  2. See CustomAuthConfigTypeDef

ConnectorProfilePropertiesTypeDef#

# ConnectorProfilePropertiesTypeDef definition

class ConnectorProfilePropertiesTypeDef(TypedDict):
    Amplitude: NotRequired[Mapping[str, Any]],
    Datadog: NotRequired[DatadogConnectorProfilePropertiesTypeDef],  # (1)
    Dynatrace: NotRequired[DynatraceConnectorProfilePropertiesTypeDef],  # (2)
    GoogleAnalytics: NotRequired[Mapping[str, Any]],
    Honeycode: NotRequired[Mapping[str, Any]],
    InforNexus: NotRequired[InforNexusConnectorProfilePropertiesTypeDef],  # (3)
    Marketo: NotRequired[MarketoConnectorProfilePropertiesTypeDef],  # (4)
    Redshift: NotRequired[RedshiftConnectorProfilePropertiesTypeDef],  # (5)
    Salesforce: NotRequired[SalesforceConnectorProfilePropertiesTypeDef],  # (6)
    ServiceNow: NotRequired[ServiceNowConnectorProfilePropertiesTypeDef],  # (7)
    Singular: NotRequired[Mapping[str, Any]],
    Slack: NotRequired[SlackConnectorProfilePropertiesTypeDef],  # (8)
    Snowflake: NotRequired[SnowflakeConnectorProfilePropertiesTypeDef],  # (9)
    Trendmicro: NotRequired[Mapping[str, Any]],
    Veeva: NotRequired[VeevaConnectorProfilePropertiesTypeDef],  # (10)
    Zendesk: NotRequired[ZendeskConnectorProfilePropertiesTypeDef],  # (11)
    SAPOData: NotRequired[SAPODataConnectorProfilePropertiesTypeDef],  # (12)
    CustomConnector: NotRequired[CustomConnectorProfilePropertiesTypeDef],  # (13)
    Pardot: NotRequired[PardotConnectorProfilePropertiesTypeDef],  # (14)
  1. See DatadogConnectorProfilePropertiesTypeDef
  2. See DynatraceConnectorProfilePropertiesTypeDef
  3. See InforNexusConnectorProfilePropertiesTypeDef
  4. See MarketoConnectorProfilePropertiesTypeDef
  5. See RedshiftConnectorProfilePropertiesTypeDef
  6. See SalesforceConnectorProfilePropertiesTypeDef
  7. See ServiceNowConnectorProfilePropertiesTypeDef
  8. See SlackConnectorProfilePropertiesTypeDef
  9. See SnowflakeConnectorProfilePropertiesTypeDef
  10. See VeevaConnectorProfilePropertiesTypeDef
  11. See ZendeskConnectorProfilePropertiesTypeDef
  12. See SAPODataConnectorProfilePropertiesTypeDef
  13. See CustomConnectorProfilePropertiesTypeDef
  14. See PardotConnectorProfilePropertiesTypeDef

S3DestinationPropertiesTypeDef#

# S3DestinationPropertiesTypeDef definition

class S3DestinationPropertiesTypeDef(TypedDict):
    bucketName: str,
    bucketPrefix: NotRequired[str],
    s3OutputFormatConfig: NotRequired[S3OutputFormatConfigTypeDef],  # (1)
  1. See S3OutputFormatConfigTypeDef

UpsolverDestinationPropertiesTypeDef#

# UpsolverDestinationPropertiesTypeDef definition

class UpsolverDestinationPropertiesTypeDef(TypedDict):
    bucketName: str,
    s3OutputFormatConfig: UpsolverS3OutputFormatConfigTypeDef,  # (1)
    bucketPrefix: NotRequired[str],
  1. See UpsolverS3OutputFormatConfigTypeDef

SourceConnectorPropertiesTypeDef#

# SourceConnectorPropertiesTypeDef definition

class SourceConnectorPropertiesTypeDef(TypedDict):
    Amplitude: NotRequired[AmplitudeSourcePropertiesTypeDef],  # (1)
    Datadog: NotRequired[DatadogSourcePropertiesTypeDef],  # (2)
    Dynatrace: NotRequired[DynatraceSourcePropertiesTypeDef],  # (3)
    GoogleAnalytics: NotRequired[GoogleAnalyticsSourcePropertiesTypeDef],  # (4)
    InforNexus: NotRequired[InforNexusSourcePropertiesTypeDef],  # (5)
    Marketo: NotRequired[MarketoSourcePropertiesTypeDef],  # (6)
    S3: NotRequired[S3SourcePropertiesTypeDef],  # (7)
    Salesforce: NotRequired[SalesforceSourcePropertiesTypeDef],  # (8)
    ServiceNow: NotRequired[ServiceNowSourcePropertiesTypeDef],  # (9)
    Singular: NotRequired[SingularSourcePropertiesTypeDef],  # (10)
    Slack: NotRequired[SlackSourcePropertiesTypeDef],  # (11)
    Trendmicro: NotRequired[TrendmicroSourcePropertiesTypeDef],  # (12)
    Veeva: NotRequired[VeevaSourcePropertiesTypeDef],  # (13)
    Zendesk: NotRequired[ZendeskSourcePropertiesTypeDef],  # (14)
    SAPOData: NotRequired[SAPODataSourcePropertiesTypeDef],  # (15)
    CustomConnector: NotRequired[CustomConnectorSourcePropertiesTypeDef],  # (16)
    Pardot: NotRequired[PardotSourcePropertiesTypeDef],  # (17)
  1. See AmplitudeSourcePropertiesTypeDef
  2. See DatadogSourcePropertiesTypeDef
  3. See DynatraceSourcePropertiesTypeDef
  4. See GoogleAnalyticsSourcePropertiesTypeDef
  5. See InforNexusSourcePropertiesTypeDef
  6. See MarketoSourcePropertiesTypeDef
  7. See S3SourcePropertiesTypeDef
  8. See SalesforceSourcePropertiesTypeDef
  9. See ServiceNowSourcePropertiesTypeDef
  10. See SingularSourcePropertiesTypeDef
  11. See SlackSourcePropertiesTypeDef
  12. See TrendmicroSourcePropertiesTypeDef
  13. See VeevaSourcePropertiesTypeDef
  14. See ZendeskSourcePropertiesTypeDef
  15. See SAPODataSourcePropertiesTypeDef
  16. See CustomConnectorSourcePropertiesTypeDef
  17. See PardotSourcePropertiesTypeDef

TriggerPropertiesTypeDef#

# TriggerPropertiesTypeDef definition

class TriggerPropertiesTypeDef(TypedDict):
    Scheduled: NotRequired[ScheduledTriggerPropertiesTypeDef],  # (1)
  1. See ScheduledTriggerPropertiesTypeDef

ConnectorProfileCredentialsTypeDef#

# ConnectorProfileCredentialsTypeDef definition

class ConnectorProfileCredentialsTypeDef(TypedDict):
    Amplitude: NotRequired[AmplitudeConnectorProfileCredentialsTypeDef],  # (1)
    Datadog: NotRequired[DatadogConnectorProfileCredentialsTypeDef],  # (2)
    Dynatrace: NotRequired[DynatraceConnectorProfileCredentialsTypeDef],  # (3)
    GoogleAnalytics: NotRequired[GoogleAnalyticsConnectorProfileCredentialsTypeDef],  # (4)
    Honeycode: NotRequired[HoneycodeConnectorProfileCredentialsTypeDef],  # (5)
    InforNexus: NotRequired[InforNexusConnectorProfileCredentialsTypeDef],  # (6)
    Marketo: NotRequired[MarketoConnectorProfileCredentialsTypeDef],  # (7)
    Redshift: NotRequired[RedshiftConnectorProfileCredentialsTypeDef],  # (8)
    Salesforce: NotRequired[SalesforceConnectorProfileCredentialsTypeDef],  # (9)
    ServiceNow: NotRequired[ServiceNowConnectorProfileCredentialsTypeDef],  # (10)
    Singular: NotRequired[SingularConnectorProfileCredentialsTypeDef],  # (11)
    Slack: NotRequired[SlackConnectorProfileCredentialsTypeDef],  # (12)
    Snowflake: NotRequired[SnowflakeConnectorProfileCredentialsTypeDef],  # (13)
    Trendmicro: NotRequired[TrendmicroConnectorProfileCredentialsTypeDef],  # (14)
    Veeva: NotRequired[VeevaConnectorProfileCredentialsTypeDef],  # (15)
    Zendesk: NotRequired[ZendeskConnectorProfileCredentialsTypeDef],  # (16)
    SAPOData: NotRequired[SAPODataConnectorProfileCredentialsTypeDef],  # (17)
    CustomConnector: NotRequired[CustomConnectorProfileCredentialsTypeDef],  # (18)
    Pardot: NotRequired[PardotConnectorProfileCredentialsTypeDef],  # (19)
  1. See AmplitudeConnectorProfileCredentialsTypeDef
  2. See DatadogConnectorProfileCredentialsTypeDef
  3. See DynatraceConnectorProfileCredentialsTypeDef
  4. See GoogleAnalyticsConnectorProfileCredentialsTypeDef
  5. See HoneycodeConnectorProfileCredentialsTypeDef
  6. See InforNexusConnectorProfileCredentialsTypeDef
  7. See MarketoConnectorProfileCredentialsTypeDef
  8. See RedshiftConnectorProfileCredentialsTypeDef
  9. See SalesforceConnectorProfileCredentialsTypeDef
  10. See ServiceNowConnectorProfileCredentialsTypeDef
  11. See SingularConnectorProfileCredentialsTypeDef
  12. See SlackConnectorProfileCredentialsTypeDef
  13. See SnowflakeConnectorProfileCredentialsTypeDef
  14. See TrendmicroConnectorProfileCredentialsTypeDef
  15. See VeevaConnectorProfileCredentialsTypeDef
  16. See ZendeskConnectorProfileCredentialsTypeDef
  17. See SAPODataConnectorProfileCredentialsTypeDef
  18. See CustomConnectorProfileCredentialsTypeDef
  19. See PardotConnectorProfileCredentialsTypeDef

ConnectorEntityFieldTypeDef#

# ConnectorEntityFieldTypeDef definition

class ConnectorEntityFieldTypeDef(TypedDict):
    identifier: str,
    parentIdentifier: NotRequired[str],
    label: NotRequired[str],
    isPrimaryKey: NotRequired[bool],
    defaultValue: NotRequired[str],
    isDeprecated: NotRequired[bool],
    supportedFieldTypeDetails: NotRequired[SupportedFieldTypeDetailsTypeDef],  # (1)
    description: NotRequired[str],
    sourceProperties: NotRequired[SourceFieldPropertiesTypeDef],  # (2)
    destinationProperties: NotRequired[DestinationFieldPropertiesTypeDef],  # (3)
    customProperties: NotRequired[Dict[str, str]],
  1. See SupportedFieldTypeDetailsTypeDef
  2. See SourceFieldPropertiesTypeDef
  3. See DestinationFieldPropertiesTypeDef

DescribeFlowExecutionRecordsResponseTypeDef#

# DescribeFlowExecutionRecordsResponseTypeDef definition

class DescribeFlowExecutionRecordsResponseTypeDef(TypedDict):
    flowExecutions: List[ExecutionRecordTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExecutionRecordTypeDef
  2. See ResponseMetadataTypeDef

ConnectorConfigurationTypeDef#

# ConnectorConfigurationTypeDef definition

class ConnectorConfigurationTypeDef(TypedDict):
    canUseAsSource: NotRequired[bool],
    canUseAsDestination: NotRequired[bool],
    supportedDestinationConnectors: NotRequired[List[ConnectorTypeType]],  # (1)
    supportedSchedulingFrequencies: NotRequired[List[ScheduleFrequencyTypeType]],  # (2)
    isPrivateLinkEnabled: NotRequired[bool],
    isPrivateLinkEndpointUrlRequired: NotRequired[bool],
    supportedTriggerTypes: NotRequired[List[TriggerTypeType]],  # (3)
    connectorMetadata: NotRequired[ConnectorMetadataTypeDef],  # (4)
    connectorType: NotRequired[ConnectorTypeType],  # (5)
    connectorLabel: NotRequired[str],
    connectorDescription: NotRequired[str],
    connectorOwner: NotRequired[str],
    connectorName: NotRequired[str],
    connectorVersion: NotRequired[str],
    connectorArn: NotRequired[str],
    connectorModes: NotRequired[List[str]],
    authenticationConfig: NotRequired[AuthenticationConfigTypeDef],  # (6)
    connectorRuntimeSettings: NotRequired[List[ConnectorRuntimeSettingTypeDef]],  # (7)
    supportedApiVersions: NotRequired[List[str]],
    supportedOperators: NotRequired[List[OperatorsType]],  # (8)
    supportedWriteOperations: NotRequired[List[WriteOperationTypeType]],  # (9)
    connectorProvisioningType: NotRequired[ConnectorProvisioningTypeType],  # (10)
    connectorProvisioningConfig: NotRequired[ConnectorProvisioningConfigTypeDef],  # (11)
    logoURL: NotRequired[str],
    registeredAt: NotRequired[datetime],
    registeredBy: NotRequired[str],
    supportedDataTransferTypes: NotRequired[List[SupportedDataTransferTypeType]],  # (12)
    supportedDataTransferApis: NotRequired[List[DataTransferApiTypeDef]],  # (13)
  1. See ConnectorTypeType
  2. See ScheduleFrequencyTypeType
  3. See TriggerTypeType
  4. See ConnectorMetadataTypeDef
  5. See ConnectorTypeType
  6. See AuthenticationConfigTypeDef
  7. See ConnectorRuntimeSettingTypeDef
  8. See OperatorsType
  9. See WriteOperationTypeType
  10. See ConnectorProvisioningTypeType
  11. See ConnectorProvisioningConfigTypeDef
  12. See SupportedDataTransferTypeType
  13. See DataTransferApiTypeDef

ConnectorProfileTypeDef#

# ConnectorProfileTypeDef definition

class ConnectorProfileTypeDef(TypedDict):
    connectorProfileArn: NotRequired[str],
    connectorProfileName: NotRequired[str],
    connectorType: NotRequired[ConnectorTypeType],  # (1)
    connectorLabel: NotRequired[str],
    connectionMode: NotRequired[ConnectionModeType],  # (2)
    credentialsArn: NotRequired[str],
    connectorProfileProperties: NotRequired[ConnectorProfilePropertiesTypeDef],  # (3)
    createdAt: NotRequired[datetime],
    lastUpdatedAt: NotRequired[datetime],
    privateConnectionProvisioningState: NotRequired[PrivateConnectionProvisioningStateTypeDef],  # (4)
  1. See ConnectorTypeType
  2. See ConnectionModeType
  3. See ConnectorProfilePropertiesTypeDef
  4. See PrivateConnectionProvisioningStateTypeDef

DestinationConnectorPropertiesTypeDef#

# DestinationConnectorPropertiesTypeDef definition

class DestinationConnectorPropertiesTypeDef(TypedDict):
    Redshift: NotRequired[RedshiftDestinationPropertiesTypeDef],  # (1)
    S3: NotRequired[S3DestinationPropertiesTypeDef],  # (2)
    Salesforce: NotRequired[SalesforceDestinationPropertiesTypeDef],  # (3)
    Snowflake: NotRequired[SnowflakeDestinationPropertiesTypeDef],  # (4)
    EventBridge: NotRequired[EventBridgeDestinationPropertiesTypeDef],  # (5)
    LookoutMetrics: NotRequired[Mapping[str, Any]],
    Upsolver: NotRequired[UpsolverDestinationPropertiesTypeDef],  # (6)
    Honeycode: NotRequired[HoneycodeDestinationPropertiesTypeDef],  # (7)
    CustomerProfiles: NotRequired[CustomerProfilesDestinationPropertiesTypeDef],  # (8)
    Zendesk: NotRequired[ZendeskDestinationPropertiesTypeDef],  # (9)
    Marketo: NotRequired[MarketoDestinationPropertiesTypeDef],  # (10)
    CustomConnector: NotRequired[CustomConnectorDestinationPropertiesTypeDef],  # (11)
    SAPOData: NotRequired[SAPODataDestinationPropertiesTypeDef],  # (12)
  1. See RedshiftDestinationPropertiesTypeDef
  2. See S3DestinationPropertiesTypeDef
  3. See SalesforceDestinationPropertiesTypeDef
  4. See SnowflakeDestinationPropertiesTypeDef
  5. See EventBridgeDestinationPropertiesTypeDef
  6. See UpsolverDestinationPropertiesTypeDef
  7. See HoneycodeDestinationPropertiesTypeDef
  8. See CustomerProfilesDestinationPropertiesTypeDef
  9. See ZendeskDestinationPropertiesTypeDef
  10. See MarketoDestinationPropertiesTypeDef
  11. See CustomConnectorDestinationPropertiesTypeDef
  12. See SAPODataDestinationPropertiesTypeDef

SourceFlowConfigTypeDef#

# SourceFlowConfigTypeDef definition

class SourceFlowConfigTypeDef(TypedDict):
    connectorType: ConnectorTypeType,  # (1)
    sourceConnectorProperties: SourceConnectorPropertiesTypeDef,  # (2)
    apiVersion: NotRequired[str],
    connectorProfileName: NotRequired[str],
    incrementalPullConfig: NotRequired[IncrementalPullConfigTypeDef],  # (3)
  1. See ConnectorTypeType
  2. See SourceConnectorPropertiesTypeDef
  3. See IncrementalPullConfigTypeDef

TriggerConfigTypeDef#

# TriggerConfigTypeDef definition

class TriggerConfigTypeDef(TypedDict):
    triggerType: TriggerTypeType,  # (1)
    triggerProperties: NotRequired[TriggerPropertiesTypeDef],  # (2)
  1. See TriggerTypeType
  2. See TriggerPropertiesTypeDef

ConnectorProfileConfigTypeDef#

# ConnectorProfileConfigTypeDef definition

class ConnectorProfileConfigTypeDef(TypedDict):
    connectorProfileProperties: ConnectorProfilePropertiesTypeDef,  # (1)
    connectorProfileCredentials: NotRequired[ConnectorProfileCredentialsTypeDef],  # (2)
  1. See ConnectorProfilePropertiesTypeDef
  2. See ConnectorProfileCredentialsTypeDef

DescribeConnectorEntityResponseTypeDef#

# DescribeConnectorEntityResponseTypeDef definition

class DescribeConnectorEntityResponseTypeDef(TypedDict):
    connectorEntityFields: List[ConnectorEntityFieldTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorEntityFieldTypeDef
  2. See ResponseMetadataTypeDef

DescribeConnectorResponseTypeDef#

# DescribeConnectorResponseTypeDef definition

class DescribeConnectorResponseTypeDef(TypedDict):
    connectorConfiguration: ConnectorConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorConfigurationTypeDef
  2. See ResponseMetadataTypeDef

DescribeConnectorsResponseTypeDef#

# DescribeConnectorsResponseTypeDef definition

class DescribeConnectorsResponseTypeDef(TypedDict):
    connectorConfigurations: Dict[ConnectorTypeType, ConnectorConfigurationTypeDef],  # (1)
    connectors: List[ConnectorDetailTypeDef],  # (2)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ConnectorTypeType ConnectorConfigurationTypeDef
  2. See ConnectorDetailTypeDef
  3. See ResponseMetadataTypeDef

DescribeConnectorProfilesResponseTypeDef#

# DescribeConnectorProfilesResponseTypeDef definition

class DescribeConnectorProfilesResponseTypeDef(TypedDict):
    connectorProfileDetails: List[ConnectorProfileTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorProfileTypeDef
  2. See ResponseMetadataTypeDef

DestinationFlowConfigTypeDef#

# DestinationFlowConfigTypeDef definition

class DestinationFlowConfigTypeDef(TypedDict):
    connectorType: ConnectorTypeType,  # (1)
    destinationConnectorProperties: DestinationConnectorPropertiesTypeDef,  # (2)
    apiVersion: NotRequired[str],
    connectorProfileName: NotRequired[str],
  1. See ConnectorTypeType
  2. See DestinationConnectorPropertiesTypeDef

CreateConnectorProfileRequestRequestTypeDef#

# CreateConnectorProfileRequestRequestTypeDef definition

class CreateConnectorProfileRequestRequestTypeDef(TypedDict):
    connectorProfileName: str,
    connectorType: ConnectorTypeType,  # (1)
    connectionMode: ConnectionModeType,  # (2)
    connectorProfileConfig: ConnectorProfileConfigTypeDef,  # (3)
    kmsArn: NotRequired[str],
    connectorLabel: NotRequired[str],
    clientToken: NotRequired[str],
  1. See ConnectorTypeType
  2. See ConnectionModeType
  3. See ConnectorProfileConfigTypeDef

UpdateConnectorProfileRequestRequestTypeDef#

# UpdateConnectorProfileRequestRequestTypeDef definition

class UpdateConnectorProfileRequestRequestTypeDef(TypedDict):
    connectorProfileName: str,
    connectionMode: ConnectionModeType,  # (1)
    connectorProfileConfig: ConnectorProfileConfigTypeDef,  # (2)
    clientToken: NotRequired[str],
  1. See ConnectionModeType
  2. See ConnectorProfileConfigTypeDef

CreateFlowRequestRequestTypeDef#

# CreateFlowRequestRequestTypeDef definition

class CreateFlowRequestRequestTypeDef(TypedDict):
    flowName: str,
    triggerConfig: TriggerConfigTypeDef,  # (1)
    sourceFlowConfig: SourceFlowConfigTypeDef,  # (2)
    destinationFlowConfigList: Sequence[DestinationFlowConfigTypeDef],  # (3)
    tasks: Sequence[TaskTypeDef],  # (4)
    description: NotRequired[str],
    kmsArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    metadataCatalogConfig: NotRequired[MetadataCatalogConfigTypeDef],  # (5)
    clientToken: NotRequired[str],
  1. See TriggerConfigTypeDef
  2. See SourceFlowConfigTypeDef
  3. See DestinationFlowConfigTypeDef
  4. See TaskTypeDef
  5. See MetadataCatalogConfigTypeDef

DescribeFlowResponseTypeDef#

# DescribeFlowResponseTypeDef definition

class DescribeFlowResponseTypeDef(TypedDict):
    flowArn: str,
    description: str,
    flowName: str,
    kmsArn: str,
    flowStatus: FlowStatusType,  # (1)
    flowStatusMessage: str,
    sourceFlowConfig: SourceFlowConfigTypeDef,  # (2)
    destinationFlowConfigList: List[DestinationFlowConfigTypeDef],  # (3)
    lastRunExecutionDetails: ExecutionDetailsTypeDef,  # (4)
    triggerConfig: TriggerConfigTypeDef,  # (5)
    tasks: List[TaskTypeDef],  # (6)
    createdAt: datetime,
    lastUpdatedAt: datetime,
    createdBy: str,
    lastUpdatedBy: str,
    tags: Dict[str, str],
    metadataCatalogConfig: MetadataCatalogConfigTypeDef,  # (7)
    lastRunMetadataCatalogDetails: List[MetadataCatalogDetailTypeDef],  # (8)
    schemaVersion: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (9)
  1. See FlowStatusType
  2. See SourceFlowConfigTypeDef
  3. See DestinationFlowConfigTypeDef
  4. See ExecutionDetailsTypeDef
  5. See TriggerConfigTypeDef
  6. See TaskTypeDef
  7. See MetadataCatalogConfigTypeDef
  8. See MetadataCatalogDetailTypeDef
  9. See ResponseMetadataTypeDef

UpdateFlowRequestRequestTypeDef#

# UpdateFlowRequestRequestTypeDef definition

class UpdateFlowRequestRequestTypeDef(TypedDict):
    flowName: str,
    triggerConfig: TriggerConfigTypeDef,  # (1)
    sourceFlowConfig: SourceFlowConfigTypeDef,  # (2)
    destinationFlowConfigList: Sequence[DestinationFlowConfigTypeDef],  # (3)
    tasks: Sequence[TaskTypeDef],  # (4)
    description: NotRequired[str],
    metadataCatalogConfig: NotRequired[MetadataCatalogConfigTypeDef],  # (5)
    clientToken: NotRequired[str],
  1. See TriggerConfigTypeDef
  2. See SourceFlowConfigTypeDef
  3. See DestinationFlowConfigTypeDef
  4. See TaskTypeDef
  5. See MetadataCatalogConfigTypeDef