Typed dictionaries
Auto-generated documentation for Appflow type annotations stubs module mypy-boto3-appflow.
AggregationConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import AggregationConfigTypeDef
def get_value() -> AggregationConfigTypeDef:
return {
"aggregationType": ...,
}
Definition
class AggregationConfigTypeDef(TypedDict):
aggregationType: NotRequired[AggregationTypeType], # (1)
targetFileSize: NotRequired[int],
AmplitudeConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import AmplitudeConnectorProfileCredentialsTypeDef
def get_value() -> AmplitudeConnectorProfileCredentialsTypeDef:
return {
"apiKey": ...,
"secretKey": ...,
}
Definition
class AmplitudeConnectorProfileCredentialsTypeDef(TypedDict):
apiKey: str,
secretKey: str,
AmplitudeSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import AmplitudeSourcePropertiesTypeDef
def get_value() -> AmplitudeSourcePropertiesTypeDef:
return {
"object": ...,
}
ApiKeyCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ApiKeyCredentialsTypeDef
def get_value() -> ApiKeyCredentialsTypeDef:
return {
"apiKey": ...,
}
AuthParameterTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import AuthParameterTypeDef
def get_value() -> AuthParameterTypeDef:
return {
"key": ...,
}
Definition
class AuthParameterTypeDef(TypedDict):
key: NotRequired[str],
isRequired: NotRequired[bool],
label: NotRequired[str],
description: NotRequired[str],
isSensitiveField: NotRequired[bool],
connectorSuppliedValues: NotRequired[List[str]],
BasicAuthCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import BasicAuthCredentialsTypeDef
def get_value() -> BasicAuthCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
ConnectorRuntimeSettingTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ConnectorRuntimeSettingTypeDef
def get_value() -> ConnectorRuntimeSettingTypeDef:
return {
"key": ...,
}
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]],
ConnectorDetailTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ConnectorDetailTypeDef
def get_value() -> ConnectorDetailTypeDef:
return {
"connectorDescription": ...,
}
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]],
DestinationFieldPropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DestinationFieldPropertiesTypeDef
def get_value() -> DestinationFieldPropertiesTypeDef:
return {
"isCreatable": ...,
}
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
Usage Example
from mypy_boto3_appflow.type_defs import SourceFieldPropertiesTypeDef
def get_value() -> SourceFieldPropertiesTypeDef:
return {
"isRetrievable": ...,
}
Definition
class SourceFieldPropertiesTypeDef(TypedDict):
isRetrievable: NotRequired[bool],
isQueryable: NotRequired[bool],
isTimestampFieldForIncrementalQueries: NotRequired[bool],
ConnectorEntityTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ConnectorEntityTypeDef
def get_value() -> ConnectorEntityTypeDef:
return {
"name": ...,
}
Definition
class ConnectorEntityTypeDef(TypedDict):
name: str,
label: NotRequired[str],
hasNestedEntities: NotRequired[bool],
GoogleAnalyticsMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import GoogleAnalyticsMetadataTypeDef
def get_value() -> GoogleAnalyticsMetadataTypeDef:
return {
"oAuthScopes": ...,
}
HoneycodeMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import HoneycodeMetadataTypeDef
def get_value() -> HoneycodeMetadataTypeDef:
return {
"oAuthScopes": ...,
}
SalesforceMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SalesforceMetadataTypeDef
def get_value() -> SalesforceMetadataTypeDef:
return {
"oAuthScopes": ...,
}
Definition
class SalesforceMetadataTypeDef(TypedDict):
oAuthScopes: NotRequired[List[str]],
dataTransferApis: NotRequired[List[SalesforceDataTransferApiType]], # (1)
SlackMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SlackMetadataTypeDef
def get_value() -> SlackMetadataTypeDef:
return {
"oAuthScopes": ...,
}
SnowflakeMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SnowflakeMetadataTypeDef
def get_value() -> SnowflakeMetadataTypeDef:
return {
"supportedRegions": ...,
}
ZendeskMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ZendeskMetadataTypeDef
def get_value() -> ZendeskMetadataTypeDef:
return {
"oAuthScopes": ...,
}
ConnectorOAuthRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ConnectorOAuthRequestTypeDef
def get_value() -> ConnectorOAuthRequestTypeDef:
return {
"authCode": ...,
}
Definition
class ConnectorOAuthRequestTypeDef(TypedDict):
authCode: NotRequired[str],
redirectUri: NotRequired[str],
ConnectorOperatorTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ConnectorOperatorTypeDef
def get_value() -> ConnectorOperatorTypeDef:
return {
"Amplitude": ...,
}
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
Usage Example
from mypy_boto3_appflow.type_defs import DatadogConnectorProfileCredentialsTypeDef
def get_value() -> DatadogConnectorProfileCredentialsTypeDef:
return {
"apiKey": ...,
"applicationKey": ...,
}
Definition
class DatadogConnectorProfileCredentialsTypeDef(TypedDict):
apiKey: str,
applicationKey: str,
DynatraceConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DynatraceConnectorProfileCredentialsTypeDef
def get_value() -> DynatraceConnectorProfileCredentialsTypeDef:
return {
"apiToken": ...,
}
InforNexusConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import InforNexusConnectorProfileCredentialsTypeDef
def get_value() -> InforNexusConnectorProfileCredentialsTypeDef:
return {
"accessKeyId": ...,
"userId": ...,
"secretAccessKey": ...,
"datakey": ...,
}
Definition
class InforNexusConnectorProfileCredentialsTypeDef(TypedDict):
accessKeyId: str,
userId: str,
secretAccessKey: str,
datakey: str,
RedshiftConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import RedshiftConnectorProfileCredentialsTypeDef
def get_value() -> RedshiftConnectorProfileCredentialsTypeDef:
return {
"username": ...,
}
Definition
class RedshiftConnectorProfileCredentialsTypeDef(TypedDict):
username: NotRequired[str],
password: NotRequired[str],
ServiceNowConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ServiceNowConnectorProfileCredentialsTypeDef
def get_value() -> ServiceNowConnectorProfileCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
Definition
class ServiceNowConnectorProfileCredentialsTypeDef(TypedDict):
username: str,
password: str,
SingularConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SingularConnectorProfileCredentialsTypeDef
def get_value() -> SingularConnectorProfileCredentialsTypeDef:
return {
"apiKey": ...,
}
SnowflakeConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SnowflakeConnectorProfileCredentialsTypeDef
def get_value() -> SnowflakeConnectorProfileCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
Definition
class SnowflakeConnectorProfileCredentialsTypeDef(TypedDict):
username: str,
password: str,
TrendmicroConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import TrendmicroConnectorProfileCredentialsTypeDef
def get_value() -> TrendmicroConnectorProfileCredentialsTypeDef:
return {
"apiSecretKey": ...,
}
VeevaConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import VeevaConnectorProfileCredentialsTypeDef
def get_value() -> VeevaConnectorProfileCredentialsTypeDef:
return {
"username": ...,
"password": ...,
}
DatadogConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DatadogConnectorProfilePropertiesTypeDef
def get_value() -> DatadogConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
DynatraceConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DynatraceConnectorProfilePropertiesTypeDef
def get_value() -> DynatraceConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
InforNexusConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import InforNexusConnectorProfilePropertiesTypeDef
def get_value() -> InforNexusConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
MarketoConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import MarketoConnectorProfilePropertiesTypeDef
def get_value() -> MarketoConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
PardotConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import PardotConnectorProfilePropertiesTypeDef
def get_value() -> PardotConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
Definition
class PardotConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: NotRequired[str],
isSandboxEnvironment: NotRequired[bool],
businessUnitId: NotRequired[str],
RedshiftConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import RedshiftConnectorProfilePropertiesTypeDef
def get_value() -> RedshiftConnectorProfilePropertiesTypeDef:
return {
"bucketName": ...,
"roleArn": ...,
}
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
Usage Example
from mypy_boto3_appflow.type_defs import SalesforceConnectorProfilePropertiesTypeDef
def get_value() -> SalesforceConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
Definition
class SalesforceConnectorProfilePropertiesTypeDef(TypedDict):
instanceUrl: NotRequired[str],
isSandboxEnvironment: NotRequired[bool],
ServiceNowConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ServiceNowConnectorProfilePropertiesTypeDef
def get_value() -> ServiceNowConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
SlackConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SlackConnectorProfilePropertiesTypeDef
def get_value() -> SlackConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
SnowflakeConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SnowflakeConnectorProfilePropertiesTypeDef
def get_value() -> SnowflakeConnectorProfilePropertiesTypeDef:
return {
"warehouse": ...,
"stage": ...,
"bucketName": ...,
}
Definition
class SnowflakeConnectorProfilePropertiesTypeDef(TypedDict):
warehouse: str,
stage: str,
bucketName: str,
bucketPrefix: NotRequired[str],
privateLinkServiceName: NotRequired[str],
accountName: NotRequired[str],
region: NotRequired[str],
VeevaConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import VeevaConnectorProfilePropertiesTypeDef
def get_value() -> VeevaConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
ZendeskConnectorProfilePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ZendeskConnectorProfilePropertiesTypeDef
def get_value() -> ZendeskConnectorProfilePropertiesTypeDef:
return {
"instanceUrl": ...,
}
PrivateConnectionProvisioningStateTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import PrivateConnectionProvisioningStateTypeDef
def get_value() -> PrivateConnectionProvisioningStateTypeDef:
return {
"status": ...,
}
Definition
class PrivateConnectionProvisioningStateTypeDef(TypedDict):
status: NotRequired[PrivateConnectionProvisioningStatusType], # (1)
failureMessage: NotRequired[str],
failureCause: NotRequired[PrivateConnectionProvisioningFailureCauseType], # (2)
LambdaConnectorProvisioningConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import LambdaConnectorProvisioningConfigTypeDef
def get_value() -> LambdaConnectorProvisioningConfigTypeDef:
return {
"lambdaArn": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CustomAuthCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import CustomAuthCredentialsTypeDef
def get_value() -> CustomAuthCredentialsTypeDef:
return {
"customAuthenticationType": ...,
}
Definition
class CustomAuthCredentialsTypeDef(TypedDict):
customAuthenticationType: str,
credentialsMap: NotRequired[Mapping[str, str]],
ErrorHandlingConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ErrorHandlingConfigTypeDef
def get_value() -> ErrorHandlingConfigTypeDef:
return {
"failOnFirstDestinationError": ...,
}
Definition
class ErrorHandlingConfigTypeDef(TypedDict):
failOnFirstDestinationError: NotRequired[bool],
bucketPrefix: NotRequired[str],
bucketName: NotRequired[str],
OAuth2PropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import OAuth2PropertiesTypeDef
def get_value() -> OAuth2PropertiesTypeDef:
return {
"tokenUrl": ...,
"oAuth2GrantType": ...,
}
Definition
class OAuth2PropertiesTypeDef(TypedDict):
tokenUrl: str,
oAuth2GrantType: OAuth2GrantTypeType, # (1)
tokenUrlCustomProperties: NotRequired[Mapping[str, str]],
CustomConnectorSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import CustomConnectorSourcePropertiesTypeDef
def get_value() -> CustomConnectorSourcePropertiesTypeDef:
return {
"entityName": ...,
}
Definition
class CustomConnectorSourcePropertiesTypeDef(TypedDict):
entityName: str,
customProperties: NotRequired[Mapping[str, str]],
CustomerProfilesDestinationPropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import CustomerProfilesDestinationPropertiesTypeDef
def get_value() -> CustomerProfilesDestinationPropertiesTypeDef:
return {
"domainName": ...,
}
Definition
class CustomerProfilesDestinationPropertiesTypeDef(TypedDict):
domainName: str,
objectTypeName: NotRequired[str],
DatadogSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DatadogSourcePropertiesTypeDef
def get_value() -> DatadogSourcePropertiesTypeDef:
return {
"object": ...,
}
DeleteConnectorProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DeleteConnectorProfileRequestRequestTypeDef
def get_value() -> DeleteConnectorProfileRequestRequestTypeDef:
return {
"connectorProfileName": ...,
}
Definition
class DeleteConnectorProfileRequestRequestTypeDef(TypedDict):
connectorProfileName: str,
forceDelete: NotRequired[bool],
DeleteFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DeleteFlowRequestRequestTypeDef
def get_value() -> DeleteFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
Definition
class DeleteFlowRequestRequestTypeDef(TypedDict):
flowName: str,
forceDelete: NotRequired[bool],
DescribeConnectorEntityRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DescribeConnectorEntityRequestRequestTypeDef
def get_value() -> DescribeConnectorEntityRequestRequestTypeDef:
return {
"connectorEntityName": ...,
}
Definition
class DescribeConnectorEntityRequestRequestTypeDef(TypedDict):
connectorEntityName: str,
connectorType: NotRequired[ConnectorTypeType], # (1)
connectorProfileName: NotRequired[str],
apiVersion: NotRequired[str],
DescribeConnectorProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DescribeConnectorProfilesRequestRequestTypeDef
def get_value() -> DescribeConnectorProfilesRequestRequestTypeDef:
return {
"connectorProfileNames": ...,
}
Definition
class DescribeConnectorProfilesRequestRequestTypeDef(TypedDict):
connectorProfileNames: NotRequired[Sequence[str]],
connectorType: NotRequired[ConnectorTypeType], # (1)
connectorLabel: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
DescribeConnectorRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DescribeConnectorRequestRequestTypeDef
def get_value() -> DescribeConnectorRequestRequestTypeDef:
return {
"connectorType": ...,
}
Definition
class DescribeConnectorRequestRequestTypeDef(TypedDict):
connectorType: ConnectorTypeType, # (1)
connectorLabel: NotRequired[str],
DescribeConnectorsRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DescribeConnectorsRequestRequestTypeDef
def get_value() -> DescribeConnectorsRequestRequestTypeDef:
return {
"connectorTypes": ...,
}
Definition
class DescribeConnectorsRequestRequestTypeDef(TypedDict):
connectorTypes: NotRequired[Sequence[ConnectorTypeType]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
DescribeFlowExecutionRecordsRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DescribeFlowExecutionRecordsRequestRequestTypeDef
def get_value() -> DescribeFlowExecutionRecordsRequestRequestTypeDef:
return {
"flowName": ...,
}
Definition
class DescribeFlowExecutionRecordsRequestRequestTypeDef(TypedDict):
flowName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
DescribeFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DescribeFlowRequestRequestTypeDef
def get_value() -> DescribeFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
ExecutionDetailsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ExecutionDetailsTypeDef
def get_value() -> ExecutionDetailsTypeDef:
return {
"mostRecentExecutionMessage": ...,
}
Definition
class ExecutionDetailsTypeDef(TypedDict):
mostRecentExecutionMessage: NotRequired[str],
mostRecentExecutionTime: NotRequired[datetime],
mostRecentExecutionStatus: NotRequired[ExecutionStatusType], # (1)
DynatraceSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import DynatraceSourcePropertiesTypeDef
def get_value() -> DynatraceSourcePropertiesTypeDef:
return {
"object": ...,
}
ErrorInfoTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ErrorInfoTypeDef
def get_value() -> ErrorInfoTypeDef:
return {
"putFailuresCount": ...,
}
Definition
class ErrorInfoTypeDef(TypedDict):
putFailuresCount: NotRequired[int],
executionMessage: NotRequired[str],
RangeTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import RangeTypeDef
def get_value() -> RangeTypeDef:
return {
"maximum": ...,
}
GlueDataCatalogConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import GlueDataCatalogConfigTypeDef
def get_value() -> GlueDataCatalogConfigTypeDef:
return {
"roleArn": ...,
"databaseName": ...,
"tablePrefix": ...,
}
Definition
class GlueDataCatalogConfigTypeDef(TypedDict):
roleArn: str,
databaseName: str,
tablePrefix: str,
GoogleAnalyticsSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import GoogleAnalyticsSourcePropertiesTypeDef
def get_value() -> GoogleAnalyticsSourcePropertiesTypeDef:
return {
"object": ...,
}
IncrementalPullConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import IncrementalPullConfigTypeDef
def get_value() -> IncrementalPullConfigTypeDef:
return {
"datetimeTypeFieldName": ...,
}
InforNexusSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import InforNexusSourcePropertiesTypeDef
def get_value() -> InforNexusSourcePropertiesTypeDef:
return {
"object": ...,
}
ListConnectorEntitiesRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ListConnectorEntitiesRequestRequestTypeDef
def get_value() -> ListConnectorEntitiesRequestRequestTypeDef:
return {
"connectorProfileName": ...,
}
Definition
class ListConnectorEntitiesRequestRequestTypeDef(TypedDict):
connectorProfileName: NotRequired[str],
connectorType: NotRequired[ConnectorTypeType], # (1)
entitiesPath: NotRequired[str],
apiVersion: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListConnectorsRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ListConnectorsRequestRequestTypeDef
def get_value() -> ListConnectorsRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListConnectorsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListFlowsRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ListFlowsRequestRequestTypeDef
def get_value() -> ListFlowsRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListFlowsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
MarketoSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import MarketoSourcePropertiesTypeDef
def get_value() -> MarketoSourcePropertiesTypeDef:
return {
"object": ...,
}
RegistrationOutputTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import RegistrationOutputTypeDef
def get_value() -> RegistrationOutputTypeDef:
return {
"message": ...,
}
Definition
class RegistrationOutputTypeDef(TypedDict):
message: NotRequired[str],
result: NotRequired[str],
status: NotRequired[ExecutionStatusType], # (1)
OAuth2CustomParameterTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import OAuth2CustomParameterTypeDef
def get_value() -> OAuth2CustomParameterTypeDef:
return {
"key": ...,
}
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
Usage Example
from mypy_boto3_appflow.type_defs import OAuthPropertiesTypeDef
def get_value() -> OAuthPropertiesTypeDef:
return {
"tokenUrl": ...,
"authCodeUrl": ...,
"oAuthScopes": ...,
}
Definition
class OAuthPropertiesTypeDef(TypedDict):
tokenUrl: str,
authCodeUrl: str,
oAuthScopes: Sequence[str],
PardotSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import PardotSourcePropertiesTypeDef
def get_value() -> PardotSourcePropertiesTypeDef:
return {
"object": ...,
}
PrefixConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import PrefixConfigTypeDef
def get_value() -> PrefixConfigTypeDef:
return {
"prefixType": ...,
}
Definition
class PrefixConfigTypeDef(TypedDict):
prefixType: NotRequired[PrefixTypeType], # (1)
prefixFormat: NotRequired[PrefixFormatType], # (2)
pathPrefixHierarchy: NotRequired[Sequence[PathPrefixType]], # (3)
- See PrefixTypeType
- See PrefixFormatType
- See PathPrefixType
S3InputFormatConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import S3InputFormatConfigTypeDef
def get_value() -> S3InputFormatConfigTypeDef:
return {
"s3InputFileType": ...,
}
Definition
class S3InputFormatConfigTypeDef(TypedDict):
s3InputFileType: NotRequired[S3InputFileTypeType], # (1)
SuccessResponseHandlingConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SuccessResponseHandlingConfigTypeDef
def get_value() -> SuccessResponseHandlingConfigTypeDef:
return {
"bucketPrefix": ...,
}
Definition
class SuccessResponseHandlingConfigTypeDef(TypedDict):
bucketPrefix: NotRequired[str],
bucketName: NotRequired[str],
SAPODataSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SAPODataSourcePropertiesTypeDef
def get_value() -> SAPODataSourcePropertiesTypeDef:
return {
"objectPath": ...,
}
SalesforceSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SalesforceSourcePropertiesTypeDef
def get_value() -> SalesforceSourcePropertiesTypeDef:
return {
"object": ...,
}
Definition
class SalesforceSourcePropertiesTypeDef(TypedDict):
object: str,
enableDynamicFieldUpdate: NotRequired[bool],
includeDeletedRecords: NotRequired[bool],
dataTransferApi: NotRequired[SalesforceDataTransferApiType], # (1)
ScheduledTriggerPropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ScheduledTriggerPropertiesTypeDef
def get_value() -> ScheduledTriggerPropertiesTypeDef:
return {
"scheduleExpression": ...,
}
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
Usage Example
from mypy_boto3_appflow.type_defs import ServiceNowSourcePropertiesTypeDef
def get_value() -> ServiceNowSourcePropertiesTypeDef:
return {
"object": ...,
}
SingularSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SingularSourcePropertiesTypeDef
def get_value() -> SingularSourcePropertiesTypeDef:
return {
"object": ...,
}
SlackSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SlackSourcePropertiesTypeDef
def get_value() -> SlackSourcePropertiesTypeDef:
return {
"object": ...,
}
TrendmicroSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import TrendmicroSourcePropertiesTypeDef
def get_value() -> TrendmicroSourcePropertiesTypeDef:
return {
"object": ...,
}
VeevaSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import VeevaSourcePropertiesTypeDef
def get_value() -> VeevaSourcePropertiesTypeDef:
return {
"object": ...,
}
Definition
class VeevaSourcePropertiesTypeDef(TypedDict):
object: str,
documentType: NotRequired[str],
includeSourceFiles: NotRequired[bool],
includeRenditions: NotRequired[bool],
includeAllVersions: NotRequired[bool],
ZendeskSourcePropertiesTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ZendeskSourcePropertiesTypeDef
def get_value() -> ZendeskSourcePropertiesTypeDef:
return {
"object": ...,
}
StartFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import StartFlowRequestRequestTypeDef
def get_value() -> StartFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
StopFlowRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import StopFlowRequestRequestTypeDef
def get_value() -> StopFlowRequestRequestTypeDef:
return {
"flowName": ...,
}
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UnregisterConnectorRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import UnregisterConnectorRequestRequestTypeDef
def get_value() -> UnregisterConnectorRequestRequestTypeDef:
return {
"connectorLabel": ...,
}
Definition
class UnregisterConnectorRequestRequestTypeDef(TypedDict):
connectorLabel: str,
forceDelete: NotRequired[bool],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
CustomAuthConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import CustomAuthConfigTypeDef
def get_value() -> CustomAuthConfigTypeDef:
return {
"customAuthenticationType": ...,
}
Definition
class CustomAuthConfigTypeDef(TypedDict):
customAuthenticationType: NotRequired[str],
authParameters: NotRequired[List[AuthParameterTypeDef]], # (1)
ConnectorMetadataTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ConnectorMetadataTypeDef
def get_value() -> ConnectorMetadataTypeDef:
return {
"Amplitude": ...,
}
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
Usage Example
from mypy_boto3_appflow.type_defs import GoogleAnalyticsConnectorProfileCredentialsTypeDef
def get_value() -> GoogleAnalyticsConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
Definition
class GoogleAnalyticsConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
HoneycodeConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import HoneycodeConnectorProfileCredentialsTypeDef
def get_value() -> HoneycodeConnectorProfileCredentialsTypeDef:
return {
"accessToken": ...,
}
Definition
class HoneycodeConnectorProfileCredentialsTypeDef(TypedDict):
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
MarketoConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import MarketoConnectorProfileCredentialsTypeDef
def get_value() -> MarketoConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
Definition
class MarketoConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
OAuth2CredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import OAuth2CredentialsTypeDef
def get_value() -> OAuth2CredentialsTypeDef:
return {
"clientId": ...,
}
Definition
class OAuth2CredentialsTypeDef(TypedDict):
clientId: NotRequired[str],
clientSecret: NotRequired[str],
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
OAuthCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import OAuthCredentialsTypeDef
def get_value() -> OAuthCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
Definition
class OAuthCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
PardotConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import PardotConnectorProfileCredentialsTypeDef
def get_value() -> PardotConnectorProfileCredentialsTypeDef:
return {
"accessToken": ...,
}
Definition
class PardotConnectorProfileCredentialsTypeDef(TypedDict):
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
clientCredentialsArn: NotRequired[str],
SalesforceConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SalesforceConnectorProfileCredentialsTypeDef
def get_value() -> SalesforceConnectorProfileCredentialsTypeDef:
return {
"accessToken": ...,
}
Definition
class SalesforceConnectorProfileCredentialsTypeDef(TypedDict):
accessToken: NotRequired[str],
refreshToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
clientCredentialsArn: NotRequired[str],
SlackConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import SlackConnectorProfileCredentialsTypeDef
def get_value() -> SlackConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
Definition
class SlackConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
ZendeskConnectorProfileCredentialsTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ZendeskConnectorProfileCredentialsTypeDef
def get_value() -> ZendeskConnectorProfileCredentialsTypeDef:
return {
"clientId": ...,
"clientSecret": ...,
}
Definition
class ZendeskConnectorProfileCredentialsTypeDef(TypedDict):
clientId: str,
clientSecret: str,
accessToken: NotRequired[str],
oAuthRequest: NotRequired[ConnectorOAuthRequestTypeDef], # (1)
TaskTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import TaskTypeDef
def get_value() -> TaskTypeDef:
return {
"sourceFields": ...,
"taskType": ...,
}
Definition
class TaskTypeDef(TypedDict):
sourceFields: Sequence[str],
taskType: TaskTypeType, # (2)
connectorOperator: NotRequired[ConnectorOperatorTypeDef], # (1)
destinationField: NotRequired[str],
taskProperties: NotRequired[Mapping[OperatorPropertiesKeysType, str]], # (3)
ConnectorProvisioningConfigTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ConnectorProvisioningConfigTypeDef
def get_value() -> ConnectorProvisioningConfigTypeDef:
return {
"lambda": ...,
}
Definition
class ConnectorProvisioningConfigTypeDef(TypedDict):
lambda: NotRequired[LambdaConnectorProvisioningConfigTypeDef], # (1)
CreateConnectorProfileResponseTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import CreateConnectorProfileResponseTypeDef
def get_value() -> CreateConnectorProfileResponseTypeDef:
return {
"connectorProfileArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateConnectorProfileResponseTypeDef(TypedDict):
connectorProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateFlowResponseTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import CreateFlowResponseTypeDef
def get_value() -> CreateFlowResponseTypeDef:
return {
"flowArn": ...,
"flowStatus": ...,
"ResponseMetadata": ...,
}
Definition
class CreateFlowResponseTypeDef(TypedDict):
flowArn: str,
flowStatus: FlowStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConnectorEntitiesResponseTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ListConnectorEntitiesResponseTypeDef
def get_value() -> ListConnectorEntitiesResponseTypeDef:
return {
"connectorEntityMap": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListConnectorEntitiesResponseTypeDef(TypedDict):
connectorEntityMap: Dict[str, List[ConnectorEntityTypeDef]], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConnectorsResponseTypeDef
Usage Example
from mypy_boto3_appflow.type_defs import ListConnectorsResponseTypeDef
def get_value() -> ListConnectorsResponseTypeDef:
return {
"connectors": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListConnectorsResponseTypeDef(TypedDict):
connectors: List[ConnectorDetailTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)