Skip to content

Type definitions#

Index > Appflow > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AggregationConfigTypeDef#

# AggregationConfigTypeDef definition

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

AmplitudeConnectorProfileCredentialsTypeDef#

# AmplitudeConnectorProfileCredentialsTypeDef definition

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

AmplitudeSourcePropertiesTypeDef#

# AmplitudeSourcePropertiesTypeDef definition

class AmplitudeSourcePropertiesTypeDef(TypedDict):
    object: str,

ApiKeyCredentialsTypeDef#

# ApiKeyCredentialsTypeDef definition

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

AuthParameterTypeDef#

# AuthParameterTypeDef definition

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

BasicAuthCredentialsTypeDef#

# BasicAuthCredentialsTypeDef definition

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

CancelFlowExecutionsRequestRequestTypeDef#

# CancelFlowExecutionsRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ConnectorRuntimeSettingTypeDef#

# ConnectorRuntimeSettingTypeDef definition

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

DataTransferApiTypeDef#

# DataTransferApiTypeDef definition

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

ConnectorDetailTypeDef#

# ConnectorDetailTypeDef definition

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

DestinationFieldPropertiesTypeDef#

# DestinationFieldPropertiesTypeDef definition

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

SourceFieldPropertiesTypeDef#

# SourceFieldPropertiesTypeDef definition

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

ConnectorEntityTypeDef#

# ConnectorEntityTypeDef definition

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

GoogleAnalyticsMetadataTypeDef#

# GoogleAnalyticsMetadataTypeDef definition

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

HoneycodeMetadataTypeDef#

# HoneycodeMetadataTypeDef definition

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

SalesforceMetadataTypeDef#

# SalesforceMetadataTypeDef definition

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

SlackMetadataTypeDef#

# SlackMetadataTypeDef definition

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

SnowflakeMetadataTypeDef#

# SnowflakeMetadataTypeDef definition

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

ZendeskMetadataTypeDef#

# ZendeskMetadataTypeDef definition

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

ConnectorOAuthRequestTypeDef#

# ConnectorOAuthRequestTypeDef definition

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

ConnectorOperatorTypeDef#

# ConnectorOperatorTypeDef definition

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

DatadogConnectorProfileCredentialsTypeDef#

# DatadogConnectorProfileCredentialsTypeDef definition

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

DynatraceConnectorProfileCredentialsTypeDef#

# DynatraceConnectorProfileCredentialsTypeDef definition

class DynatraceConnectorProfileCredentialsTypeDef(TypedDict):
    apiToken: str,

InforNexusConnectorProfileCredentialsTypeDef#

# InforNexusConnectorProfileCredentialsTypeDef definition

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

RedshiftConnectorProfileCredentialsTypeDef#

# RedshiftConnectorProfileCredentialsTypeDef definition

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

SingularConnectorProfileCredentialsTypeDef#

# SingularConnectorProfileCredentialsTypeDef definition

class SingularConnectorProfileCredentialsTypeDef(TypedDict):
    apiKey: str,

SnowflakeConnectorProfileCredentialsTypeDef#

# SnowflakeConnectorProfileCredentialsTypeDef definition

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

TrendmicroConnectorProfileCredentialsTypeDef#

# TrendmicroConnectorProfileCredentialsTypeDef definition

class TrendmicroConnectorProfileCredentialsTypeDef(TypedDict):
    apiSecretKey: str,

VeevaConnectorProfileCredentialsTypeDef#

# VeevaConnectorProfileCredentialsTypeDef definition

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

DatadogConnectorProfilePropertiesTypeDef