Typed dictionaries#
Auto-generated documentation for Appflow type annotations stubs module mypy-boto3-appflow.
AggregationConfigTypeDef#
# AggregationConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import AggregationConfigTypeDef
def get_value() -> AggregationConfigTypeDef:
return {
"aggregationType": ...,
}
# AggregationConfigTypeDef definition
class AggregationConfigTypeDef(TypedDict):
aggregationType: NotRequired[AggregationTypeType], # (1)
targetFileSize: NotRequired[int],
AmplitudeConnectorProfileCredentialsTypeDef#
# AmplitudeConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import AmplitudeConnectorProfileCredentialsTypeDef
def get_value() -> AmplitudeConnectorProfileCredentialsTypeDef:
return {
"apiKey": ...,
"secretKey": ...,
}
# AmplitudeConnectorProfileCredentialsTypeDef definition
class AmplitudeConnectorProfileCredentialsTypeDef(TypedDict):
apiKey: str,
secretKey: str,
AmplitudeSourcePropertiesTypeDef#
# AmplitudeSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import AmplitudeSourcePropertiesTypeDef
def get_value() -> AmplitudeSourcePropertiesTypeDef:
return {
"object": ...,
}
# AmplitudeSourcePropertiesTypeDef definition
class AmplitudeSourcePropertiesTypeDef(TypedDict):
object: str,
ApiKeyCredentialsTypeDef#
# ApiKeyCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import ApiKeyCredentialsTypeDef
def get_value() -> ApiKeyCredentialsTypeDef:
return {
"apiKey": ...,
}
# ApiKeyCredentialsTypeDef definition
class ApiKeyCredentialsTypeDef(TypedDict):
apiKey: str,
apiSecretKey: NotRequired[str],
AuthParameterTypeDef#
# AuthParameterTypeDef usage example
from mypy_boto3_appflow.type_defs import AuthParameterTypeDef
def get_value() -> AuthParameterTypeDef:
return {
"key": ...,
}
# 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 usage example
from mypy_boto3_appflow.type_defs import BasicAuthCredentialsTypeDef
def get_value() -> BasicAuthCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
# BasicAuthCredentialsTypeDef definition
class BasicAuthCredentialsTypeDef(TypedDict):
username: str,
password: str,
CancelFlowExecutionsRequestRequestTypeDef#
# CancelFlowExecutionsRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import CancelFlowExecutionsRequestRequestTypeDef
def get_value() -> CancelFlowExecutionsRequestRequestTypeDef:
return {
"flowName": ...,
}
# CancelFlowExecutionsRequestRequestTypeDef definition
class CancelFlowExecutionsRequestRequestTypeDef(TypedDict):
flowName: str,
executionIds: NotRequired[Sequence[str]],
CancelFlowExecutionsResponseTypeDef#
# CancelFlowExecutionsResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import CancelFlowExecutionsResponseTypeDef
def get_value() -> CancelFlowExecutionsResponseTypeDef:
return {
"invalidExecutions": ...,
"ResponseMetadata": ...,
}
# CancelFlowExecutionsResponseTypeDef definition
class CancelFlowExecutionsResponseTypeDef(TypedDict):
invalidExecutions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ConnectorRuntimeSettingTypeDef#
# ConnectorRuntimeSettingTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorRuntimeSettingTypeDef
def get_value() -> ConnectorRuntimeSettingTypeDef:
return {
"key": ...,
}
# 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 usage example
from mypy_boto3_appflow.type_defs import DataTransferApiTypeDef
def get_value() -> DataTransferApiTypeDef:
return {
"Name": ...,
}
# DataTransferApiTypeDef definition
class DataTransferApiTypeDef(TypedDict):
Name: NotRequired[str],
Type: NotRequired[DataTransferApiTypeType], # (1)
ConnectorDetailTypeDef#
# ConnectorDetailTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorDetailTypeDef
def get_value() -> ConnectorDetailTypeDef:
return {
"connectorDescription": ...,
}
# 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)
DestinationFieldPropertiesTypeDef#
# DestinationFieldPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import DestinationFieldPropertiesTypeDef
def get_value() -> DestinationFieldPropertiesTypeDef:
return {
"isCreatable": ...,
}
# 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)
SourceFieldPropertiesTypeDef#
# SourceFieldPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SourceFieldPropertiesTypeDef
def get_value() -> SourceFieldPropertiesTypeDef:
return {
"isRetrievable": ...,
}
# SourceFieldPropertiesTypeDef definition
class SourceFieldPropertiesTypeDef(TypedDict):
isRetrievable: NotRequired[bool],
isQueryable: NotRequired[bool],
isTimestampFieldForIncrementalQueries: NotRequired[bool],
ConnectorEntityTypeDef#
# ConnectorEntityTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorEntityTypeDef
def get_value() -> ConnectorEntityTypeDef:
return {
"name": ...,
}
# ConnectorEntityTypeDef definition
class ConnectorEntityTypeDef(TypedDict):
name: str,
label: NotRequired[str],
hasNestedEntities: NotRequired[bool],
GoogleAnalyticsMetadataTypeDef#
# GoogleAnalyticsMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import GoogleAnalyticsMetadataTypeDef
def get_value() -> GoogleAnalyticsMetadataTypeDef:
return {
"oAuthScopes": ...,
}
# GoogleAnalyticsMetadataTypeDef definition
class GoogleAnalyticsMetadataTypeDef(TypedDict):
oAuthScopes: NotRequired[List[str]],
HoneycodeMetadataTypeDef#
# HoneycodeMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import HoneycodeMetadataTypeDef
def get_value() -> HoneycodeMetadataTypeDef:
return {
"oAuthScopes": ...,
}
# HoneycodeMetadataTypeDef definition
class HoneycodeMetadataTypeDef(TypedDict):
oAuthScopes: NotRequired[List[str]],
SalesforceMetadataTypeDef#
# SalesforceMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import SalesforceMetadataTypeDef
def get_value() -> SalesforceMetadataTypeDef:
return {
"oAuthScopes": ...,
}
# SalesforceMetadataTypeDef definition
class SalesforceMetadataTypeDef(TypedDict):
oAuthScopes: NotRequired[List[str]],
dataTransferApis: NotRequired[List[SalesforceDataTransferApiType]], # (1)
oauth2GrantTypesSupported: NotRequired[List[OAuth2GrantTypeType]], # (2)
SlackMetadataTypeDef#
# SlackMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import SlackMetadataTypeDef
def get_value() -> SlackMetadataTypeDef:
return {
"oAuthScopes": ...,
}
# SlackMetadataTypeDef definition
class SlackMetadataTypeDef(TypedDict):
oAuthScopes: NotRequired[List[str]],
SnowflakeMetadataTypeDef#
# SnowflakeMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import SnowflakeMetadataTypeDef
def get_value() -> SnowflakeMetadataTypeDef:
return {
"supportedRegions": ...,
}
# SnowflakeMetadataTypeDef definition
class SnowflakeMetadataTypeDef(TypedDict):
supportedRegions: NotRequired[List[str]],
ZendeskMetadataTypeDef#
# ZendeskMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import ZendeskMetadataTypeDef
def get_value() -> ZendeskMetadataTypeDef:
return {
"oAuthScopes": ...,
}
# ZendeskMetadataTypeDef definition
class ZendeskMetadataTypeDef(TypedDict):
oAuthScopes: NotRequired[List[str]],
ConnectorOAuthRequestTypeDef#
# ConnectorOAuthRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorOAuthRequestTypeDef
def get_value() -> ConnectorOAuthRequestTypeDef:
return {
"authCode": ...,
}
# ConnectorOAuthRequestTypeDef definition
class ConnectorOAuthRequestTypeDef(TypedDict):
authCode: NotRequired[str],
redirectUri: NotRequired[str],
ConnectorOperatorTypeDef#
# ConnectorOperatorTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorOperatorTypeDef
def get_value() -> ConnectorOperatorTypeDef:
return {
"Amplitude": ...,
}
# 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)
- See AmplitudeConnectorOperatorType
- See DatadogConnectorOperatorType
- See DynatraceConnectorOperatorType
- See GoogleAnalyticsConnectorOperatorType
- See InforNexusConnectorOperatorType
- See MarketoConnectorOperatorType
- See S3ConnectorOperatorType
- See SalesforceConnectorOperatorType
- See ServiceNowConnectorOperatorType
- See SingularConnectorOperatorType
- See SlackConnectorOperatorType
- See TrendmicroConnectorOperatorType
- See VeevaConnectorOperatorType
- See ZendeskConnectorOperatorType
- See SAPODataConnectorOperatorType
- See OperatorType
- See PardotConnectorOperatorType
DatadogConnectorProfileCredentialsTypeDef#
# DatadogConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import DatadogConnectorProfileCredentialsTypeDef
def get_value() -> DatadogConnectorProfileCredentialsTypeDef:
return {
"apiKey": ...,
"applicationKey": ...,
}
# DatadogConnectorProfileCredentialsTypeDef definition
class DatadogConnectorProfileCredentialsTypeDef(TypedDict):
apiKey: str,
applicationKey: str,
DynatraceConnectorProfileCredentialsTypeDef#
# DynatraceConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import DynatraceConnectorProfileCredentialsTypeDef
def get_value() -> DynatraceConnectorProfileCredentialsTypeDef:
return {
"apiToken": ...,
}
# DynatraceConnectorProfileCredentialsTypeDef definition
class DynatraceConnectorProfileCredentialsTypeDef(TypedDict):
apiToken: str,
InforNexusConnectorProfileCredentialsTypeDef#
# InforNexusConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import InforNexusConnectorProfileCredentialsTypeDef
def get_value() -> InforNexusConnectorProfileCredentialsTypeDef:
return {
"accessKeyId": ...,
"userId": ...,
"secretAccessKey": ...,
"datakey": ...,
}
# InforNexusConnectorProfileCredentialsTypeDef definition
class InforNexusConnectorProfileCredentialsTypeDef(TypedDict):
accessKeyId: str,
userId: str,
secretAccessKey: str,
datakey: str,
RedshiftConnectorProfileCredentialsTypeDef#
# RedshiftConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import RedshiftConnectorProfileCredentialsTypeDef
def get_value() -> RedshiftConnectorProfileCredentialsTypeDef:
return {
"username": ...,
}
# RedshiftConnectorProfileCredentialsTypeDef definition
class RedshiftConnectorProfileCredentialsTypeDef(TypedDict):
username: NotRequired[str],
password: NotRequired[str],
ServiceNowConnectorProfileCredentialsTypeDef#
# ServiceNowConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import ServiceNowConnectorProfileCredentialsTypeDef
def get_value() -> ServiceNowConnectorProfileCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
# ServiceNowConnectorProfileCredentialsTypeDef definition
class ServiceNowConnectorProfileCredentialsTypeDef(TypedDict):
username: str,
password: str,
SingularConnectorProfileCredentialsTypeDef#
# SingularConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import SingularConnectorProfileCredentialsTypeDef
def get_value() -> SingularConnectorProfileCredentialsTypeDef:
return {
"apiKey": ...,
}
# SingularConnectorProfileCredentialsTypeDef definition
class SingularConnectorProfileCredentialsTypeDef(TypedDict):
apiKey: str,
SnowflakeConnectorProfileCredentialsTypeDef#
# SnowflakeConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import SnowflakeConnectorProfileCredentialsTypeDef
def get_value() -> SnowflakeConnectorProfileCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
# SnowflakeConnectorProfileCredentialsTypeDef definition
class SnowflakeConnectorProfileCredentialsTypeDef(TypedDict):
username: str,
password: str,
TrendmicroConnectorProfileCredentialsTypeDef#
# TrendmicroConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import TrendmicroConnectorProfileCredentialsTypeDef
def get_value() -> TrendmicroConnectorProfileCredentialsTypeDef:
return {
"apiSecretKey": ...,
}
# TrendmicroConnectorProfileCredentialsTypeDef definition
class TrendmicroConnectorProfileCredentialsTypeDef(TypedDict):
apiSecretKey: str,
VeevaConnectorProfileCredentialsTypeDef#
# VeevaConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import VeevaConnectorProfileCredentialsTypeDef
def get_value() -> VeevaConnectorProfileCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
# VeevaConnectorProfileCredentialsTypeDef definition
class VeevaConnectorProfileCredentialsTypeDef(TypedDict):
username: str,
password: str,
DatadogConnectorProfilePropertiesTypeDef#
# DatadogConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import DatadogConnectorProfilePropertiesTypeDef
def get_value() -> DatadogConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# DatadogConnectorProfilePropertiesTypeDef definition
class DatadogConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
DynatraceConnectorProfilePropertiesTypeDef#
# DynatraceConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import DynatraceConnectorProfilePropertiesTypeDef
def get_value() -> DynatraceConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# DynatraceConnectorProfilePropertiesTypeDef definition
class DynatraceConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
InforNexusConnectorProfilePropertiesTypeDef#
# InforNexusConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import InforNexusConnectorProfilePropertiesTypeDef
def get_value() -> InforNexusConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# InforNexusConnectorProfilePropertiesTypeDef definition
class InforNexusConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
MarketoConnectorProfilePropertiesTypeDef#
# MarketoConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import MarketoConnectorProfilePropertiesTypeDef
def get_value() -> MarketoConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# MarketoConnectorProfilePropertiesTypeDef definition
class MarketoConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
PardotConnectorProfilePropertiesTypeDef#
# PardotConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import PardotConnectorProfilePropertiesTypeDef
def get_value() -> PardotConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# PardotConnectorProfilePropertiesTypeDef definition
class PardotConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: NotRequired[str],
isSandboxEnvironment: NotRequired[bool],
businessUnitId: NotRequired[str],
RedshiftConnectorProfilePropertiesTypeDef#
# RedshiftConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import RedshiftConnectorProfilePropertiesTypeDef
def get_value() -> RedshiftConnectorProfilePropertiesTypeDef:
return {
"bucketName": ...,
"roleArn": ...,
}
# 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 usage example
from mypy_boto3_appflow.type_defs import SalesforceConnectorProfilePropertiesTypeDef
def get_value() -> SalesforceConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# SalesforceConnectorProfilePropertiesTypeDef definition
class SalesforceConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: NotRequired[str],
isSandboxEnvironment: NotRequired[bool],
usePrivateLinkForMetadataAndAuthorization: NotRequired[bool],
ServiceNowConnectorProfilePropertiesTypeDef#
# ServiceNowConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import ServiceNowConnectorProfilePropertiesTypeDef
def get_value() -> ServiceNowConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# ServiceNowConnectorProfilePropertiesTypeDef definition
class ServiceNowConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
SlackConnectorProfilePropertiesTypeDef#
# SlackConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SlackConnectorProfilePropertiesTypeDef
def get_value() -> SlackConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# SlackConnectorProfilePropertiesTypeDef definition
class SlackConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
SnowflakeConnectorProfilePropertiesTypeDef#
# SnowflakeConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SnowflakeConnectorProfilePropertiesTypeDef
def get_value() -> SnowflakeConnectorProfilePropertiesTypeDef:
return {
"warehouse": ...,
"stage": ...,
"bucketName": ...,
}
# 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 usage example
from mypy_boto3_appflow.type_defs import VeevaConnectorProfilePropertiesTypeDef
def get_value() -> VeevaConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# VeevaConnectorProfilePropertiesTypeDef definition
class VeevaConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
ZendeskConnectorProfilePropertiesTypeDef#
# ZendeskConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import ZendeskConnectorProfilePropertiesTypeDef
def get_value() -> ZendeskConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
# ZendeskConnectorProfilePropertiesTypeDef definition
class ZendeskConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: str,
PrivateConnectionProvisioningStateTypeDef#
# PrivateConnectionProvisioningStateTypeDef usage example
from mypy_boto3_appflow.type_defs import PrivateConnectionProvisioningStateTypeDef
def get_value() -> PrivateConnectionProvisioningStateTypeDef:
return {
"status": ...,
}
# PrivateConnectionProvisioningStateTypeDef definition
class PrivateConnectionProvisioningStateTypeDef(TypedDict):
status: NotRequired[PrivateConnectionProvisioningStatusType], # (1)
failureMessage: NotRequired[str],
failureCause: NotRequired[PrivateConnectionProvisioningFailureCauseType], # (2)
LambdaConnectorProvisioningConfigTypeDef#
# LambdaConnectorProvisioningConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import LambdaConnectorProvisioningConfigTypeDef
def get_value() -> LambdaConnectorProvisioningConfigTypeDef:
return {
"lambdaArn": ...,
}
# LambdaConnectorProvisioningConfigTypeDef definition
class LambdaConnectorProvisioningConfigTypeDef(TypedDict):
lambdaArn: str,
CreateConnectorProfileResponseTypeDef#
# CreateConnectorProfileResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import CreateConnectorProfileResponseTypeDef
def get_value() -> CreateConnectorProfileResponseTypeDef:
return {
"connectorProfileArn": ...,
"ResponseMetadata": ...,
}
# CreateConnectorProfileResponseTypeDef definition
class CreateConnectorProfileResponseTypeDef(TypedDict):
connectorProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateFlowResponseTypeDef#
# CreateFlowResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import CreateFlowResponseTypeDef
def get_value() -> CreateFlowResponseTypeDef:
return {
"flowArn": ...,
"flowStatus": ...,
"ResponseMetadata": ...,
}
# CreateFlowResponseTypeDef definition
class CreateFlowResponseTypeDef(TypedDict):
flowArn: str,
flowStatus: FlowStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CustomAuthCredentialsTypeDef#
# CustomAuthCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import CustomAuthCredentialsTypeDef
def get_value() -> CustomAuthCredentialsTypeDef:
return {
"customAuthenticationType": ...,
}
# CustomAuthCredentialsTypeDef definition
class CustomAuthCredentialsTypeDef(TypedDict):
customAuthenticationType: str,
credentialsMap: NotRequired[Mapping[str, str]],
ErrorHandlingConfigTypeDef#
# ErrorHandlingConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import ErrorHandlingConfigTypeDef
def get_value() -> ErrorHandlingConfigTypeDef:
return {
"failOnFirstDestinationError": ...,
}
# ErrorHandlingConfigTypeDef definition
class ErrorHandlingConfigTypeDef(TypedDict):
failOnFirstDestinationError: NotRequired[bool],
bucketPrefix: NotRequired[str],
bucketName: NotRequired[str],
OAuth2PropertiesTypeDef#
# OAuth2PropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import OAuth2PropertiesTypeDef
def get_value() -> OAuth2PropertiesTypeDef:
return {
"tokenUrl": ...,
"oAuth2GrantType": ...,
}
# OAuth2PropertiesTypeDef definition
class OAuth2PropertiesTypeDef(TypedDict):
tokenUrl: str,
oAuth2GrantType: OAuth2GrantTypeType, # (1)
tokenUrlCustomProperties: NotRequired[Mapping[str, str]],
CustomerProfilesDestinationPropertiesTypeDef#
# CustomerProfilesDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import CustomerProfilesDestinationPropertiesTypeDef
def get_value() -> CustomerProfilesDestinationPropertiesTypeDef:
return {
"domainName": ...,
}
# CustomerProfilesDestinationPropertiesTypeDef definition
class CustomerProfilesDestinationPropertiesTypeDef(TypedDict):
domainName: str,
objectTypeName: NotRequired[str],
DatadogSourcePropertiesTypeDef#
# DatadogSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import DatadogSourcePropertiesTypeDef
def get_value() -> DatadogSourcePropertiesTypeDef:
return {
"object": ...,
}
# DatadogSourcePropertiesTypeDef definition
class DatadogSourcePropertiesTypeDef(TypedDict):
object: str,
DeleteConnectorProfileRequestRequestTypeDef#
# DeleteConnectorProfileRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DeleteConnectorProfileRequestRequestTypeDef
def get_value() -> DeleteConnectorProfileRequestRequestTypeDef:
return {
"connectorProfileName": ...,
}
# DeleteConnectorProfileRequestRequestTypeDef definition
class DeleteConnectorProfileRequestRequestTypeDef(TypedDict):
connectorProfileName: str,
forceDelete: NotRequired[bool],
DeleteFlowRequestRequestTypeDef#
# DeleteFlowRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DeleteFlowRequestRequestTypeDef
def get_value() -> DeleteFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
# DeleteFlowRequestRequestTypeDef definition
class DeleteFlowRequestRequestTypeDef(TypedDict):
flowName: str,
forceDelete: NotRequired[bool],
DescribeConnectorEntityRequestRequestTypeDef#
# DescribeConnectorEntityRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorEntityRequestRequestTypeDef
def get_value() -> DescribeConnectorEntityRequestRequestTypeDef:
return {
"connectorEntityName": ...,
}
# DescribeConnectorEntityRequestRequestTypeDef definition
class DescribeConnectorEntityRequestRequestTypeDef(TypedDict):
connectorEntityName: str,
connectorType: NotRequired[ConnectorTypeType], # (1)
connectorProfileName: NotRequired[str],
apiVersion: NotRequired[str],
DescribeConnectorProfilesRequestRequestTypeDef#
# DescribeConnectorProfilesRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorProfilesRequestRequestTypeDef
def get_value() -> DescribeConnectorProfilesRequestRequestTypeDef:
return {
"connectorProfileNames": ...,
}
# DescribeConnectorProfilesRequestRequestTypeDef definition
class DescribeConnectorProfilesRequestRequestTypeDef(TypedDict):
connectorProfileNames: NotRequired[Sequence[str]],
connectorType: NotRequired[ConnectorTypeType], # (1)
connectorLabel: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
DescribeConnectorRequestRequestTypeDef#
# DescribeConnectorRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorRequestRequestTypeDef
def get_value() -> DescribeConnectorRequestRequestTypeDef:
return {
"connectorType": ...,
}
# DescribeConnectorRequestRequestTypeDef definition
class DescribeConnectorRequestRequestTypeDef(TypedDict):
connectorType: ConnectorTypeType, # (1)
connectorLabel: NotRequired[str],
DescribeConnectorsRequestRequestTypeDef#
# DescribeConnectorsRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorsRequestRequestTypeDef
def get_value() -> DescribeConnectorsRequestRequestTypeDef:
return {
"connectorTypes": ...,
}
# DescribeConnectorsRequestRequestTypeDef definition
class DescribeConnectorsRequestRequestTypeDef(TypedDict):
connectorTypes: NotRequired[Sequence[ConnectorTypeType]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
DescribeFlowExecutionRecordsRequestRequestTypeDef#
# DescribeFlowExecutionRecordsRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeFlowExecutionRecordsRequestRequestTypeDef
def get_value() -> DescribeFlowExecutionRecordsRequestRequestTypeDef:
return {
"flowName": ...,
}
# DescribeFlowExecutionRecordsRequestRequestTypeDef definition
class DescribeFlowExecutionRecordsRequestRequestTypeDef(TypedDict):
flowName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
DescribeFlowRequestRequestTypeDef#
# DescribeFlowRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeFlowRequestRequestTypeDef
def get_value() -> DescribeFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
# DescribeFlowRequestRequestTypeDef definition
class DescribeFlowRequestRequestTypeDef(TypedDict):
flowName: str,
ExecutionDetailsTypeDef#
# ExecutionDetailsTypeDef usage example
from mypy_boto3_appflow.type_defs import ExecutionDetailsTypeDef
def get_value() -> ExecutionDetailsTypeDef:
return {
"mostRecentExecutionMessage": ...,
}
# ExecutionDetailsTypeDef definition
class ExecutionDetailsTypeDef(TypedDict):
mostRecentExecutionMessage: NotRequired[str],
mostRecentExecutionTime: NotRequired[datetime],
mostRecentExecutionStatus: NotRequired[ExecutionStatusType], # (1)
DynatraceSourcePropertiesTypeDef#
# DynatraceSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import DynatraceSourcePropertiesTypeDef
def get_value() -> DynatraceSourcePropertiesTypeDef:
return {
"object": ...,
}
# DynatraceSourcePropertiesTypeDef definition
class DynatraceSourcePropertiesTypeDef(TypedDict):
object: str,
ErrorInfoTypeDef#
# ErrorInfoTypeDef usage example
from mypy_boto3_appflow.type_defs import ErrorInfoTypeDef
def get_value() -> ErrorInfoTypeDef:
return {
"putFailuresCount": ...,
}
# ErrorInfoTypeDef definition
class ErrorInfoTypeDef(TypedDict):
putFailuresCount: NotRequired[int],
executionMessage: NotRequired[str],
RangeTypeDef#
# RangeTypeDef usage example
from mypy_boto3_appflow.type_defs import RangeTypeDef
def get_value() -> RangeTypeDef:
return {
"maximum": ...,
}
# RangeTypeDef definition
class RangeTypeDef(TypedDict):
maximum: NotRequired[float],
minimum: NotRequired[float],
GlueDataCatalogConfigTypeDef#
# GlueDataCatalogConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import GlueDataCatalogConfigTypeDef
def get_value() -> GlueDataCatalogConfigTypeDef:
return {
"roleArn": ...,
"databaseName": ...,
"tablePrefix": ...,
}
# GlueDataCatalogConfigTypeDef definition
class GlueDataCatalogConfigTypeDef(TypedDict):
roleArn: str,
databaseName: str,
tablePrefix: str,
GoogleAnalyticsSourcePropertiesTypeDef#
# GoogleAnalyticsSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import GoogleAnalyticsSourcePropertiesTypeDef
def get_value() -> GoogleAnalyticsSourcePropertiesTypeDef:
return {
"object": ...,
}
# GoogleAnalyticsSourcePropertiesTypeDef definition
class GoogleAnalyticsSourcePropertiesTypeDef(TypedDict):
object: str,
IncrementalPullConfigTypeDef#
# IncrementalPullConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import IncrementalPullConfigTypeDef
def get_value() -> IncrementalPullConfigTypeDef:
return {
"datetimeTypeFieldName": ...,
}
# IncrementalPullConfigTypeDef definition
class IncrementalPullConfigTypeDef(TypedDict):
datetimeTypeFieldName: NotRequired[str],
InforNexusSourcePropertiesTypeDef#
# InforNexusSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import InforNexusSourcePropertiesTypeDef
def get_value() -> InforNexusSourcePropertiesTypeDef:
return {
"object": ...,
}
# InforNexusSourcePropertiesTypeDef definition
class InforNexusSourcePropertiesTypeDef(TypedDict):
object: str,
ListConnectorEntitiesRequestRequestTypeDef#
# ListConnectorEntitiesRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import ListConnectorEntitiesRequestRequestTypeDef
def get_value() -> ListConnectorEntitiesRequestRequestTypeDef:
return {
"connectorProfileName": ...,
}
# ListConnectorEntitiesRequestRequestTypeDef definition
class ListConnectorEntitiesRequestRequestTypeDef(TypedDict):
connectorProfileName: NotRequired[str],
connectorType: NotRequired[ConnectorTypeType], # (1)
entitiesPath: NotRequired[str],
apiVersion: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListConnectorsRequestRequestTypeDef#
# ListConnectorsRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import ListConnectorsRequestRequestTypeDef
def get_value() -> ListConnectorsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListConnectorsRequestRequestTypeDef definition
class ListConnectorsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListFlowsRequestRequestTypeDef#
# ListFlowsRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import ListFlowsRequestRequestTypeDef
def get_value() -> ListFlowsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListFlowsRequestRequestTypeDef definition
class ListFlowsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MarketoSourcePropertiesTypeDef#
# MarketoSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import MarketoSourcePropertiesTypeDef
def get_value() -> MarketoSourcePropertiesTypeDef:
return {
"object": ...,
}
# MarketoSourcePropertiesTypeDef definition
class MarketoSourcePropertiesTypeDef(TypedDict):
object: str,
RegistrationOutputTypeDef#
# RegistrationOutputTypeDef usage example
from mypy_boto3_appflow.type_defs import RegistrationOutputTypeDef
def get_value() -> RegistrationOutputTypeDef:
return {
"message": ...,
}
# RegistrationOutputTypeDef definition
class RegistrationOutputTypeDef(TypedDict):
message: NotRequired[str],
result: NotRequired[str],
status: NotRequired[ExecutionStatusType], # (1)
OAuth2CustomParameterTypeDef#
# OAuth2CustomParameterTypeDef usage example
from mypy_boto3_appflow.type_defs import OAuth2CustomParameterTypeDef
def get_value() -> OAuth2CustomParameterTypeDef:
return {
"key": ...,
}
# 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)
OAuthPropertiesTypeDef#
# OAuthPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import OAuthPropertiesTypeDef
def get_value() -> OAuthPropertiesTypeDef:
return {
"tokenUrl": ...,
"authCodeUrl": ...,
"oAuthScopes": ...,
}
# OAuthPropertiesTypeDef definition
class OAuthPropertiesTypeDef(TypedDict):
tokenUrl: str,
authCodeUrl: str,
oAuthScopes: Sequence[str],
PardotSourcePropertiesTypeDef#
# PardotSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import PardotSourcePropertiesTypeDef
def get_value() -> PardotSourcePropertiesTypeDef:
return {
"object": ...,
}
# PardotSourcePropertiesTypeDef definition
class PardotSourcePropertiesTypeDef(TypedDict):
object: str,
PrefixConfigTypeDef#
# PrefixConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import PrefixConfigTypeDef
def get_value() -> PrefixConfigTypeDef:
return {
"prefixType": ...,
}
# PrefixConfigTypeDef definition
class PrefixConfigTypeDef(TypedDict):
prefixType: NotRequired[PrefixTypeType], # (1)
prefixFormat: NotRequired[PrefixFormatType], # (2)
pathPrefixHierarchy: NotRequired[Sequence[PathPrefixType]], # (3)
- See PrefixTypeType
- See PrefixFormatType
- See PathPrefixType
RegisterConnectorResponseTypeDef#
# RegisterConnectorResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import RegisterConnectorResponseTypeDef
def get_value() -> RegisterConnectorResponseTypeDef:
return {
"connectorArn": ...,
"ResponseMetadata": ...,
}
# RegisterConnectorResponseTypeDef definition
class RegisterConnectorResponseTypeDef(TypedDict):
connectorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
S3InputFormatConfigTypeDef#
# S3InputFormatConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import S3InputFormatConfigTypeDef
def get_value() -> S3InputFormatConfigTypeDef:
return {
"s3InputFileType": ...,
}
# S3InputFormatConfigTypeDef definition
class S3InputFormatConfigTypeDef(TypedDict):
s3InputFileType: NotRequired[S3InputFileTypeType], # (1)
SuccessResponseHandlingConfigTypeDef#
# SuccessResponseHandlingConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import SuccessResponseHandlingConfigTypeDef
def get_value() -> SuccessResponseHandlingConfigTypeDef:
return {
"bucketPrefix": ...,
}
# SuccessResponseHandlingConfigTypeDef definition
class SuccessResponseHandlingConfigTypeDef(TypedDict):
bucketPrefix: NotRequired[str],
bucketName: NotRequired[str],
SAPODataSourcePropertiesTypeDef#
# SAPODataSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SAPODataSourcePropertiesTypeDef
def get_value() -> SAPODataSourcePropertiesTypeDef:
return {
"objectPath": ...,
}
# SAPODataSourcePropertiesTypeDef definition
class SAPODataSourcePropertiesTypeDef(TypedDict):
objectPath: NotRequired[str],
SalesforceSourcePropertiesTypeDef#
# SalesforceSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SalesforceSourcePropertiesTypeDef
def get_value() -> SalesforceSourcePropertiesTypeDef:
return {
"object": ...,
}
# SalesforceSourcePropertiesTypeDef definition
class SalesforceSourcePropertiesTypeDef(TypedDict):
object: str,
enableDynamicFieldUpdate: NotRequired[bool],
includeDeletedRecords: NotRequired[bool],
dataTransferApi: NotRequired[SalesforceDataTransferApiType], # (1)
ScheduledTriggerPropertiesTypeDef#
# ScheduledTriggerPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import ScheduledTriggerPropertiesTypeDef
def get_value() -> ScheduledTriggerPropertiesTypeDef:
return {
"scheduleExpression": ...,
}
# 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],
- See DataPullModeType
ServiceNowSourcePropertiesTypeDef#
# ServiceNowSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import ServiceNowSourcePropertiesTypeDef
def get_value() -> ServiceNowSourcePropertiesTypeDef:
return {
"object": ...,
}
# ServiceNowSourcePropertiesTypeDef definition
class ServiceNowSourcePropertiesTypeDef(TypedDict):
object: str,
SingularSourcePropertiesTypeDef#
# SingularSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SingularSourcePropertiesTypeDef
def get_value() -> SingularSourcePropertiesTypeDef:
return {
"object": ...,
}
# SingularSourcePropertiesTypeDef definition
class SingularSourcePropertiesTypeDef(TypedDict):
object: str,
SlackSourcePropertiesTypeDef#
# SlackSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SlackSourcePropertiesTypeDef
def get_value() -> SlackSourcePropertiesTypeDef:
return {
"object": ...,
}
# SlackSourcePropertiesTypeDef definition
class SlackSourcePropertiesTypeDef(TypedDict):
object: str,
TrendmicroSourcePropertiesTypeDef#
# TrendmicroSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import TrendmicroSourcePropertiesTypeDef
def get_value() -> TrendmicroSourcePropertiesTypeDef:
return {
"object": ...,
}
# TrendmicroSourcePropertiesTypeDef definition
class TrendmicroSourcePropertiesTypeDef(TypedDict):
object: str,
VeevaSourcePropertiesTypeDef#
# VeevaSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import VeevaSourcePropertiesTypeDef
def get_value() -> VeevaSourcePropertiesTypeDef:
return {
"object": ...,
}
# VeevaSourcePropertiesTypeDef definition
class VeevaSourcePropertiesTypeDef(TypedDict):
object: str,
documentType: NotRequired[str],
includeSourceFiles: NotRequired[bool],
includeRenditions: NotRequired[bool],
includeAllVersions: NotRequired[bool],
ZendeskSourcePropertiesTypeDef#
# ZendeskSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import ZendeskSourcePropertiesTypeDef
def get_value() -> ZendeskSourcePropertiesTypeDef:
return {
"object": ...,
}
# ZendeskSourcePropertiesTypeDef definition
class ZendeskSourcePropertiesTypeDef(TypedDict):
object: str,
StartFlowRequestRequestTypeDef#
# StartFlowRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import StartFlowRequestRequestTypeDef
def get_value() -> StartFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
# StartFlowRequestRequestTypeDef definition
class StartFlowRequestRequestTypeDef(TypedDict):
flowName: str,
clientToken: NotRequired[str],
StartFlowResponseTypeDef#
# StartFlowResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import StartFlowResponseTypeDef
def get_value() -> StartFlowResponseTypeDef:
return {
"flowArn": ...,
"flowStatus": ...,
"executionId": ...,
"ResponseMetadata": ...,
}
# StartFlowResponseTypeDef definition
class StartFlowResponseTypeDef(TypedDict):
flowArn: str,
flowStatus: FlowStatusType, # (1)
executionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopFlowRequestRequestTypeDef#
# StopFlowRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import StopFlowRequestRequestTypeDef
def get_value() -> StopFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
# StopFlowRequestRequestTypeDef definition
class StopFlowRequestRequestTypeDef(TypedDict):
flowName: str,
StopFlowResponseTypeDef#
# StopFlowResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import StopFlowResponseTypeDef
def get_value() -> StopFlowResponseTypeDef:
return {
"flowArn": ...,
"flowStatus": ...,
"ResponseMetadata": ...,
}
# StopFlowResponseTypeDef definition
class StopFlowResponseTypeDef(TypedDict):
flowArn: str,
flowStatus: FlowStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UnregisterConnectorRequestRequestTypeDef#
# UnregisterConnectorRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import UnregisterConnectorRequestRequestTypeDef
def get_value() -> UnregisterConnectorRequestRequestTypeDef:
return {
"connectorLabel": ...,
}
# UnregisterConnectorRequestRequestTypeDef definition
class UnregisterConnectorRequestRequestTypeDef(TypedDict):
connectorLabel: str,
forceDelete: NotRequired[bool],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateConnectorProfileResponseTypeDef#
# UpdateConnectorProfileResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import UpdateConnectorProfileResponseTypeDef
def get_value() -> UpdateConnectorProfileResponseTypeDef:
return {
"connectorProfileArn": ...,
"ResponseMetadata": ...,
}
# UpdateConnectorProfileResponseTypeDef definition
class UpdateConnectorProfileResponseTypeDef(TypedDict):
connectorProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateConnectorRegistrationResponseTypeDef#
# UpdateConnectorRegistrationResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import UpdateConnectorRegistrationResponseTypeDef
def get_value() -> UpdateConnectorRegistrationResponseTypeDef:
return {
"connectorArn": ...,
"ResponseMetadata": ...,
}
# UpdateConnectorRegistrationResponseTypeDef definition
class UpdateConnectorRegistrationResponseTypeDef(TypedDict):
connectorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateFlowResponseTypeDef#
# UpdateFlowResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import UpdateFlowResponseTypeDef
def get_value() -> UpdateFlowResponseTypeDef:
return {
"flowStatus": ...,
"ResponseMetadata": ...,
}
# UpdateFlowResponseTypeDef definition
class UpdateFlowResponseTypeDef(TypedDict):
flowStatus: FlowStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CustomAuthConfigTypeDef#
# CustomAuthConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import CustomAuthConfigTypeDef
def get_value() -> CustomAuthConfigTypeDef:
return {
"customAuthenticationType": ...,
}
# CustomAuthConfigTypeDef definition
class CustomAuthConfigTypeDef(TypedDict):
customAuthenticationType: NotRequired[str],
authParameters: NotRequired[List[AuthParameterTypeDef]], # (1)
CustomConnectorSourcePropertiesTypeDef#
# CustomConnectorSourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import CustomConnectorSourcePropertiesTypeDef
def get_value() -> CustomConnectorSourcePropertiesTypeDef:
return {
"entityName": ...,
}
# CustomConnectorSourcePropertiesTypeDef definition
class CustomConnectorSourcePropertiesTypeDef(TypedDict):
entityName: str,
customProperties: NotRequired[Mapping[str, str]],
dataTransferApi: NotRequired[DataTransferApiTypeDef], # (1)
ListConnectorsResponseTypeDef#
# ListConnectorsResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import ListConnectorsResponseTypeDef
def get_value() -> ListConnectorsResponseTypeDef:
return {
"connectors": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListConnectorsResponseTypeDef definition
class ListConnectorsResponseTypeDef(TypedDict):
connectors: List[ConnectorDetailTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConnectorEntitiesResponseTypeDef#
# ListConnectorEntitiesResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import ListConnectorEntitiesResponseTypeDef
def get_value() -> ListConnectorEntitiesResponseTypeDef:
return {
"connectorEntityMap": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListConnectorEntitiesResponseTypeDef definition
class ListConnectorEntitiesResponseTypeDef(TypedDict):
connectorEntityMap: Dict[str, List[ConnectorEntityTypeDef]], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConnectorMetadataTypeDef#
# ConnectorMetadataTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorMetadataTypeDef
def get_value() -> ConnectorMetadataTypeDef:
return {
"Amplitude": ...,
}
# 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]],
- See GoogleAnalyticsMetadataTypeDef
- See SalesforceMetadataTypeDef
- See SlackMetadataTypeDef
- See SnowflakeMetadataTypeDef
- See ZendeskMetadataTypeDef
- See HoneycodeMetadataTypeDef
GoogleAnalyticsConnectorProfileCredentialsTypeDef#
# GoogleAnalyticsConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import GoogleAnalyticsConnectorProfileCredentialsTypeDef
def get_value() -> GoogleAnalyticsConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
# GoogleAnalyticsConnectorProfileCredentialsTypeDef definition
class GoogleAnalyticsConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
HoneycodeConnectorProfileCredentialsTypeDef#
# HoneycodeConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import HoneycodeConnectorProfileCredentialsTypeDef
def get_value() -> HoneycodeConnectorProfileCredentialsTypeDef:
return {
"accessToken": ...,
}
# HoneycodeConnectorProfileCredentialsTypeDef definition
class HoneycodeConnectorProfileCredentialsTypeDef(TypedDict):
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
MarketoConnectorProfileCredentialsTypeDef#
# MarketoConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import MarketoConnectorProfileCredentialsTypeDef
def get_value() -> MarketoConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
# MarketoConnectorProfileCredentialsTypeDef definition
class MarketoConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
OAuth2CredentialsTypeDef#
# OAuth2CredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import OAuth2CredentialsTypeDef
def get_value() -> OAuth2CredentialsTypeDef:
return {
"clientId": ...,
}
# OAuth2CredentialsTypeDef definition
class OAuth2CredentialsTypeDef(TypedDict):
clientId: NotRequired[str],
clientSecret: NotRequired[str],
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
OAuthCredentialsTypeDef#
# OAuthCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import OAuthCredentialsTypeDef
def get_value() -> OAuthCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
# OAuthCredentialsTypeDef definition
class OAuthCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
PardotConnectorProfileCredentialsTypeDef#
# PardotConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import PardotConnectorProfileCredentialsTypeDef
def get_value() -> PardotConnectorProfileCredentialsTypeDef:
return {
"accessToken": ...,
}
# PardotConnectorProfileCredentialsTypeDef definition
class PardotConnectorProfileCredentialsTypeDef(TypedDict):
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
clientCredentialsArn: NotRequired[str],
SalesforceConnectorProfileCredentialsTypeDef#
# SalesforceConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import SalesforceConnectorProfileCredentialsTypeDef
def get_value() -> SalesforceConnectorProfileCredentialsTypeDef:
return {
"accessToken": ...,
}
# 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],
SlackConnectorProfileCredentialsTypeDef#
# SlackConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import SlackConnectorProfileCredentialsTypeDef
def get_value() -> SlackConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
# SlackConnectorProfileCredentialsTypeDef definition
class SlackConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
ZendeskConnectorProfileCredentialsTypeDef#
# ZendeskConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import ZendeskConnectorProfileCredentialsTypeDef
def get_value() -> ZendeskConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
# ZendeskConnectorProfileCredentialsTypeDef definition
class ZendeskConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
TaskTypeDef#
# TaskTypeDef usage example
from mypy_boto3_appflow.type_defs import TaskTypeDef
def get_value() -> TaskTypeDef:
return {
"sourceFields": ...,
"taskType": ...,
}
# TaskTypeDef definition
class TaskTypeDef(TypedDict):
sourceFields: Sequence[str],
taskType: TaskTypeType, # (2)
connectorOperator: NotRequired[ConnectorOperatorTypeDef], # (1)
destinationField: NotRequired[str],
taskProperties: NotRequired[Mapping[OperatorPropertiesKeysType, str]], # (3)
ConnectorProvisioningConfigTypeDef#
# ConnectorProvisioningConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorProvisioningConfigTypeDef
def get_value() -> ConnectorProvisioningConfigTypeDef:
return {
"lambda": ...,
}
# ConnectorProvisioningConfigTypeDef definition
class ConnectorProvisioningConfigTypeDef(TypedDict):
lambda: NotRequired[LambdaConnectorProvisioningConfigTypeDef], # (1)
CustomConnectorDestinationPropertiesTypeDef#
# CustomConnectorDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import CustomConnectorDestinationPropertiesTypeDef
def get_value() -> CustomConnectorDestinationPropertiesTypeDef:
return {
"entityName": ...,
}
# CustomConnectorDestinationPropertiesTypeDef definition
class CustomConnectorDestinationPropertiesTypeDef(TypedDict):
entityName: str,
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
writeOperationType: NotRequired[WriteOperationTypeType], # (2)
idFieldNames: NotRequired[Sequence[str]],
customProperties: NotRequired[Mapping[str, str]],
EventBridgeDestinationPropertiesTypeDef#
# EventBridgeDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import EventBridgeDestinationPropertiesTypeDef
def get_value() -> EventBridgeDestinationPropertiesTypeDef:
return {
"object": ...,
}
# EventBridgeDestinationPropertiesTypeDef definition
class EventBridgeDestinationPropertiesTypeDef(TypedDict):
object: str,
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
HoneycodeDestinationPropertiesTypeDef#
# HoneycodeDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import HoneycodeDestinationPropertiesTypeDef
def get_value() -> HoneycodeDestinationPropertiesTypeDef:
return {
"object": ...,
}
# HoneycodeDestinationPropertiesTypeDef definition
class HoneycodeDestinationPropertiesTypeDef(TypedDict):
object: str,
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
MarketoDestinationPropertiesTypeDef#
# MarketoDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import MarketoDestinationPropertiesTypeDef
def get_value() -> MarketoDestinationPropertiesTypeDef:
return {
"object": ...,
}
# MarketoDestinationPropertiesTypeDef definition
class MarketoDestinationPropertiesTypeDef(TypedDict):
object: str,
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
RedshiftDestinationPropertiesTypeDef#
# RedshiftDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import RedshiftDestinationPropertiesTypeDef
def get_value() -> RedshiftDestinationPropertiesTypeDef:
return {
"object": ...,
"intermediateBucketName": ...,
}
# RedshiftDestinationPropertiesTypeDef definition
class RedshiftDestinationPropertiesTypeDef(TypedDict):
object: str,
intermediateBucketName: str,
bucketPrefix: NotRequired[str],
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
SalesforceDestinationPropertiesTypeDef#
# SalesforceDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SalesforceDestinationPropertiesTypeDef
def get_value() -> SalesforceDestinationPropertiesTypeDef:
return {
"object": ...,
}
# SalesforceDestinationPropertiesTypeDef definition
class SalesforceDestinationPropertiesTypeDef(TypedDict):
object: str,
idFieldNames: NotRequired[Sequence[str]],
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
writeOperationType: NotRequired[WriteOperationTypeType], # (2)
dataTransferApi: NotRequired[SalesforceDataTransferApiType], # (3)
SnowflakeDestinationPropertiesTypeDef#
# SnowflakeDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SnowflakeDestinationPropertiesTypeDef
def get_value() -> SnowflakeDestinationPropertiesTypeDef:
return {
"object": ...,
"intermediateBucketName": ...,
}
# SnowflakeDestinationPropertiesTypeDef definition
class SnowflakeDestinationPropertiesTypeDef(TypedDict):
object: str,
intermediateBucketName: str,
bucketPrefix: NotRequired[str],
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
ZendeskDestinationPropertiesTypeDef#
# ZendeskDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import ZendeskDestinationPropertiesTypeDef
def get_value() -> ZendeskDestinationPropertiesTypeDef:
return {
"object": ...,
}
# ZendeskDestinationPropertiesTypeDef definition
class ZendeskDestinationPropertiesTypeDef(TypedDict):
object: str,
idFieldNames: NotRequired[Sequence[str]],
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (1)
writeOperationType: NotRequired[WriteOperationTypeType], # (2)
CustomConnectorProfilePropertiesTypeDef#
# CustomConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import CustomConnectorProfilePropertiesTypeDef
def get_value() -> CustomConnectorProfilePropertiesTypeDef:
return {
"profileProperties": ...,
}
# CustomConnectorProfilePropertiesTypeDef definition
class CustomConnectorProfilePropertiesTypeDef(TypedDict):
profileProperties: NotRequired[Mapping[str, str]],
oAuth2Properties: NotRequired[OAuth2PropertiesTypeDef], # (1)
FlowDefinitionTypeDef#
# FlowDefinitionTypeDef usage example
from mypy_boto3_appflow.type_defs import FlowDefinitionTypeDef
def get_value() -> FlowDefinitionTypeDef:
return {
"flowArn": ...,
}
# 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)
- See FlowStatusType
- See ConnectorTypeType
- See ConnectorTypeType
- See TriggerTypeType
- See ExecutionDetailsTypeDef
ExecutionResultTypeDef#
# ExecutionResultTypeDef usage example
from mypy_boto3_appflow.type_defs import ExecutionResultTypeDef
def get_value() -> ExecutionResultTypeDef:
return {
"errorInfo": ...,
}
# ExecutionResultTypeDef definition
class ExecutionResultTypeDef(TypedDict):
errorInfo: NotRequired[ErrorInfoTypeDef], # (1)
bytesProcessed: NotRequired[int],
bytesWritten: NotRequired[int],
recordsProcessed: NotRequired[int],
- See ErrorInfoTypeDef
FieldTypeDetailsTypeDef#
# FieldTypeDetailsTypeDef usage example
from mypy_boto3_appflow.type_defs import FieldTypeDetailsTypeDef
def get_value() -> FieldTypeDetailsTypeDef:
return {
"fieldType": ...,
"filterOperators": ...,
}
# 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)
- See OperatorType
- See RangeTypeDef
- See RangeTypeDef
MetadataCatalogConfigTypeDef#
# MetadataCatalogConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import MetadataCatalogConfigTypeDef
def get_value() -> MetadataCatalogConfigTypeDef:
return {
"glueDataCatalog": ...,
}
# MetadataCatalogConfigTypeDef definition
class MetadataCatalogConfigTypeDef(TypedDict):
glueDataCatalog: NotRequired[GlueDataCatalogConfigTypeDef], # (1)
MetadataCatalogDetailTypeDef#
# MetadataCatalogDetailTypeDef usage example
from mypy_boto3_appflow.type_defs import MetadataCatalogDetailTypeDef
def get_value() -> MetadataCatalogDetailTypeDef:
return {
"catalogType": ...,
}
# MetadataCatalogDetailTypeDef definition
class MetadataCatalogDetailTypeDef(TypedDict):
catalogType: NotRequired[CatalogTypeType], # (1)
tableName: NotRequired[str],
tableRegistrationOutput: NotRequired[RegistrationOutputTypeDef], # (2)
partitionRegistrationOutput: NotRequired[RegistrationOutputTypeDef], # (2)
OAuth2DefaultsTypeDef#
# OAuth2DefaultsTypeDef usage example
from mypy_boto3_appflow.type_defs import OAuth2DefaultsTypeDef
def get_value() -> OAuth2DefaultsTypeDef:
return {
"oauthScopes": ...,
}
# 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)
SAPODataConnectorProfilePropertiesTypeDef#
# SAPODataConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SAPODataConnectorProfilePropertiesTypeDef
def get_value() -> SAPODataConnectorProfilePropertiesTypeDef:
return {
"applicationHostUrl": ...,
"applicationServicePath": ...,
"portNumber": ...,
"clientNumber": ...,
}
# SAPODataConnectorProfilePropertiesTypeDef definition
class SAPODataConnectorProfilePropertiesTypeDef(TypedDict):
applicationHostUrl: str,
applicationServicePath: str,
portNumber: int,
clientNumber: str,
logonLanguage: NotRequired[str],
privateLinkServiceName: NotRequired[str],
oAuthProperties: NotRequired[OAuthPropertiesTypeDef], # (1)
S3OutputFormatConfigTypeDef#
# S3OutputFormatConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import S3OutputFormatConfigTypeDef
def get_value() -> S3OutputFormatConfigTypeDef:
return {
"fileType": ...,
}
# S3OutputFormatConfigTypeDef definition
class S3OutputFormatConfigTypeDef(TypedDict):
fileType: NotRequired[FileTypeType], # (1)
prefixConfig: NotRequired[PrefixConfigTypeDef], # (2)
aggregationConfig: NotRequired[AggregationConfigTypeDef], # (3)
preserveSourceDataTyping: NotRequired[bool],
- See FileTypeType
- See PrefixConfigTypeDef
- See AggregationConfigTypeDef
UpsolverS3OutputFormatConfigTypeDef#
# UpsolverS3OutputFormatConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import UpsolverS3OutputFormatConfigTypeDef
def get_value() -> UpsolverS3OutputFormatConfigTypeDef:
return {
"prefixConfig": ...,
}
# UpsolverS3OutputFormatConfigTypeDef definition
class UpsolverS3OutputFormatConfigTypeDef(TypedDict):
prefixConfig: PrefixConfigTypeDef, # (2)
fileType: NotRequired[FileTypeType], # (1)
aggregationConfig: NotRequired[AggregationConfigTypeDef], # (3)
- See FileTypeType
- See PrefixConfigTypeDef
- See AggregationConfigTypeDef
S3SourcePropertiesTypeDef#
# S3SourcePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import S3SourcePropertiesTypeDef
def get_value() -> S3SourcePropertiesTypeDef:
return {
"bucketName": ...,
}
# S3SourcePropertiesTypeDef definition
class S3SourcePropertiesTypeDef(TypedDict):
bucketName: str,
bucketPrefix: NotRequired[str],
s3InputFormatConfig: NotRequired[S3InputFormatConfigTypeDef], # (1)
SAPODataDestinationPropertiesTypeDef#
# SAPODataDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SAPODataDestinationPropertiesTypeDef
def get_value() -> SAPODataDestinationPropertiesTypeDef:
return {
"objectPath": ...,
}
# SAPODataDestinationPropertiesTypeDef definition
class SAPODataDestinationPropertiesTypeDef(TypedDict):
objectPath: str,
successResponseHandlingConfig: NotRequired[SuccessResponseHandlingConfigTypeDef], # (1)
idFieldNames: NotRequired[Sequence[str]],
errorHandlingConfig: NotRequired[ErrorHandlingConfigTypeDef], # (2)
writeOperationType: NotRequired[WriteOperationTypeType], # (3)
TriggerPropertiesTypeDef#
# TriggerPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import TriggerPropertiesTypeDef
def get_value() -> TriggerPropertiesTypeDef:
return {
"Scheduled": ...,
}
# TriggerPropertiesTypeDef definition
class TriggerPropertiesTypeDef(TypedDict):
Scheduled: NotRequired[ScheduledTriggerPropertiesTypeDef], # (1)
CustomConnectorProfileCredentialsTypeDef#
# CustomConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import CustomConnectorProfileCredentialsTypeDef
def get_value() -> CustomConnectorProfileCredentialsTypeDef:
return {
"authenticationType": ...,
}
# CustomConnectorProfileCredentialsTypeDef definition
class CustomConnectorProfileCredentialsTypeDef(TypedDict):
authenticationType: AuthenticationTypeType, # (1)
basic: NotRequired[BasicAuthCredentialsTypeDef], # (2)
oauth2: NotRequired[OAuth2CredentialsTypeDef], # (3)
apiKey: NotRequired[ApiKeyCredentialsTypeDef], # (4)
custom: NotRequired[CustomAuthCredentialsTypeDef], # (5)
- See AuthenticationTypeType
- See BasicAuthCredentialsTypeDef
- See OAuth2CredentialsTypeDef
- See ApiKeyCredentialsTypeDef
- See CustomAuthCredentialsTypeDef
SAPODataConnectorProfileCredentialsTypeDef#
# SAPODataConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import SAPODataConnectorProfileCredentialsTypeDef
def get_value() -> SAPODataConnectorProfileCredentialsTypeDef:
return {
"basicAuthCredentials": ...,
}
# SAPODataConnectorProfileCredentialsTypeDef definition
class SAPODataConnectorProfileCredentialsTypeDef(TypedDict):
basicAuthCredentials: NotRequired[BasicAuthCredentialsTypeDef], # (1)
oAuthCredentials: NotRequired[OAuthCredentialsTypeDef], # (2)
RegisterConnectorRequestRequestTypeDef#
# RegisterConnectorRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import RegisterConnectorRequestRequestTypeDef
def get_value() -> RegisterConnectorRequestRequestTypeDef:
return {
"connectorLabel": ...,
}
# RegisterConnectorRequestRequestTypeDef definition
class RegisterConnectorRequestRequestTypeDef(TypedDict):
connectorLabel: NotRequired[str],
description: NotRequired[str],
connectorProvisioningType: NotRequired[ConnectorProvisioningTypeType], # (1)
connectorProvisioningConfig: NotRequired[ConnectorProvisioningConfigTypeDef], # (2)
clientToken: NotRequired[str],
UpdateConnectorRegistrationRequestRequestTypeDef#
# UpdateConnectorRegistrationRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import UpdateConnectorRegistrationRequestRequestTypeDef
def get_value() -> UpdateConnectorRegistrationRequestRequestTypeDef:
return {
"connectorLabel": ...,
}
# UpdateConnectorRegistrationRequestRequestTypeDef definition
class UpdateConnectorRegistrationRequestRequestTypeDef(TypedDict):
connectorLabel: str,
description: NotRequired[str],
connectorProvisioningConfig: NotRequired[ConnectorProvisioningConfigTypeDef], # (1)
clientToken: NotRequired[str],
ListFlowsResponseTypeDef#
# ListFlowsResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import ListFlowsResponseTypeDef
def get_value() -> ListFlowsResponseTypeDef:
return {
"flows": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListFlowsResponseTypeDef definition
class ListFlowsResponseTypeDef(TypedDict):
flows: List[FlowDefinitionTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SupportedFieldTypeDetailsTypeDef#
# SupportedFieldTypeDetailsTypeDef usage example
from mypy_boto3_appflow.type_defs import SupportedFieldTypeDetailsTypeDef
def get_value() -> SupportedFieldTypeDetailsTypeDef:
return {
"v1": ...,
}
# SupportedFieldTypeDetailsTypeDef definition
class SupportedFieldTypeDetailsTypeDef(TypedDict):
v1: FieldTypeDetailsTypeDef, # (1)
ExecutionRecordTypeDef#
# ExecutionRecordTypeDef usage example
from mypy_boto3_appflow.type_defs import ExecutionRecordTypeDef
def get_value() -> ExecutionRecordTypeDef:
return {
"executionId": ...,
}
# 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)
AuthenticationConfigTypeDef#
# AuthenticationConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import AuthenticationConfigTypeDef
def get_value() -> AuthenticationConfigTypeDef:
return {
"isBasicAuthSupported": ...,
}
# 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)
ConnectorProfilePropertiesTypeDef#
# ConnectorProfilePropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorProfilePropertiesTypeDef
def get_value() -> ConnectorProfilePropertiesTypeDef:
return {
"Amplitude": ...,
}
# 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)
- See DatadogConnectorProfilePropertiesTypeDef
- See DynatraceConnectorProfilePropertiesTypeDef
- See InforNexusConnectorProfilePropertiesTypeDef
- See MarketoConnectorProfilePropertiesTypeDef
- See RedshiftConnectorProfilePropertiesTypeDef
- See SalesforceConnectorProfilePropertiesTypeDef
- See ServiceNowConnectorProfilePropertiesTypeDef
- See SlackConnectorProfilePropertiesTypeDef
- See SnowflakeConnectorProfilePropertiesTypeDef
- See VeevaConnectorProfilePropertiesTypeDef
- See ZendeskConnectorProfilePropertiesTypeDef
- See SAPODataConnectorProfilePropertiesTypeDef
- See CustomConnectorProfilePropertiesTypeDef
- See PardotConnectorProfilePropertiesTypeDef
S3DestinationPropertiesTypeDef#
# S3DestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import S3DestinationPropertiesTypeDef
def get_value() -> S3DestinationPropertiesTypeDef:
return {
"bucketName": ...,
}
# S3DestinationPropertiesTypeDef definition
class S3DestinationPropertiesTypeDef(TypedDict):
bucketName: str,
bucketPrefix: NotRequired[str],
s3OutputFormatConfig: NotRequired[S3OutputFormatConfigTypeDef], # (1)
UpsolverDestinationPropertiesTypeDef#
# UpsolverDestinationPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import UpsolverDestinationPropertiesTypeDef
def get_value() -> UpsolverDestinationPropertiesTypeDef:
return {
"bucketName": ...,
"s3OutputFormatConfig": ...,
}
# UpsolverDestinationPropertiesTypeDef definition
class UpsolverDestinationPropertiesTypeDef(TypedDict):
bucketName: str,
s3OutputFormatConfig: UpsolverS3OutputFormatConfigTypeDef, # (1)
bucketPrefix: NotRequired[str],
SourceConnectorPropertiesTypeDef#
# SourceConnectorPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import SourceConnectorPropertiesTypeDef
def get_value() -> SourceConnectorPropertiesTypeDef:
return {
"Amplitude": ...,
}
# 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)
- See AmplitudeSourcePropertiesTypeDef
- See DatadogSourcePropertiesTypeDef
- See DynatraceSourcePropertiesTypeDef
- See GoogleAnalyticsSourcePropertiesTypeDef
- See InforNexusSourcePropertiesTypeDef
- See MarketoSourcePropertiesTypeDef
- See S3SourcePropertiesTypeDef
- See SalesforceSourcePropertiesTypeDef
- See ServiceNowSourcePropertiesTypeDef
- See SingularSourcePropertiesTypeDef
- See SlackSourcePropertiesTypeDef
- See TrendmicroSourcePropertiesTypeDef
- See VeevaSourcePropertiesTypeDef
- See ZendeskSourcePropertiesTypeDef
- See SAPODataSourcePropertiesTypeDef
- See CustomConnectorSourcePropertiesTypeDef
- See PardotSourcePropertiesTypeDef
TriggerConfigTypeDef#
# TriggerConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import TriggerConfigTypeDef
def get_value() -> TriggerConfigTypeDef:
return {
"triggerType": ...,
}
# TriggerConfigTypeDef definition
class TriggerConfigTypeDef(TypedDict):
triggerType: TriggerTypeType, # (1)
triggerProperties: NotRequired[TriggerPropertiesTypeDef], # (2)
ConnectorProfileCredentialsTypeDef#
# ConnectorProfileCredentialsTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorProfileCredentialsTypeDef
def get_value() -> ConnectorProfileCredentialsTypeDef:
return {
"Amplitude": ...,
}
# 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)
- See AmplitudeConnectorProfileCredentialsTypeDef
- See DatadogConnectorProfileCredentialsTypeDef
- See DynatraceConnectorProfileCredentialsTypeDef
- See GoogleAnalyticsConnectorProfileCredentialsTypeDef
- See HoneycodeConnectorProfileCredentialsTypeDef
- See InforNexusConnectorProfileCredentialsTypeDef
- See MarketoConnectorProfileCredentialsTypeDef
- See RedshiftConnectorProfileCredentialsTypeDef
- See SalesforceConnectorProfileCredentialsTypeDef
- See ServiceNowConnectorProfileCredentialsTypeDef
- See SingularConnectorProfileCredentialsTypeDef
- See SlackConnectorProfileCredentialsTypeDef
- See SnowflakeConnectorProfileCredentialsTypeDef
- See TrendmicroConnectorProfileCredentialsTypeDef
- See VeevaConnectorProfileCredentialsTypeDef
- See ZendeskConnectorProfileCredentialsTypeDef
- See SAPODataConnectorProfileCredentialsTypeDef
- See CustomConnectorProfileCredentialsTypeDef
- See PardotConnectorProfileCredentialsTypeDef
ConnectorEntityFieldTypeDef#
# ConnectorEntityFieldTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorEntityFieldTypeDef
def get_value() -> ConnectorEntityFieldTypeDef:
return {
"identifier": ...,
}
# 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]],
- See SupportedFieldTypeDetailsTypeDef
- See SourceFieldPropertiesTypeDef
- See DestinationFieldPropertiesTypeDef
DescribeFlowExecutionRecordsResponseTypeDef#
# DescribeFlowExecutionRecordsResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeFlowExecutionRecordsResponseTypeDef
def get_value() -> DescribeFlowExecutionRecordsResponseTypeDef:
return {
"flowExecutions": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# DescribeFlowExecutionRecordsResponseTypeDef definition
class DescribeFlowExecutionRecordsResponseTypeDef(TypedDict):
flowExecutions: List[ExecutionRecordTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConnectorConfigurationTypeDef#
# ConnectorConfigurationTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorConfigurationTypeDef
def get_value() -> ConnectorConfigurationTypeDef:
return {
"canUseAsSource": ...,
}
# 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)
- See ConnectorTypeType
- See ScheduleFrequencyTypeType
- See TriggerTypeType
- See ConnectorMetadataTypeDef
- See ConnectorTypeType
- See AuthenticationConfigTypeDef
- See ConnectorRuntimeSettingTypeDef
- See OperatorsType
- See WriteOperationTypeType
- See ConnectorProvisioningTypeType
- See ConnectorProvisioningConfigTypeDef
- See SupportedDataTransferTypeType
- See DataTransferApiTypeDef
ConnectorProfileTypeDef#
# ConnectorProfileTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorProfileTypeDef
def get_value() -> ConnectorProfileTypeDef:
return {
"connectorProfileArn": ...,
}
# 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)
- See ConnectorTypeType
- See ConnectionModeType
- See ConnectorProfilePropertiesTypeDef
- See PrivateConnectionProvisioningStateTypeDef
DestinationConnectorPropertiesTypeDef#
# DestinationConnectorPropertiesTypeDef usage example
from mypy_boto3_appflow.type_defs import DestinationConnectorPropertiesTypeDef
def get_value() -> DestinationConnectorPropertiesTypeDef:
return {
"Redshift": ...,
}
# 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)
- See RedshiftDestinationPropertiesTypeDef
- See S3DestinationPropertiesTypeDef
- See SalesforceDestinationPropertiesTypeDef
- See SnowflakeDestinationPropertiesTypeDef
- See EventBridgeDestinationPropertiesTypeDef
- See UpsolverDestinationPropertiesTypeDef
- See HoneycodeDestinationPropertiesTypeDef
- See CustomerProfilesDestinationPropertiesTypeDef
- See ZendeskDestinationPropertiesTypeDef
- See MarketoDestinationPropertiesTypeDef
- See CustomConnectorDestinationPropertiesTypeDef
- See SAPODataDestinationPropertiesTypeDef
SourceFlowConfigTypeDef#
# SourceFlowConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import SourceFlowConfigTypeDef
def get_value() -> SourceFlowConfigTypeDef:
return {
"connectorType": ...,
"sourceConnectorProperties": ...,
}
# SourceFlowConfigTypeDef definition
class SourceFlowConfigTypeDef(TypedDict):
connectorType: ConnectorTypeType, # (1)
sourceConnectorProperties: SourceConnectorPropertiesTypeDef, # (2)
apiVersion: NotRequired[str],
connectorProfileName: NotRequired[str],
incrementalPullConfig: NotRequired[IncrementalPullConfigTypeDef], # (3)
ConnectorProfileConfigTypeDef#
# ConnectorProfileConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import ConnectorProfileConfigTypeDef
def get_value() -> ConnectorProfileConfigTypeDef:
return {
"connectorProfileProperties": ...,
}
# ConnectorProfileConfigTypeDef definition
class ConnectorProfileConfigTypeDef(TypedDict):
connectorProfileProperties: ConnectorProfilePropertiesTypeDef, # (1)
connectorProfileCredentials: NotRequired[ConnectorProfileCredentialsTypeDef], # (2)
DescribeConnectorEntityResponseTypeDef#
# DescribeConnectorEntityResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorEntityResponseTypeDef
def get_value() -> DescribeConnectorEntityResponseTypeDef:
return {
"connectorEntityFields": ...,
"ResponseMetadata": ...,
}
# DescribeConnectorEntityResponseTypeDef definition
class DescribeConnectorEntityResponseTypeDef(TypedDict):
connectorEntityFields: List[ConnectorEntityFieldTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeConnectorResponseTypeDef#
# DescribeConnectorResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorResponseTypeDef
def get_value() -> DescribeConnectorResponseTypeDef:
return {
"connectorConfiguration": ...,
"ResponseMetadata": ...,
}
# DescribeConnectorResponseTypeDef definition
class DescribeConnectorResponseTypeDef(TypedDict):
connectorConfiguration: ConnectorConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeConnectorsResponseTypeDef#
# DescribeConnectorsResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorsResponseTypeDef
def get_value() -> DescribeConnectorsResponseTypeDef:
return {
"connectorConfigurations": ...,
"connectors": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# DescribeConnectorsResponseTypeDef definition
class DescribeConnectorsResponseTypeDef(TypedDict):
connectorConfigurations: Dict[ConnectorTypeType, ConnectorConfigurationTypeDef], # (1)
connectors: List[ConnectorDetailTypeDef], # (2)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ConnectorTypeType ConnectorConfigurationTypeDef
- See ConnectorDetailTypeDef
- See ResponseMetadataTypeDef
DescribeConnectorProfilesResponseTypeDef#
# DescribeConnectorProfilesResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeConnectorProfilesResponseTypeDef
def get_value() -> DescribeConnectorProfilesResponseTypeDef:
return {
"connectorProfileDetails": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# DescribeConnectorProfilesResponseTypeDef definition
class DescribeConnectorProfilesResponseTypeDef(TypedDict):
connectorProfileDetails: List[ConnectorProfileTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DestinationFlowConfigTypeDef#
# DestinationFlowConfigTypeDef usage example
from mypy_boto3_appflow.type_defs import DestinationFlowConfigTypeDef
def get_value() -> DestinationFlowConfigTypeDef:
return {
"connectorType": ...,
"destinationConnectorProperties": ...,
}
# DestinationFlowConfigTypeDef definition
class DestinationFlowConfigTypeDef(TypedDict):
connectorType: ConnectorTypeType, # (1)
destinationConnectorProperties: DestinationConnectorPropertiesTypeDef, # (2)
apiVersion: NotRequired[str],
connectorProfileName: NotRequired[str],
CreateConnectorProfileRequestRequestTypeDef#
# CreateConnectorProfileRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import CreateConnectorProfileRequestRequestTypeDef
def get_value() -> CreateConnectorProfileRequestRequestTypeDef:
return {
"connectorProfileName": ...,
"connectorType": ...,
"connectionMode": ...,
"connectorProfileConfig": ...,
}
# 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],
UpdateConnectorProfileRequestRequestTypeDef#
# UpdateConnectorProfileRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import UpdateConnectorProfileRequestRequestTypeDef
def get_value() -> UpdateConnectorProfileRequestRequestTypeDef:
return {
"connectorProfileName": ...,
"connectionMode": ...,
"connectorProfileConfig": ...,
}
# UpdateConnectorProfileRequestRequestTypeDef definition
class UpdateConnectorProfileRequestRequestTypeDef(TypedDict):
connectorProfileName: str,
connectionMode: ConnectionModeType, # (1)
connectorProfileConfig: ConnectorProfileConfigTypeDef, # (2)
clientToken: NotRequired[str],
CreateFlowRequestRequestTypeDef#
# CreateFlowRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import CreateFlowRequestRequestTypeDef
def get_value() -> CreateFlowRequestRequestTypeDef:
return {
"flowName": ...,
"triggerConfig": ...,
"sourceFlowConfig": ...,
"destinationFlowConfigList": ...,
"tasks": ...,
}
# 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],
- See TriggerConfigTypeDef
- See SourceFlowConfigTypeDef
- See DestinationFlowConfigTypeDef
- See TaskTypeDef
- See MetadataCatalogConfigTypeDef
DescribeFlowResponseTypeDef#
# DescribeFlowResponseTypeDef usage example
from mypy_boto3_appflow.type_defs import DescribeFlowResponseTypeDef
def get_value() -> DescribeFlowResponseTypeDef:
return {
"flowArn": ...,
"description": ...,
"flowName": ...,
"kmsArn": ...,
"flowStatus": ...,
"flowStatusMessage": ...,
"sourceFlowConfig": ...,
"destinationFlowConfigList": ...,
"lastRunExecutionDetails": ...,
"triggerConfig": ...,
"tasks": ...,
"createdAt": ...,
"lastUpdatedAt": ...,
"createdBy": ...,
"lastUpdatedBy": ...,
"tags": ...,
"metadataCatalogConfig": ...,
"lastRunMetadataCatalogDetails": ...,
"schemaVersion": ...,
"ResponseMetadata": ...,
}
# 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)
- See FlowStatusType
- See SourceFlowConfigTypeDef
- See DestinationFlowConfigTypeDef
- See ExecutionDetailsTypeDef
- See TriggerConfigTypeDef
- See TaskTypeDef
- See MetadataCatalogConfigTypeDef
- See MetadataCatalogDetailTypeDef
- See ResponseMetadataTypeDef
UpdateFlowRequestRequestTypeDef#
# UpdateFlowRequestRequestTypeDef usage example
from mypy_boto3_appflow.type_defs import UpdateFlowRequestRequestTypeDef
def get_value() -> UpdateFlowRequestRequestTypeDef:
return {
"flowName": ...,
"triggerConfig": ...,
"sourceFlowConfig": ...,
"destinationFlowConfigList": ...,
"tasks": ...,
}
# 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],