Appflow

Client

class Appflow.Client

A low-level client representing Amazon Appflow:

client = session.create_client('appflow')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_connector_profile(**kwargs)

Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.

See also: AWS API Documentation

Request Syntax

response = client.create_connector_profile(
    connectorProfileName='string',
    kmsArn='string',
    connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
    connectionMode='Public'|'Private',
    connectorProfileConfig={
        'connectorProfileProperties': {
            'Amplitude': {}
            ,
            'Datadog': {
                'instanceUrl': 'string'
            },
            'Dynatrace': {
                'instanceUrl': 'string'
            },
            'GoogleAnalytics': {}
            ,
            'InforNexus': {
                'instanceUrl': 'string'
            },
            'Marketo': {
                'instanceUrl': 'string'
            },
            'Redshift': {
                'databaseUrl': 'string',
                'bucketName': 'string',
                'bucketPrefix': 'string',
                'roleArn': 'string'
            },
            'Salesforce': {
                'instanceUrl': 'string',
                'isSandboxEnvironment': True|False
            },
            'ServiceNow': {
                'instanceUrl': 'string'
            },
            'Singular': {}
            ,
            'Slack': {
                'instanceUrl': 'string'
            },
            'Snowflake': {
                'warehouse': 'string',
                'stage': 'string',
                'bucketName': 'string',
                'bucketPrefix': 'string',
                'privateLinkServiceName': 'string',
                'accountName': 'string',
                'region': 'string'
            },
            'Trendmicro': {}
            ,
            'Veeva': {
                'instanceUrl': 'string'
            },
            'Zendesk': {
                'instanceUrl': 'string'
            }
        },
        'connectorProfileCredentials': {
            'Amplitude': {
                'apiKey': 'string',
                'secretKey': 'string'
            },
            'Datadog': {
                'apiKey': 'string',
                'applicationKey': 'string'
            },
            'Dynatrace': {
                'apiToken': 'string'
            },
            'GoogleAnalytics': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'refreshToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            },
            'InforNexus': {
                'accessKeyId': 'string',
                'userId': 'string',
                'secretAccessKey': 'string',
                'datakey': 'string'
            },
            'Marketo': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            },
            'Redshift': {
                'username': 'string',
                'password': 'string'
            },
            'Salesforce': {
                'accessToken': 'string',
                'refreshToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                },
                'clientCredentialsArn': 'string'
            },
            'ServiceNow': {
                'username': 'string',
                'password': 'string'
            },
            'Singular': {
                'apiKey': 'string'
            },
            'Slack': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            },
            'Snowflake': {
                'username': 'string',
                'password': 'string'
            },
            'Trendmicro': {
                'apiSecretKey': 'string'
            },
            'Veeva': {
                'username': 'string',
                'password': 'string'
            },
            'Zendesk': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            }
        }
    }
)
Parameters
  • connectorProfileName (string) --

    [REQUIRED]

    The name of the connector profile. The name is unique for each ConnectorProfile in your AWS account.

  • kmsArn (string) -- The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
  • connectorType (string) --

    [REQUIRED]

    The type of connector, such as Salesforce, Amplitude, and so on.

  • connectionMode (string) --

    [REQUIRED]

    Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet.

  • connectorProfileConfig (dict) --

    [REQUIRED]

    Defines the connector-specific configuration and credentials.

    • connectorProfileProperties (dict) -- [REQUIRED]

      The connector-specific properties of the profile configuration.

      • Amplitude (dict) --

        The connector-specific properties required by Amplitude.

      • Datadog (dict) --

        The connector-specific properties required by Datadog.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Datadog resource.

      • Dynatrace (dict) --

        The connector-specific properties required by Dynatrace.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Dynatrace resource.

      • GoogleAnalytics (dict) --

        The connector-specific properties required Google Analytics.

      • InforNexus (dict) --

        The connector-specific properties required by Infor Nexus.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Infor Nexus resource.

      • Marketo (dict) --

        The connector-specific properties required by Marketo.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Marketo resource.

      • Redshift (dict) --

        The connector-specific properties required by Amazon Redshift.

        • databaseUrl (string) -- [REQUIRED]

          The JDBC URL of the Amazon Redshift cluster.

        • bucketName (string) -- [REQUIRED]

          A name for the associated Amazon S3 bucket.

        • bucketPrefix (string) --

          The object key for the destination bucket in which Amazon AppFlow places the files.

        • roleArn (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the IAM role.

      • Salesforce (dict) --

        The connector-specific properties required by Salesforce.

        • instanceUrl (string) --

          The location of the Salesforce resource.

        • isSandboxEnvironment (boolean) --

          Indicates whether the connector profile applies to a sandbox or production environment.

      • ServiceNow (dict) --

        The connector-specific properties required by serviceNow.

        • instanceUrl (string) -- [REQUIRED]

          The location of the ServiceNow resource.

      • Singular (dict) --

        The connector-specific properties required by Singular.

      • Slack (dict) --

        The connector-specific properties required by Slack.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Slack resource.

      • Snowflake (dict) --

        The connector-specific properties required by Snowflake.

        • warehouse (string) -- [REQUIRED]

          The name of the Snowflake warehouse.

        • stage (string) -- [REQUIRED]

          The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.

        • bucketName (string) -- [REQUIRED]

          The name of the Amazon S3 bucket associated with Snowflake.

        • bucketPrefix (string) --

          The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

        • privateLinkServiceName (string) --

          The Snowflake Private Link service name to be used for private data transfers.

        • accountName (string) --

          The name of the account.

        • region (string) --

          The AWS Region of the Snowflake account.

      • Trendmicro (dict) --

        The connector-specific properties required by Trend Micro.

      • Veeva (dict) --

        The connector-specific properties required by Veeva.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Veeva resource.

      • Zendesk (dict) --

        The connector-specific properties required by Zendesk.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Zendesk resource.

    • connectorProfileCredentials (dict) -- [REQUIRED]

      The connector-specific credentials required by each connector.

      • Amplitude (dict) --

        The connector-specific credentials required when using Amplitude.

        • apiKey (string) -- [REQUIRED]

          A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

        • secretKey (string) -- [REQUIRED]

          The Secret Access Key portion of the credentials.

      • Datadog (dict) --

        The connector-specific credentials required when using Datadog.

        • apiKey (string) -- [REQUIRED]

          A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

        • applicationKey (string) -- [REQUIRED]

          Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.

      • Dynatrace (dict) --

        The connector-specific credentials required when using Dynatrace.

        • apiToken (string) -- [REQUIRED]

          The API tokens used by Dynatrace API to authenticate various API calls.

      • GoogleAnalytics (dict) --

        The connector-specific credentials required when using Google Analytics.

        • clientId (string) -- [REQUIRED]

          The identifier for the desired client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Google Analytics resources.

        • refreshToken (string) --

          The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

      • InforNexus (dict) --

        The connector-specific credentials required when using Infor Nexus.

        • accessKeyId (string) -- [REQUIRED]

          The Access Key portion of the credentials.

        • userId (string) -- [REQUIRED]

          The identifier for the user.

        • secretAccessKey (string) -- [REQUIRED]

          The secret key used to sign requests.

        • datakey (string) -- [REQUIRED]

          The encryption keys used to encrypt data.

      • Marketo (dict) --

        The connector-specific credentials required when using Marketo.

        • clientId (string) -- [REQUIRED]

          The identifier for the desired client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Marketo resources.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

      • Redshift (dict) --

        The connector-specific credentials required when using Amazon Redshift.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Salesforce (dict) --

        The connector-specific credentials required when using Salesforce.

        • accessToken (string) --

          The credentials used to access protected Salesforce resources.

        • refreshToken (string) --

          The credentials used to acquire new access tokens.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

        • clientCredentialsArn (string) --

          The secret manager ARN, which contains the client ID and client secret of the connected app.

      • ServiceNow (dict) --

        The connector-specific credentials required when using ServiceNow.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Singular (dict) --

        The connector-specific credentials required when using Singular.

        • apiKey (string) -- [REQUIRED]

          A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

      • Slack (dict) --

        The connector-specific credentials required when using Slack.

        • clientId (string) -- [REQUIRED]

          The identifier for the client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Slack resources.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

      • Snowflake (dict) --

        The connector-specific credentials required when using Snowflake.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Trendmicro (dict) --

        The connector-specific credentials required when using Trend Micro.

        • apiSecretKey (string) -- [REQUIRED]

          The Secret Access Key portion of the credentials.

      • Veeva (dict) --

        The connector-specific credentials required when using Veeva.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Zendesk (dict) --

        The connector-specific credentials required when using Zendesk.

        • clientId (string) -- [REQUIRED]

          The identifier for the desired client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Zendesk resources.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

Return type

dict

Returns

Response Syntax

{
    'connectorProfileArn': 'string'
}

Response Structure

  • (dict) --

    • connectorProfileArn (string) --

      The Amazon Resource Name (ARN) of the connector profile.

Exceptions

create_flow(**kwargs)

Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

See also: AWS API Documentation

Request Syntax

response = client.create_flow(
    flowName='string',
    description='string',
    kmsArn='string',
    triggerConfig={
        'triggerType': 'Scheduled'|'Event'|'OnDemand',
        'triggerProperties': {
            'Scheduled': {
                'scheduleExpression': 'string',
                'dataPullMode': 'Incremental'|'Complete',
                'scheduleStartTime': datetime(2015, 1, 1),
                'scheduleEndTime': datetime(2015, 1, 1),
                'timezone': 'string'
            }
        }
    },
    sourceFlowConfig={
        'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
        'connectorProfileName': 'string',
        'sourceConnectorProperties': {
            'Amplitude': {
                'object': 'string'
            },
            'Datadog': {
                'object': 'string'
            },
            'Dynatrace': {
                'object': 'string'
            },
            'GoogleAnalytics': {
                'object': 'string'
            },
            'InforNexus': {
                'object': 'string'
            },
            'Marketo': {
                'object': 'string'
            },
            'S3': {
                'bucketName': 'string',
                'bucketPrefix': 'string'
            },
            'Salesforce': {
                'object': 'string',
                'enableDynamicFieldUpdate': True|False,
                'includeDeletedRecords': True|False
            },
            'ServiceNow': {
                'object': 'string'
            },
            'Singular': {
                'object': 'string'
            },
            'Slack': {
                'object': 'string'
            },
            'Trendmicro': {
                'object': 'string'
            },
            'Veeva': {
                'object': 'string'
            },
            'Zendesk': {
                'object': 'string'
            }
        },
        'incrementalPullConfig': {
            'datetimeTypeFieldName': 'string'
        }
    },
    destinationFlowConfigList=[
        {
            'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
            'connectorProfileName': 'string',
            'destinationConnectorProperties': {
                'Redshift': {
                    'object': 'string',
                    'intermediateBucketName': 'string',
                    'bucketPrefix': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                },
                'S3': {
                    'bucketName': 'string',
                    'bucketPrefix': 'string',
                    's3OutputFormatConfig': {
                        'fileType': 'CSV'|'JSON'|'PARQUET',
                        'prefixConfig': {
                            'prefixType': 'FILENAME'|'PATH'|'PATH_AND_FILENAME',
                            'prefixFormat': 'YEAR'|'MONTH'|'DAY'|'HOUR'|'MINUTE'
                        },
                        'aggregationConfig': {
                            'aggregationType': 'None'|'SingleFile'
                        }
                    }
                },
                'Salesforce': {
                    'object': 'string',
                    'idFieldNames': [
                        'string',
                    ],
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    },
                    'writeOperationType': 'INSERT'|'UPSERT'|'UPDATE'
                },
                'Snowflake': {
                    'object': 'string',
                    'intermediateBucketName': 'string',
                    'bucketPrefix': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                },
                'EventBridge': {
                    'object': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                }
            }
        },
    ],
    tasks=[
        {
            'sourceFields': [
                'string',
            ],
            'connectorOperator': {
                'Amplitude': 'BETWEEN',
                'Datadog': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Dynatrace': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'GoogleAnalytics': 'PROJECTION'|'BETWEEN',
                'InforNexus': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Singular': 'PROJECTION'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Slack': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Trendmicro': 'PROJECTION'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Veeva': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'CONTAINS'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
            },
            'destinationField': 'string',
            'taskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate',
            'taskProperties': {
                'string': 'string'
            }
        },
    ],
    tags={
        'string': 'string'
    }
)
Parameters
  • flowName (string) --

    [REQUIRED]

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

  • description (string) -- A description of the flow you want to create.
  • kmsArn (string) -- The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
  • triggerConfig (dict) --

    [REQUIRED]

    The trigger settings that determine how and when the flow runs.

    • triggerType (string) -- [REQUIRED]

      Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event .

    • triggerProperties (dict) --

      Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

      • Scheduled (dict) --

        Specifies the configuration details of a schedule-triggered flow as defined by the user.

        • scheduleExpression (string) -- [REQUIRED]

          The scheduling expression that determines when and how often the rule runs.

        • dataPullMode (string) --

          Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

        • scheduleStartTime (datetime) --

          Specifies the scheduled start time for a schedule-triggered flow.

        • scheduleEndTime (datetime) --

          Specifies the scheduled end time for a schedule-triggered flow.

        • timezone (string) --

          Specifies the time zone used when referring to the date and time of a scheduled-triggered flow.

  • sourceFlowConfig (dict) --

    [REQUIRED]

    The configuration that controls how Amazon AppFlow retrieves data from the source connector.

    • connectorType (string) -- [REQUIRED]

      The type of connector, such as Salesforce, Amplitude, and so on.

    • connectorProfileName (string) --

      The name of the connector profile. This name must be unique for each connector profile in the AWS account.

    • sourceConnectorProperties (dict) -- [REQUIRED]

      Specifies the information that is required to query a particular source connector.

      • Amplitude (dict) --

        Specifies the information that is required for querying Amplitude.

        • object (string) -- [REQUIRED]

          The object specified in the Amplitude flow source.

      • Datadog (dict) --

        Specifies the information that is required for querying Datadog.

        • object (string) -- [REQUIRED]

          The object specified in the Datadog flow source.

      • Dynatrace (dict) --

        Specifies the information that is required for querying Dynatrace.

        • object (string) -- [REQUIRED]

          The object specified in the Dynatrace flow source.

      • GoogleAnalytics (dict) --

        Specifies the information that is required for querying Google Analytics.

        • object (string) -- [REQUIRED]

          The object specified in the Google Analytics flow source.

      • InforNexus (dict) --

        Specifies the information that is required for querying Infor Nexus.

        • object (string) -- [REQUIRED]

          The object specified in the Infor Nexus flow source.

      • Marketo (dict) --

        Specifies the information that is required for querying Marketo.

        • object (string) -- [REQUIRED]

          The object specified in the Marketo flow source.

      • S3 (dict) --

        Specifies the information that is required for querying Amazon S3.

        • bucketName (string) -- [REQUIRED]

          The Amazon S3 bucket name where the source files are stored.

        • bucketPrefix (string) --

          The object key for the Amazon S3 bucket in which the source files are stored.

      • Salesforce (dict) --

        Specifies the information that is required for querying Salesforce.

        • object (string) -- [REQUIRED]

          The object specified in the Salesforce flow source.

        • enableDynamicFieldUpdate (boolean) --

          The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

        • includeDeletedRecords (boolean) --

          Indicates whether Amazon AppFlow includes deleted files in the flow run.

      • ServiceNow (dict) --

        Specifies the information that is required for querying ServiceNow.

        • object (string) -- [REQUIRED]

          The object specified in the ServiceNow flow source.

      • Singular (dict) --

        Specifies the information that is required for querying Singular.

        • object (string) -- [REQUIRED]

          The object specified in the Singular flow source.

      • Slack (dict) --

        Specifies the information that is required for querying Slack.

        • object (string) -- [REQUIRED]

          The object specified in the Slack flow source.

      • Trendmicro (dict) --

        Specifies the information that is required for querying Trend Micro.

        • object (string) -- [REQUIRED]

          The object specified in the Trend Micro flow source.

      • Veeva (dict) --

        Specifies the information that is required for querying Veeva.

        • object (string) -- [REQUIRED]

          The object specified in the Veeva flow source.

      • Zendesk (dict) --

        Specifies the information that is required for querying Zendesk.

        • object (string) -- [REQUIRED]

          The object specified in the Zendesk flow source.

    • incrementalPullConfig (dict) --

      Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

      • datetimeTypeFieldName (string) --

        A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

  • destinationFlowConfigList (list) --

    [REQUIRED]

    The configuration that controls how Amazon AppFlow places data in the destination connector.

    • (dict) --

      Contains information about the configuration of destination connectors present in the flow.

      • connectorType (string) -- [REQUIRED]

        The type of connector, such as Salesforce, Amplitude, and so on.

      • connectorProfileName (string) --

        The name of the connector profile. This name must be unique for each connector profile in the AWS account.

      • destinationConnectorProperties (dict) -- [REQUIRED]

        This stores the information that is required to query a particular connector.

        • Redshift (dict) --

          The properties required to query Amazon Redshift.

          • object (string) -- [REQUIRED]

            The object specified in the Amazon Redshift flow destination.

          • intermediateBucketName (string) -- [REQUIRED]

            The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.

          • bucketPrefix (string) --

            The object key for the bucket in which Amazon AppFlow places the destination files.

          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

        • S3 (dict) --

          The properties required to query Amazon S3.

          • bucketName (string) -- [REQUIRED]

            The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

          • bucketPrefix (string) --

            The object key for the destination bucket in which Amazon AppFlow places the files.

          • s3OutputFormatConfig (dict) --

            The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

            • fileType (string) --

              Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

            • prefixConfig (dict) --

              Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

              • prefixType (string) --

                Determines the level of granularity that's included in the prefix.

              • prefixFormat (string) --

                Determines the format of the prefix, and whether it applies to the file name, file path, or both.

            • aggregationConfig (dict) --

              The aggregation settings that you can use to customize the output format of your flow data.

              • aggregationType (string) --

                Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.

        • Salesforce (dict) --

          The properties required to query Salesforce.

          • object (string) -- [REQUIRED]

            The object specified in the Salesforce flow destination.

          • idFieldNames (list) --

            The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

            • (string) --
          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

          • writeOperationType (string) --

            This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT , then idFieldNames is required.

        • Snowflake (dict) --

          The properties required to query Snowflake.

          • object (string) -- [REQUIRED]

            The object specified in the Snowflake flow destination.

          • intermediateBucketName (string) -- [REQUIRED]

            The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.

          • bucketPrefix (string) --

            The object key for the destination bucket in which Amazon AppFlow places the files.

          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

        • EventBridge (dict) --

          The properties required to query Amazon EventBridge.

          • object (string) -- [REQUIRED]

            The object specified in the Amazon EventBridge flow destination.

          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

  • tasks (list) --

    [REQUIRED]

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

    • (dict) --

      A class for modeling different type of tasks. Task implementation varies based on the TaskType .

      • sourceFields (list) -- [REQUIRED]

        The source fields to which a particular task is applied.

        • (string) --
      • connectorOperator (dict) --

        The operation to be performed on the provided source fields.

        • Amplitude (string) --

          The operation to be performed on the provided Amplitude source fields.

        • Datadog (string) --

          The operation to be performed on the provided Datadog source fields.

        • Dynatrace (string) --

          The operation to be performed on the provided Dynatrace source fields.

        • GoogleAnalytics (string) --

          The operation to be performed on the provided Google Analytics source fields.

        • InforNexus (string) --

          The operation to be performed on the provided Infor Nexus source fields.

        • Marketo (string) --

          The operation to be performed on the provided Marketo source fields.

        • S3 (string) --

          The operation to be performed on the provided Amazon S3 source fields.

        • Salesforce (string) --

          The operation to be performed on the provided Salesforce source fields.

        • ServiceNow (string) --

          The operation to be performed on the provided ServiceNow source fields.

        • Singular (string) --

          The operation to be performed on the provided Singular source fields.

        • Slack (string) --

          The operation to be performed on the provided Slack source fields.

        • Trendmicro (string) --

          The operation to be performed on the provided Trend Micro source fields.

        • Veeva (string) --

          The operation to be performed on the provided Veeva source fields.

        • Zendesk (string) --

          The operation to be performed on the provided Zendesk source fields.

      • destinationField (string) --

        A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

      • taskType (string) -- [REQUIRED]

        Specifies the particular task implementation that Amazon AppFlow performs.

      • taskProperties (dict) --

        A map used to store task-related information. The execution service looks for particular information based on the TaskType .

        • (string) --
          • (string) --
  • tags (dict) --

    The tags used to organize, track, or control access for your flow.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'flowArn': 'string',
    'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended'
}

Response Structure

  • (dict) --

    • flowArn (string) --

      The flow's Amazon Resource Name (ARN).

    • flowStatus (string) --

      Indicates the current status of the flow.

Exceptions

delete_connector_profile(**kwargs)

Enables you to delete an existing connector profile.

See also: AWS API Documentation

Request Syntax

response = client.delete_connector_profile(
    connectorProfileName='string',
    forceDelete=True|False
)
Parameters
  • connectorProfileName (string) --

    [REQUIRED]

    The name of the connector profile. The name is unique for each ConnectorProfile in your account.

  • forceDelete (boolean) -- Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_flow(**kwargs)

Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.

See also: AWS API Documentation

Request Syntax

response = client.delete_flow(
    flowName='string',
    forceDelete=True|False
)
Parameters
  • flowName (string) --

    [REQUIRED]

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

  • forceDelete (boolean) -- Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

describe_connector_entity(**kwargs)

Provides details regarding the entity used with the connector, with a description of the data model for each entity.

See also: AWS API Documentation

Request Syntax

response = client.describe_connector_entity(
    connectorEntityName='string',
    connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
    connectorProfileName='string'
)
Parameters
  • connectorEntityName (string) --

    [REQUIRED]

    The entity name for that connector.

  • connectorType (string) -- The type of connector application, such as Salesforce, Amplitude, and so on.
  • connectorProfileName (string) -- The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
Return type

dict

Returns

Response Syntax

{
    'connectorEntityFields': [
        {
            'identifier': 'string',
            'label': 'string',
            'supportedFieldTypeDetails': {
                'v1': {
                    'fieldType': 'string',
                    'filterOperators': [
                        'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'CONTAINS'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                    ],
                    'supportedValues': [
                        'string',
                    ]
                }
            },
            'description': 'string',
            'sourceProperties': {
                'isRetrievable': True|False,
                'isQueryable': True|False
            },
            'destinationProperties': {
                'isCreatable': True|False,
                'isNullable': True|False,
                'isUpsertable': True|False,
                'isUpdatable': True|False,
                'supportedWriteOperations': [
                    'INSERT'|'UPSERT'|'UPDATE',
                ]
            }
        },
    ]
}

Response Structure

  • (dict) --

    • connectorEntityFields (list) --

      Describes the fields for that connector entity. For example, for an account entity, the fields would be account name , account ID , and so on.

      • (dict) --

        Describes the data model of a connector field. For example, for an account entity, the fields would be account name , account ID , and so on.

        • identifier (string) --

          The unique identifier of the connector field.

        • label (string) --

          The label applied to a connector entity field.

        • supportedFieldTypeDetails (dict) --

          Contains details regarding the supported FieldType , including the corresponding filterOperators and supportedValues .

          • v1 (dict) --

            The initial supported version for fieldType . If this is later changed to a different version, v2 will be introduced.

            • fieldType (string) --

              The type of field, such as string, integer, date, and so on.

            • filterOperators (list) --

              The list of operators supported by a field.

              • (string) --
            • supportedValues (list) --

              The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

              • (string) --
        • description (string) --

          A description of the connector entity field.

        • sourceProperties (dict) --

          The properties that can be applied to a field when the connector is being used as a source.

          • isRetrievable (boolean) --

            Indicates whether the field can be returned in a search result.

          • isQueryable (boolean) --

            Indicates if the field can be queried.

        • destinationProperties (dict) --

          The properties applied to a field when the connector is being used as a destination.

          • isCreatable (boolean) --

            Specifies if the destination field can be created by the current user.

          • isNullable (boolean) --

            Specifies if the destination field can have a null value.

          • isUpsertable (boolean) --

            Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

          • isUpdatable (boolean) --

            Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

          • supportedWriteOperations (list) --

            A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.

            • (string) --

              The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation.

Exceptions

describe_connector_profiles(**kwargs)

Returns a list of connector-profile details matching the provided connector-profile names and connector-types . Both input lists are optional, and you can use them to filter the result.

If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

See also: AWS API Documentation

Request Syntax

response = client.describe_connector_profiles(
    connectorProfileNames=[
        'string',
    ],
    connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
    maxResults=123,
    nextToken='string'
)
Parameters
  • connectorProfileNames (list) --

    The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.

    • (string) --
  • connectorType (string) -- The type of connector, such as Salesforce, Amplitude, and so on.
  • maxResults (integer) -- Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
  • nextToken (string) -- The pagination token for the next page of data.
Return type

dict

Returns

Response Syntax

{
    'connectorProfileDetails': [
        {
            'connectorProfileArn': 'string',
            'connectorProfileName': 'string',
            'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
            'connectionMode': 'Public'|'Private',
            'credentialsArn': 'string',
            'connectorProfileProperties': {
                'Amplitude': {},
                'Datadog': {
                    'instanceUrl': 'string'
                },
                'Dynatrace': {
                    'instanceUrl': 'string'
                },
                'GoogleAnalytics': {},
                'InforNexus': {
                    'instanceUrl': 'string'
                },
                'Marketo': {
                    'instanceUrl': 'string'
                },
                'Redshift': {
                    'databaseUrl': 'string',
                    'bucketName': 'string',
                    'bucketPrefix': 'string',
                    'roleArn': 'string'
                },
                'Salesforce': {
                    'instanceUrl': 'string',
                    'isSandboxEnvironment': True|False
                },
                'ServiceNow': {
                    'instanceUrl': 'string'
                },
                'Singular': {},
                'Slack': {
                    'instanceUrl': 'string'
                },
                'Snowflake': {
                    'warehouse': 'string',
                    'stage': 'string',
                    'bucketName': 'string',
                    'bucketPrefix': 'string',
                    'privateLinkServiceName': 'string',
                    'accountName': 'string',
                    'region': 'string'
                },
                'Trendmicro': {},
                'Veeva': {
                    'instanceUrl': 'string'
                },
                'Zendesk': {
                    'instanceUrl': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • connectorProfileDetails (list) --

      Returns information about the connector profiles associated with the flow.

      • (dict) --

        Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.

        • connectorProfileArn (string) --

          The Amazon Resource Name (ARN) of the connector profile.

        • connectorProfileName (string) --

          The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.

        • connectorType (string) --

          The type of connector, such as Salesforce, Amplitude, and so on.

        • connectionMode (string) --

          Indicates the connection mode and if it is public or private.

        • credentialsArn (string) --

          The Amazon Resource Name (ARN) of the connector profile credentials.

        • connectorProfileProperties (dict) --

          The connector-specific properties of the profile configuration.

          • Amplitude (dict) --

            The connector-specific properties required by Amplitude.

          • Datadog (dict) --

            The connector-specific properties required by Datadog.

            • instanceUrl (string) --

              The location of the Datadog resource.

          • Dynatrace (dict) --

            The connector-specific properties required by Dynatrace.

            • instanceUrl (string) --

              The location of the Dynatrace resource.

          • GoogleAnalytics (dict) --

            The connector-specific properties required Google Analytics.

          • InforNexus (dict) --

            The connector-specific properties required by Infor Nexus.

            • instanceUrl (string) --

              The location of the Infor Nexus resource.

          • Marketo (dict) --

            The connector-specific properties required by Marketo.

            • instanceUrl (string) --

              The location of the Marketo resource.

          • Redshift (dict) --

            The connector-specific properties required by Amazon Redshift.

            • databaseUrl (string) --

              The JDBC URL of the Amazon Redshift cluster.

            • bucketName (string) --

              A name for the associated Amazon S3 bucket.

            • bucketPrefix (string) --

              The object key for the destination bucket in which Amazon AppFlow places the files.

            • roleArn (string) --

              The Amazon Resource Name (ARN) of the IAM role.

          • Salesforce (dict) --

            The connector-specific properties required by Salesforce.

            • instanceUrl (string) --

              The location of the Salesforce resource.

            • isSandboxEnvironment (boolean) --

              Indicates whether the connector profile applies to a sandbox or production environment.

          • ServiceNow (dict) --

            The connector-specific properties required by serviceNow.

            • instanceUrl (string) --

              The location of the ServiceNow resource.

          • Singular (dict) --

            The connector-specific properties required by Singular.

          • Slack (dict) --

            The connector-specific properties required by Slack.

            • instanceUrl (string) --

              The location of the Slack resource.

          • Snowflake (dict) --

            The connector-specific properties required by Snowflake.

            • warehouse (string) --

              The name of the Snowflake warehouse.

            • stage (string) --

              The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.

            • bucketName (string) --

              The name of the Amazon S3 bucket associated with Snowflake.

            • bucketPrefix (string) --

              The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

            • privateLinkServiceName (string) --

              The Snowflake Private Link service name to be used for private data transfers.

            • accountName (string) --

              The name of the account.

            • region (string) --

              The AWS Region of the Snowflake account.

          • Trendmicro (dict) --

            The connector-specific properties required by Trend Micro.

          • Veeva (dict) --

            The connector-specific properties required by Veeva.

            • instanceUrl (string) --

              The location of the Veeva resource.

          • Zendesk (dict) --

            The connector-specific properties required by Zendesk.

            • instanceUrl (string) --

              The location of the Zendesk resource.

        • createdAt (datetime) --

          Specifies when the connector profile was created.

        • lastUpdatedAt (datetime) --

          Specifies when the connector profile was last updated.

    • nextToken (string) --

      The pagination token for the next page of data. If nextToken=null , this means that all records have been fetched.

Exceptions

describe_connectors(**kwargs)

Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.

See also: AWS API Documentation

Request Syntax

response = client.describe_connectors(
    connectorTypes=[
        'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
    ],
    nextToken='string'
)
Parameters
  • connectorTypes (list) --

    The type of connector, such as Salesforce, Amplitude, and so on.

    • (string) --
  • nextToken (string) -- The pagination token for the next page of data.
Return type

dict

Returns

Response Syntax

{
    'connectorConfigurations': {
        'string': {
            'canUseAsSource': True|False,
            'canUseAsDestination': True|False,
            'supportedDestinationConnectors': [
                'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
            ],
            'supportedSchedulingFrequencies': [
                'BYMINUTE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'ONCE',
            ],
            'isPrivateLinkEnabled': True|False,
            'isPrivateLinkEndpointUrlRequired': True|False,
            'supportedTriggerTypes': [
                'Scheduled'|'Event'|'OnDemand',
            ],
            'connectorMetadata': {
                'Amplitude': {},
                'Datadog': {},
                'Dynatrace': {},
                'GoogleAnalytics': {
                    'oAuthScopes': [
                        'string',
                    ]
                },
                'InforNexus': {},
                'Marketo': {},
                'Redshift': {},
                'S3': {},
                'Salesforce': {
                    'oAuthScopes': [
                        'string',
                    ]
                },
                'ServiceNow': {},
                'Singular': {},
                'Slack': {
                    'oAuthScopes': [
                        'string',
                    ]
                },
                'Snowflake': {
                    'supportedRegions': [
                        'string',
                    ]
                },
                'Trendmicro': {},
                'Veeva': {},
                'Zendesk': {
                    'oAuthScopes': [
                        'string',
                    ]
                },
                'EventBridge': {}
            }
        }
    },
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • connectorConfigurations (dict) --

      The configuration that is applied to the connectors used in the flow.

      • (string) --

        • (dict) --

          The configuration settings related to a given connector.

          • canUseAsSource (boolean) --

            Specifies whether the connector can be used as a source.

          • canUseAsDestination (boolean) --

            Specifies whether the connector can be used as a destination.

          • supportedDestinationConnectors (list) --

            Lists the connectors that are available for use as destinations.

            • (string) --
          • supportedSchedulingFrequencies (list) --

            Specifies the supported flow frequency for that connector.

            • (string) --
          • isPrivateLinkEnabled (boolean) --

            Specifies if PrivateLink is enabled for that connector.

          • isPrivateLinkEndpointUrlRequired (boolean) --

            Specifies if a PrivateLink endpoint URL is required.

          • supportedTriggerTypes (list) --

            Specifies the supported trigger types for the flow.

            • (string) --
          • connectorMetadata (dict) --

            Specifies connector-specific metadata such as oAuthScopes , supportedRegions , privateLinkServiceUrl , and so on.

            • Amplitude (dict) --

              The connector metadata specific to Amplitude.

            • Datadog (dict) --

              The connector metadata specific to Datadog.

            • Dynatrace (dict) --

              The connector metadata specific to Dynatrace.

            • GoogleAnalytics (dict) --

              The connector metadata specific to Google Analytics.

              • oAuthScopes (list) --

                The desired authorization scope for the Google Analytics account.

                • (string) --
            • InforNexus (dict) --

              The connector metadata specific to Infor Nexus.

            • Marketo (dict) --

              The connector metadata specific to Marketo.

            • Redshift (dict) --

              The connector metadata specific to Amazon Redshift.

            • S3 (dict) --

              The connector metadata specific to Amazon S3.

            • Salesforce (dict) --

              The connector metadata specific to Salesforce.

              • oAuthScopes (list) --

                The desired authorization scope for the Salesforce account.

                • (string) --
            • ServiceNow (dict) --

              The connector metadata specific to ServiceNow.

            • Singular (dict) --

              The connector metadata specific to Singular.

            • Slack (dict) --

              The connector metadata specific to Slack.

              • oAuthScopes (list) --

                The desired authorization scope for the Slack account.

                • (string) --
            • Snowflake (dict) --

              The connector metadata specific to Snowflake.

              • supportedRegions (list) --

                Specifies the supported AWS Regions when using Snowflake.

                • (string) --
            • Trendmicro (dict) --

              The connector metadata specific to Trend Micro.

            • Veeva (dict) --

              The connector metadata specific to Veeva.

            • Zendesk (dict) --

              The connector metadata specific to Zendesk.

              • oAuthScopes (list) --

                The desired authorization scope for the Zendesk account.

                • (string) --
            • EventBridge (dict) --

              The connector metadata specific to Amazon EventBridge.

    • nextToken (string) --

      The pagination token for the next page of data.

Exceptions

describe_flow(**kwargs)

Provides a description of the specified flow.

See also: AWS API Documentation

Request Syntax

response = client.describe_flow(
    flowName='string'
)
Parameters
flowName (string) --

[REQUIRED]

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Return type
dict
Returns
Response Syntax
{
    'flowArn': 'string',
    'description': 'string',
    'flowName': 'string',
    'kmsArn': 'string',
    'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended',
    'flowStatusMessage': 'string',
    'sourceFlowConfig': {
        'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
        'connectorProfileName': 'string',
        'sourceConnectorProperties': {
            'Amplitude': {
                'object': 'string'
            },
            'Datadog': {
                'object': 'string'
            },
            'Dynatrace': {
                'object': 'string'
            },
            'GoogleAnalytics': {
                'object': 'string'
            },
            'InforNexus': {
                'object': 'string'
            },
            'Marketo': {
                'object': 'string'
            },
            'S3': {
                'bucketName': 'string',
                'bucketPrefix': 'string'
            },
            'Salesforce': {
                'object': 'string',
                'enableDynamicFieldUpdate': True|False,
                'includeDeletedRecords': True|False
            },
            'ServiceNow': {
                'object': 'string'
            },
            'Singular': {
                'object': 'string'
            },
            'Slack': {
                'object': 'string'
            },
            'Trendmicro': {
                'object': 'string'
            },
            'Veeva': {
                'object': 'string'
            },
            'Zendesk': {
                'object': 'string'
            }
        },
        'incrementalPullConfig': {
            'datetimeTypeFieldName': 'string'
        }
    },
    'destinationFlowConfigList': [
        {
            'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
            'connectorProfileName': 'string',
            'destinationConnectorProperties': {
                'Redshift': {
                    'object': 'string',
                    'intermediateBucketName': 'string',
                    'bucketPrefix': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                },
                'S3': {
                    'bucketName': 'string',
                    'bucketPrefix': 'string',
                    's3OutputFormatConfig': {
                        'fileType': 'CSV'|'JSON'|'PARQUET',
                        'prefixConfig': {
                            'prefixType': 'FILENAME'|'PATH'|'PATH_AND_FILENAME',
                            'prefixFormat': 'YEAR'|'MONTH'|'DAY'|'HOUR'|'MINUTE'
                        },
                        'aggregationConfig': {
                            'aggregationType': 'None'|'SingleFile'
                        }
                    }
                },
                'Salesforce': {
                    'object': 'string',
                    'idFieldNames': [
                        'string',
                    ],
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    },
                    'writeOperationType': 'INSERT'|'UPSERT'|'UPDATE'
                },
                'Snowflake': {
                    'object': 'string',
                    'intermediateBucketName': 'string',
                    'bucketPrefix': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                },
                'EventBridge': {
                    'object': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                }
            }
        },
    ],
    'lastRunExecutionDetails': {
        'mostRecentExecutionMessage': 'string',
        'mostRecentExecutionTime': datetime(2015, 1, 1),
        'mostRecentExecutionStatus': 'InProgress'|'Successful'|'Error'
    },
    'triggerConfig': {
        'triggerType': 'Scheduled'|'Event'|'OnDemand',
        'triggerProperties': {
            'Scheduled': {
                'scheduleExpression': 'string',
                'dataPullMode': 'Incremental'|'Complete',
                'scheduleStartTime': datetime(2015, 1, 1),
                'scheduleEndTime': datetime(2015, 1, 1),
                'timezone': 'string'
            }
        }
    },
    'tasks': [
        {
            'sourceFields': [
                'string',
            ],
            'connectorOperator': {
                'Amplitude': 'BETWEEN',
                'Datadog': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Dynatrace': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'GoogleAnalytics': 'PROJECTION'|'BETWEEN',
                'InforNexus': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Singular': 'PROJECTION'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Slack': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Trendmicro': 'PROJECTION'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Veeva': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'CONTAINS'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
            },
            'destinationField': 'string',
            'taskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate',
            'taskProperties': {
                'string': 'string'
            }
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'lastUpdatedBy': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • flowArn (string) --

      The flow's Amazon Resource Name (ARN).

    • description (string) --

      A description of the flow.

    • flowName (string) --

      The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    • kmsArn (string) --

      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

    • flowStatus (string) --

      Indicates the current status of the flow.

    • flowStatusMessage (string) --

      Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.

    • sourceFlowConfig (dict) --

      The configuration that controls how Amazon AppFlow retrieves data from the source connector.

      • connectorType (string) --

        The type of connector, such as Salesforce, Amplitude, and so on.

      • connectorProfileName (string) --

        The name of the connector profile. This name must be unique for each connector profile in the AWS account.

      • sourceConnectorProperties (dict) --

        Specifies the information that is required to query a particular source connector.

        • Amplitude (dict) --

          Specifies the information that is required for querying Amplitude.

          • object (string) --

            The object specified in the Amplitude flow source.

        • Datadog (dict) --

          Specifies the information that is required for querying Datadog.

          • object (string) --

            The object specified in the Datadog flow source.

        • Dynatrace (dict) --

          Specifies the information that is required for querying Dynatrace.

          • object (string) --

            The object specified in the Dynatrace flow source.

        • GoogleAnalytics (dict) --

          Specifies the information that is required for querying Google Analytics.

          • object (string) --

            The object specified in the Google Analytics flow source.

        • InforNexus (dict) --

          Specifies the information that is required for querying Infor Nexus.

          • object (string) --

            The object specified in the Infor Nexus flow source.

        • Marketo (dict) --

          Specifies the information that is required for querying Marketo.

          • object (string) --

            The object specified in the Marketo flow source.

        • S3 (dict) --

          Specifies the information that is required for querying Amazon S3.

          • bucketName (string) --

            The Amazon S3 bucket name where the source files are stored.

          • bucketPrefix (string) --

            The object key for the Amazon S3 bucket in which the source files are stored.

        • Salesforce (dict) --

          Specifies the information that is required for querying Salesforce.

          • object (string) --

            The object specified in the Salesforce flow source.

          • enableDynamicFieldUpdate (boolean) --

            The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

          • includeDeletedRecords (boolean) --

            Indicates whether Amazon AppFlow includes deleted files in the flow run.

        • ServiceNow (dict) --

          Specifies the information that is required for querying ServiceNow.

          • object (string) --

            The object specified in the ServiceNow flow source.

        • Singular (dict) --

          Specifies the information that is required for querying Singular.

          • object (string) --

            The object specified in the Singular flow source.

        • Slack (dict) --

          Specifies the information that is required for querying Slack.

          • object (string) --

            The object specified in the Slack flow source.

        • Trendmicro (dict) --

          Specifies the information that is required for querying Trend Micro.

          • object (string) --

            The object specified in the Trend Micro flow source.

        • Veeva (dict) --

          Specifies the information that is required for querying Veeva.

          • object (string) --

            The object specified in the Veeva flow source.

        • Zendesk (dict) --

          Specifies the information that is required for querying Zendesk.

          • object (string) --

            The object specified in the Zendesk flow source.

      • incrementalPullConfig (dict) --

        Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

        • datetimeTypeFieldName (string) --

          A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

    • destinationFlowConfigList (list) --

      The configuration that controls how Amazon AppFlow transfers data to the destination connector.

      • (dict) --

        Contains information about the configuration of destination connectors present in the flow.

        • connectorType (string) --

          The type of connector, such as Salesforce, Amplitude, and so on.

        • connectorProfileName (string) --

          The name of the connector profile. This name must be unique for each connector profile in the AWS account.

        • destinationConnectorProperties (dict) --

          This stores the information that is required to query a particular connector.

          • Redshift (dict) --

            The properties required to query Amazon Redshift.

            • object (string) --

              The object specified in the Amazon Redshift flow destination.

            • intermediateBucketName (string) --

              The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.

            • bucketPrefix (string) --

              The object key for the bucket in which Amazon AppFlow places the destination files.

            • errorHandlingConfig (dict) --

              The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

              • failOnFirstDestinationError (boolean) --

                Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

              • bucketPrefix (string) --

                Specifies the Amazon S3 bucket prefix.

              • bucketName (string) --

                Specifies the name of the Amazon S3 bucket.

          • S3 (dict) --

            The properties required to query Amazon S3.

            • bucketName (string) --

              The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

            • bucketPrefix (string) --

              The object key for the destination bucket in which Amazon AppFlow places the files.

            • s3OutputFormatConfig (dict) --

              The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

              • fileType (string) --

                Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

              • prefixConfig (dict) --

                Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

                • prefixType (string) --

                  Determines the level of granularity that's included in the prefix.

                • prefixFormat (string) --

                  Determines the format of the prefix, and whether it applies to the file name, file path, or both.

              • aggregationConfig (dict) --

                The aggregation settings that you can use to customize the output format of your flow data.

                • aggregationType (string) --

                  Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.

          • Salesforce (dict) --

            The properties required to query Salesforce.

            • object (string) --

              The object specified in the Salesforce flow destination.

            • idFieldNames (list) --

              The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

              • (string) --
            • errorHandlingConfig (dict) --

              The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

              • failOnFirstDestinationError (boolean) --

                Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

              • bucketPrefix (string) --

                Specifies the Amazon S3 bucket prefix.

              • bucketName (string) --

                Specifies the name of the Amazon S3 bucket.

            • writeOperationType (string) --

              This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT , then idFieldNames is required.

          • Snowflake (dict) --

            The properties required to query Snowflake.

            • object (string) --

              The object specified in the Snowflake flow destination.

            • intermediateBucketName (string) --

              The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.

            • bucketPrefix (string) --

              The object key for the destination bucket in which Amazon AppFlow places the files.

            • errorHandlingConfig (dict) --

              The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

              • failOnFirstDestinationError (boolean) --

                Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

              • bucketPrefix (string) --

                Specifies the Amazon S3 bucket prefix.

              • bucketName (string) --

                Specifies the name of the Amazon S3 bucket.

          • EventBridge (dict) --

            The properties required to query Amazon EventBridge.

            • object (string) --

              The object specified in the Amazon EventBridge flow destination.

            • errorHandlingConfig (dict) --

              The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

              • failOnFirstDestinationError (boolean) --

                Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

              • bucketPrefix (string) --

                Specifies the Amazon S3 bucket prefix.

              • bucketName (string) --

                Specifies the name of the Amazon S3 bucket.

    • lastRunExecutionDetails (dict) --

      Describes the details of the most recent flow run.

      • mostRecentExecutionMessage (string) --

        Describes the details of the most recent flow run.

      • mostRecentExecutionTime (datetime) --

        Specifies the time of the most recent flow run.

      • mostRecentExecutionStatus (string) --

        Specifies the status of the most recent flow run.

    • triggerConfig (dict) --

      The trigger settings that determine how and when the flow runs.

      • triggerType (string) --

        Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event .

      • triggerProperties (dict) --

        Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

        • Scheduled (dict) --

          Specifies the configuration details of a schedule-triggered flow as defined by the user.

          • scheduleExpression (string) --

            The scheduling expression that determines when and how often the rule runs.

          • dataPullMode (string) --

            Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

          • scheduleStartTime (datetime) --

            Specifies the scheduled start time for a schedule-triggered flow.

          • scheduleEndTime (datetime) --

            Specifies the scheduled end time for a schedule-triggered flow.

          • timezone (string) --

            Specifies the time zone used when referring to the date and time of a scheduled-triggered flow.

    • tasks (list) --

      A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

      • (dict) --

        A class for modeling different type of tasks. Task implementation varies based on the TaskType .

        • sourceFields (list) --

          The source fields to which a particular task is applied.

          • (string) --
        • connectorOperator (dict) --

          The operation to be performed on the provided source fields.

          • Amplitude (string) --

            The operation to be performed on the provided Amplitude source fields.

          • Datadog (string) --

            The operation to be performed on the provided Datadog source fields.

          • Dynatrace (string) --

            The operation to be performed on the provided Dynatrace source fields.

          • GoogleAnalytics (string) --

            The operation to be performed on the provided Google Analytics source fields.

          • InforNexus (string) --

            The operation to be performed on the provided Infor Nexus source fields.

          • Marketo (string) --

            The operation to be performed on the provided Marketo source fields.

          • S3 (string) --

            The operation to be performed on the provided Amazon S3 source fields.

          • Salesforce (string) --

            The operation to be performed on the provided Salesforce source fields.

          • ServiceNow (string) --

            The operation to be performed on the provided ServiceNow source fields.

          • Singular (string) --

            The operation to be performed on the provided Singular source fields.

          • Slack (string) --

            The operation to be performed on the provided Slack source fields.

          • Trendmicro (string) --

            The operation to be performed on the provided Trend Micro source fields.

          • Veeva (string) --

            The operation to be performed on the provided Veeva source fields.

          • Zendesk (string) --

            The operation to be performed on the provided Zendesk source fields.

        • destinationField (string) --

          A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

        • taskType (string) --

          Specifies the particular task implementation that Amazon AppFlow performs.

        • taskProperties (dict) --

          A map used to store task-related information. The execution service looks for particular information based on the TaskType .

          • (string) --
            • (string) --
    • createdAt (datetime) --

      Specifies when the flow was created.

    • lastUpdatedAt (datetime) --

      Specifies when the flow was last updated.

    • createdBy (string) --

      The ARN of the user who created the flow.

    • lastUpdatedBy (string) --

      Specifies the user name of the account that performed the most recent update.

    • tags (dict) --

      The tags used to organize, track, or control access for your flow.

      • (string) --
        • (string) --

Exceptions

describe_flow_execution_records(**kwargs)

Fetches the execution history of the flow.

See also: AWS API Documentation

Request Syntax

response = client.describe_flow_execution_records(
    flowName='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • flowName (string) --

    [REQUIRED]

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

  • maxResults (integer) -- Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
  • nextToken (string) -- The pagination token for the next page of data.
Return type

dict

Returns

Response Syntax

{
    'flowExecutions': [
        {
            'executionId': 'string',
            'executionStatus': 'InProgress'|'Successful'|'Error',
            'executionResult': {
                'errorInfo': {
                    'putFailuresCount': 123,
                    'executionMessage': 'string'
                },
                'bytesProcessed': 123,
                'bytesWritten': 123,
                'recordsProcessed': 123
            },
            'startedAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • flowExecutions (list) --

      Returns a list of all instances when this flow was run.

      • (dict) --

        Specifies information about the past flow run instances for a given flow.

        • executionId (string) --

          Specifies the identifier of the given flow run.

        • executionStatus (string) --

          Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.

        • executionResult (dict) --

          Describes the result of the given flow run.

          • errorInfo (dict) --

            Provides any error message information related to the flow run.

            • putFailuresCount (integer) --

              Specifies the failure count for the attempted flow.

            • executionMessage (string) --

              Specifies the error message that appears if a flow fails.

          • bytesProcessed (integer) --

            The total number of bytes processed by the flow run.

          • bytesWritten (integer) --

            The total number of bytes written as a result of the flow run.

          • recordsProcessed (integer) --

            The number of records processed in the flow run.

        • startedAt (datetime) --

          Specifies the start time of the flow run.

        • lastUpdatedAt (datetime) --

          Specifies the time of the most recent update.

    • nextToken (string) --

      The pagination token for the next page of data.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_connector_entities(**kwargs)

Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.

See also: AWS API Documentation

Request Syntax

response = client.list_connector_entities(
    connectorProfileName='string',
    connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
    entitiesPath='string'
)
Parameters
  • connectorProfileName (string) -- The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account, and is used to query the downstream connector.
  • connectorType (string) -- The type of connector, such as Salesforce, Amplitude, and so on.
  • entitiesPath (string) -- This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.
Return type

dict

Returns

Response Syntax

{
    'connectorEntityMap': {
        'string': [
            {
                'name': 'string',
                'label': 'string',
                'hasNestedEntities': True|False
            },
        ]
    }
}

Response Structure

  • (dict) --

    • connectorEntityMap (dict) --

      The response of ListConnectorEntities lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.

      • (string) --

        • (list) --

          • (dict) --

            The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity , whereas a ServiceNow entity might be an Incident .

            • name (string) --

              The name of the connector entity.

            • label (string) --

              The label applied to the connector entity.

            • hasNestedEntities (boolean) --

              Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true" , then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.

Exceptions

list_flows(**kwargs)

Lists all of the flows associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.list_flows(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- Specifies the maximum number of items that should be returned in the result set.
  • nextToken (string) -- The pagination token for next page of data.
Return type

dict

Returns

Response Syntax

{
    'flows': [
        {
            'flowArn': 'string',
            'description': 'string',
            'flowName': 'string',
            'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended',
            'sourceConnectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
            'destinationConnectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
            'triggerType': 'Scheduled'|'Event'|'OnDemand',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'lastUpdatedBy': 'string',
            'tags': {
                'string': 'string'
            },
            'lastRunExecutionDetails': {
                'mostRecentExecutionMessage': 'string',
                'mostRecentExecutionTime': datetime(2015, 1, 1),
                'mostRecentExecutionStatus': 'InProgress'|'Successful'|'Error'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • flows (list) --

      The list of flows associated with your account.

      • (dict) --

        The properties of the flow, such as its source, destination, trigger type, and so on.

        • flowArn (string) --

          The flow's Amazon Resource Name (ARN).

        • description (string) --

          A user-entered description of the flow.

        • flowName (string) --

          The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

        • flowStatus (string) --

          Indicates the current status of the flow.

        • sourceConnectorType (string) --

          Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

        • destinationConnectorType (string) --

          Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

        • triggerType (string) --

          Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event .

        • createdAt (datetime) --

          Specifies when the flow was created.

        • lastUpdatedAt (datetime) --

          Specifies when the flow was last updated.

        • createdBy (string) --

          The ARN of the user who created the flow.

        • lastUpdatedBy (string) --

          Specifies the account user name that most recently updated the flow.

        • tags (dict) --

          The tags used to organize, track, or control access for your flow.

          • (string) --
            • (string) --
        • lastRunExecutionDetails (dict) --

          Describes the details of the most recent flow run.

          • mostRecentExecutionMessage (string) --

            Describes the details of the most recent flow run.

          • mostRecentExecutionTime (datetime) --

            Specifies the time of the most recent flow run.

          • mostRecentExecutionStatus (string) --

            Specifies the status of the most recent flow run.

    • nextToken (string) --

      The pagination token for next page of data.

Exceptions

list_tags_for_resource(**kwargs)

Retrieves the tags that are associated with a specified flow.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the specified flow.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The tags used to organize, track, or control access for your flow.

      • (string) --
        • (string) --

Exceptions

start_flow(**kwargs)

Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.

See also: AWS API Documentation

Request Syntax

response = client.start_flow(
    flowName='string'
)
Parameters
flowName (string) --

[REQUIRED]

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Return type
dict
Returns
Response Syntax
{
    'flowArn': 'string',
    'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended',
    'executionId': 'string'
}

Response Structure

  • (dict) --
    • flowArn (string) --

      The flow's Amazon Resource Name (ARN).

    • flowStatus (string) --

      Indicates the current status of the flow.

    • executionId (string) --

      Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.

Exceptions

stop_flow(**kwargs)

Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.

See also: AWS API Documentation

Request Syntax

response = client.stop_flow(
    flowName='string'
)
Parameters
flowName (string) --

[REQUIRED]

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Return type
dict
Returns
Response Syntax
{
    'flowArn': 'string',
    'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended'
}

Response Structure

  • (dict) --
    • flowArn (string) --

      The flow's Amazon Resource Name (ARN).

    • flowStatus (string) --

      Indicates the current status of the flow.

Exceptions

tag_resource(**kwargs)

Applies a tag to the specified flow.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the flow that you want to tag.

  • tags (dict) --

    [REQUIRED]

    The tags used to organize, track, or control access for your flow.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes a tag from the specified flow.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the flow that you want to untag.

  • tagKeys (list) --

    [REQUIRED]

    The tag keys associated with the tag that you want to remove from your flow.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_connector_profile(**kwargs)

Updates a given connector profile associated with your account.

See also: AWS API Documentation

Request Syntax

response = client.update_connector_profile(
    connectorProfileName='string',
    connectionMode='Public'|'Private',
    connectorProfileConfig={
        'connectorProfileProperties': {
            'Amplitude': {}
            ,
            'Datadog': {
                'instanceUrl': 'string'
            },
            'Dynatrace': {
                'instanceUrl': 'string'
            },
            'GoogleAnalytics': {}
            ,
            'InforNexus': {
                'instanceUrl': 'string'
            },
            'Marketo': {
                'instanceUrl': 'string'
            },
            'Redshift': {
                'databaseUrl': 'string',
                'bucketName': 'string',
                'bucketPrefix': 'string',
                'roleArn': 'string'
            },
            'Salesforce': {
                'instanceUrl': 'string',
                'isSandboxEnvironment': True|False
            },
            'ServiceNow': {
                'instanceUrl': 'string'
            },
            'Singular': {}
            ,
            'Slack': {
                'instanceUrl': 'string'
            },
            'Snowflake': {
                'warehouse': 'string',
                'stage': 'string',
                'bucketName': 'string',
                'bucketPrefix': 'string',
                'privateLinkServiceName': 'string',
                'accountName': 'string',
                'region': 'string'
            },
            'Trendmicro': {}
            ,
            'Veeva': {
                'instanceUrl': 'string'
            },
            'Zendesk': {
                'instanceUrl': 'string'
            }
        },
        'connectorProfileCredentials': {
            'Amplitude': {
                'apiKey': 'string',
                'secretKey': 'string'
            },
            'Datadog': {
                'apiKey': 'string',
                'applicationKey': 'string'
            },
            'Dynatrace': {
                'apiToken': 'string'
            },
            'GoogleAnalytics': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'refreshToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            },
            'InforNexus': {
                'accessKeyId': 'string',
                'userId': 'string',
                'secretAccessKey': 'string',
                'datakey': 'string'
            },
            'Marketo': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            },
            'Redshift': {
                'username': 'string',
                'password': 'string'
            },
            'Salesforce': {
                'accessToken': 'string',
                'refreshToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                },
                'clientCredentialsArn': 'string'
            },
            'ServiceNow': {
                'username': 'string',
                'password': 'string'
            },
            'Singular': {
                'apiKey': 'string'
            },
            'Slack': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            },
            'Snowflake': {
                'username': 'string',
                'password': 'string'
            },
            'Trendmicro': {
                'apiSecretKey': 'string'
            },
            'Veeva': {
                'username': 'string',
                'password': 'string'
            },
            'Zendesk': {
                'clientId': 'string',
                'clientSecret': 'string',
                'accessToken': 'string',
                'oAuthRequest': {
                    'authCode': 'string',
                    'redirectUri': 'string'
                }
            }
        }
    }
)
Parameters
  • connectorProfileName (string) --

    [REQUIRED]

    The name of the connector profile and is unique for each ConnectorProfile in the AWS Account.

  • connectionMode (string) --

    [REQUIRED]

    Indicates the connection mode and if it is public or private.

  • connectorProfileConfig (dict) --

    [REQUIRED]

    Defines the connector-specific profile configuration and credentials.

    • connectorProfileProperties (dict) -- [REQUIRED]

      The connector-specific properties of the profile configuration.

      • Amplitude (dict) --

        The connector-specific properties required by Amplitude.

      • Datadog (dict) --

        The connector-specific properties required by Datadog.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Datadog resource.

      • Dynatrace (dict) --

        The connector-specific properties required by Dynatrace.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Dynatrace resource.

      • GoogleAnalytics (dict) --

        The connector-specific properties required Google Analytics.

      • InforNexus (dict) --

        The connector-specific properties required by Infor Nexus.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Infor Nexus resource.

      • Marketo (dict) --

        The connector-specific properties required by Marketo.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Marketo resource.

      • Redshift (dict) --

        The connector-specific properties required by Amazon Redshift.

        • databaseUrl (string) -- [REQUIRED]

          The JDBC URL of the Amazon Redshift cluster.

        • bucketName (string) -- [REQUIRED]

          A name for the associated Amazon S3 bucket.

        • bucketPrefix (string) --

          The object key for the destination bucket in which Amazon AppFlow places the files.

        • roleArn (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of the IAM role.

      • Salesforce (dict) --

        The connector-specific properties required by Salesforce.

        • instanceUrl (string) --

          The location of the Salesforce resource.

        • isSandboxEnvironment (boolean) --

          Indicates whether the connector profile applies to a sandbox or production environment.

      • ServiceNow (dict) --

        The connector-specific properties required by serviceNow.

        • instanceUrl (string) -- [REQUIRED]

          The location of the ServiceNow resource.

      • Singular (dict) --

        The connector-specific properties required by Singular.

      • Slack (dict) --

        The connector-specific properties required by Slack.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Slack resource.

      • Snowflake (dict) --

        The connector-specific properties required by Snowflake.

        • warehouse (string) -- [REQUIRED]

          The name of the Snowflake warehouse.

        • stage (string) -- [REQUIRED]

          The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.

        • bucketName (string) -- [REQUIRED]

          The name of the Amazon S3 bucket associated with Snowflake.

        • bucketPrefix (string) --

          The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

        • privateLinkServiceName (string) --

          The Snowflake Private Link service name to be used for private data transfers.

        • accountName (string) --

          The name of the account.

        • region (string) --

          The AWS Region of the Snowflake account.

      • Trendmicro (dict) --

        The connector-specific properties required by Trend Micro.

      • Veeva (dict) --

        The connector-specific properties required by Veeva.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Veeva resource.

      • Zendesk (dict) --

        The connector-specific properties required by Zendesk.

        • instanceUrl (string) -- [REQUIRED]

          The location of the Zendesk resource.

    • connectorProfileCredentials (dict) -- [REQUIRED]

      The connector-specific credentials required by each connector.

      • Amplitude (dict) --

        The connector-specific credentials required when using Amplitude.

        • apiKey (string) -- [REQUIRED]

          A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

        • secretKey (string) -- [REQUIRED]

          The Secret Access Key portion of the credentials.

      • Datadog (dict) --

        The connector-specific credentials required when using Datadog.

        • apiKey (string) -- [REQUIRED]

          A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

        • applicationKey (string) -- [REQUIRED]

          Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.

      • Dynatrace (dict) --

        The connector-specific credentials required when using Dynatrace.

        • apiToken (string) -- [REQUIRED]

          The API tokens used by Dynatrace API to authenticate various API calls.

      • GoogleAnalytics (dict) --

        The connector-specific credentials required when using Google Analytics.

        • clientId (string) -- [REQUIRED]

          The identifier for the desired client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Google Analytics resources.

        • refreshToken (string) --

          The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

      • InforNexus (dict) --

        The connector-specific credentials required when using Infor Nexus.

        • accessKeyId (string) -- [REQUIRED]

          The Access Key portion of the credentials.

        • userId (string) -- [REQUIRED]

          The identifier for the user.

        • secretAccessKey (string) -- [REQUIRED]

          The secret key used to sign requests.

        • datakey (string) -- [REQUIRED]

          The encryption keys used to encrypt data.

      • Marketo (dict) --

        The connector-specific credentials required when using Marketo.

        • clientId (string) -- [REQUIRED]

          The identifier for the desired client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Marketo resources.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

      • Redshift (dict) --

        The connector-specific credentials required when using Amazon Redshift.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Salesforce (dict) --

        The connector-specific credentials required when using Salesforce.

        • accessToken (string) --

          The credentials used to access protected Salesforce resources.

        • refreshToken (string) --

          The credentials used to acquire new access tokens.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

        • clientCredentialsArn (string) --

          The secret manager ARN, which contains the client ID and client secret of the connected app.

      • ServiceNow (dict) --

        The connector-specific credentials required when using ServiceNow.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Singular (dict) --

        The connector-specific credentials required when using Singular.

        • apiKey (string) -- [REQUIRED]

          A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

      • Slack (dict) --

        The connector-specific credentials required when using Slack.

        • clientId (string) -- [REQUIRED]

          The identifier for the client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Slack resources.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

      • Snowflake (dict) --

        The connector-specific credentials required when using Snowflake.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Trendmicro (dict) --

        The connector-specific credentials required when using Trend Micro.

        • apiSecretKey (string) -- [REQUIRED]

          The Secret Access Key portion of the credentials.

      • Veeva (dict) --

        The connector-specific credentials required when using Veeva.

        • username (string) -- [REQUIRED]

          The name of the user.

        • password (string) -- [REQUIRED]

          The password that corresponds to the user name.

      • Zendesk (dict) --

        The connector-specific credentials required when using Zendesk.

        • clientId (string) -- [REQUIRED]

          The identifier for the desired client.

        • clientSecret (string) -- [REQUIRED]

          The client secret used by the OAuth client to authenticate to the authorization server.

        • accessToken (string) --

          The credentials used to access protected Zendesk resources.

        • oAuthRequest (dict) --

          The OAuth requirement needed to request security tokens from the connector endpoint.

          • authCode (string) --

            The code provided by the connector when it has been authenticated via the connected app.

          • redirectUri (string) --

            The URL to which the authentication server redirects the browser after authorization has been granted.

Return type

dict

Returns

Response Syntax

{
    'connectorProfileArn': 'string'
}

Response Structure

  • (dict) --

    • connectorProfileArn (string) --

      The Amazon Resource Name (ARN) of the connector profile.

Exceptions

update_flow(**kwargs)

Updates an existing flow.

See also: AWS API Documentation

Request Syntax

response = client.update_flow(
    flowName='string',
    description='string',
    triggerConfig={
        'triggerType': 'Scheduled'|'Event'|'OnDemand',
        'triggerProperties': {
            'Scheduled': {
                'scheduleExpression': 'string',
                'dataPullMode': 'Incremental'|'Complete',
                'scheduleStartTime': datetime(2015, 1, 1),
                'scheduleEndTime': datetime(2015, 1, 1),
                'timezone': 'string'
            }
        }
    },
    sourceFlowConfig={
        'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
        'connectorProfileName': 'string',
        'sourceConnectorProperties': {
            'Amplitude': {
                'object': 'string'
            },
            'Datadog': {
                'object': 'string'
            },
            'Dynatrace': {
                'object': 'string'
            },
            'GoogleAnalytics': {
                'object': 'string'
            },
            'InforNexus': {
                'object': 'string'
            },
            'Marketo': {
                'object': 'string'
            },
            'S3': {
                'bucketName': 'string',
                'bucketPrefix': 'string'
            },
            'Salesforce': {
                'object': 'string',
                'enableDynamicFieldUpdate': True|False,
                'includeDeletedRecords': True|False
            },
            'ServiceNow': {
                'object': 'string'
            },
            'Singular': {
                'object': 'string'
            },
            'Slack': {
                'object': 'string'
            },
            'Trendmicro': {
                'object': 'string'
            },
            'Veeva': {
                'object': 'string'
            },
            'Zendesk': {
                'object': 'string'
            }
        },
        'incrementalPullConfig': {
            'datetimeTypeFieldName': 'string'
        }
    },
    destinationFlowConfigList=[
        {
            'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge',
            'connectorProfileName': 'string',
            'destinationConnectorProperties': {
                'Redshift': {
                    'object': 'string',
                    'intermediateBucketName': 'string',
                    'bucketPrefix': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                },
                'S3': {
                    'bucketName': 'string',
                    'bucketPrefix': 'string',
                    's3OutputFormatConfig': {
                        'fileType': 'CSV'|'JSON'|'PARQUET',
                        'prefixConfig': {
                            'prefixType': 'FILENAME'|'PATH'|'PATH_AND_FILENAME',
                            'prefixFormat': 'YEAR'|'MONTH'|'DAY'|'HOUR'|'MINUTE'
                        },
                        'aggregationConfig': {
                            'aggregationType': 'None'|'SingleFile'
                        }
                    }
                },
                'Salesforce': {
                    'object': 'string',
                    'idFieldNames': [
                        'string',
                    ],
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    },
                    'writeOperationType': 'INSERT'|'UPSERT'|'UPDATE'
                },
                'Snowflake': {
                    'object': 'string',
                    'intermediateBucketName': 'string',
                    'bucketPrefix': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                },
                'EventBridge': {
                    'object': 'string',
                    'errorHandlingConfig': {
                        'failOnFirstDestinationError': True|False,
                        'bucketPrefix': 'string',
                        'bucketName': 'string'
                    }
                }
            }
        },
    ],
    tasks=[
        {
            'sourceFields': [
                'string',
            ],
            'connectorOperator': {
                'Amplitude': 'BETWEEN',
                'Datadog': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Dynatrace': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'GoogleAnalytics': 'PROJECTION'|'BETWEEN',
                'InforNexus': 'PROJECTION'|'BETWEEN'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Singular': 'PROJECTION'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Slack': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Trendmicro': 'PROJECTION'|'EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Veeva': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'CONTAINS'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
                'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
            },
            'destinationField': 'string',
            'taskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate',
            'taskProperties': {
                'string': 'string'
            }
        },
    ]
)
Parameters
  • flowName (string) --

    [REQUIRED]

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

  • description (string) -- A description of the flow.
  • triggerConfig (dict) --

    [REQUIRED]

    The trigger settings that determine how and when the flow runs.

    • triggerType (string) -- [REQUIRED]

      Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event .

    • triggerProperties (dict) --

      Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

      • Scheduled (dict) --

        Specifies the configuration details of a schedule-triggered flow as defined by the user.

        • scheduleExpression (string) -- [REQUIRED]

          The scheduling expression that determines when and how often the rule runs.

        • dataPullMode (string) --

          Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

        • scheduleStartTime (datetime) --

          Specifies the scheduled start time for a schedule-triggered flow.

        • scheduleEndTime (datetime) --

          Specifies the scheduled end time for a schedule-triggered flow.

        • timezone (string) --

          Specifies the time zone used when referring to the date and time of a scheduled-triggered flow.

  • sourceFlowConfig (dict) --

    Contains information about the configuration of the source connector used in the flow.

    • connectorType (string) -- [REQUIRED]

      The type of connector, such as Salesforce, Amplitude, and so on.

    • connectorProfileName (string) --

      The name of the connector profile. This name must be unique for each connector profile in the AWS account.

    • sourceConnectorProperties (dict) -- [REQUIRED]

      Specifies the information that is required to query a particular source connector.

      • Amplitude (dict) --

        Specifies the information that is required for querying Amplitude.

        • object (string) -- [REQUIRED]

          The object specified in the Amplitude flow source.

      • Datadog (dict) --

        Specifies the information that is required for querying Datadog.

        • object (string) -- [REQUIRED]

          The object specified in the Datadog flow source.

      • Dynatrace (dict) --

        Specifies the information that is required for querying Dynatrace.

        • object (string) -- [REQUIRED]

          The object specified in the Dynatrace flow source.

      • GoogleAnalytics (dict) --

        Specifies the information that is required for querying Google Analytics.

        • object (string) -- [REQUIRED]

          The object specified in the Google Analytics flow source.

      • InforNexus (dict) --

        Specifies the information that is required for querying Infor Nexus.

        • object (string) -- [REQUIRED]

          The object specified in the Infor Nexus flow source.

      • Marketo (dict) --

        Specifies the information that is required for querying Marketo.

        • object (string) -- [REQUIRED]

          The object specified in the Marketo flow source.

      • S3 (dict) --

        Specifies the information that is required for querying Amazon S3.

        • bucketName (string) -- [REQUIRED]

          The Amazon S3 bucket name where the source files are stored.

        • bucketPrefix (string) --

          The object key for the Amazon S3 bucket in which the source files are stored.

      • Salesforce (dict) --

        Specifies the information that is required for querying Salesforce.

        • object (string) -- [REQUIRED]

          The object specified in the Salesforce flow source.

        • enableDynamicFieldUpdate (boolean) --

          The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

        • includeDeletedRecords (boolean) --

          Indicates whether Amazon AppFlow includes deleted files in the flow run.

      • ServiceNow (dict) --

        Specifies the information that is required for querying ServiceNow.

        • object (string) -- [REQUIRED]

          The object specified in the ServiceNow flow source.

      • Singular (dict) --

        Specifies the information that is required for querying Singular.

        • object (string) -- [REQUIRED]

          The object specified in the Singular flow source.

      • Slack (dict) --

        Specifies the information that is required for querying Slack.

        • object (string) -- [REQUIRED]

          The object specified in the Slack flow source.

      • Trendmicro (dict) --

        Specifies the information that is required for querying Trend Micro.

        • object (string) -- [REQUIRED]

          The object specified in the Trend Micro flow source.

      • Veeva (dict) --

        Specifies the information that is required for querying Veeva.

        • object (string) -- [REQUIRED]

          The object specified in the Veeva flow source.

      • Zendesk (dict) --

        Specifies the information that is required for querying Zendesk.

        • object (string) -- [REQUIRED]

          The object specified in the Zendesk flow source.

    • incrementalPullConfig (dict) --

      Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

      • datetimeTypeFieldName (string) --

        A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

  • destinationFlowConfigList (list) --

    [REQUIRED]

    The configuration that controls how Amazon AppFlow transfers data to the destination connector.

    • (dict) --

      Contains information about the configuration of destination connectors present in the flow.

      • connectorType (string) -- [REQUIRED]

        The type of connector, such as Salesforce, Amplitude, and so on.

      • connectorProfileName (string) --

        The name of the connector profile. This name must be unique for each connector profile in the AWS account.

      • destinationConnectorProperties (dict) -- [REQUIRED]

        This stores the information that is required to query a particular connector.

        • Redshift (dict) --

          The properties required to query Amazon Redshift.

          • object (string) -- [REQUIRED]

            The object specified in the Amazon Redshift flow destination.

          • intermediateBucketName (string) -- [REQUIRED]

            The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.

          • bucketPrefix (string) --

            The object key for the bucket in which Amazon AppFlow places the destination files.

          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

        • S3 (dict) --

          The properties required to query Amazon S3.

          • bucketName (string) -- [REQUIRED]

            The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

          • bucketPrefix (string) --

            The object key for the destination bucket in which Amazon AppFlow places the files.

          • s3OutputFormatConfig (dict) --

            The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

            • fileType (string) --

              Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

            • prefixConfig (dict) --

              Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

              • prefixType (string) --

                Determines the level of granularity that's included in the prefix.

              • prefixFormat (string) --

                Determines the format of the prefix, and whether it applies to the file name, file path, or both.

            • aggregationConfig (dict) --

              The aggregation settings that you can use to customize the output format of your flow data.

              • aggregationType (string) --

                Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.

        • Salesforce (dict) --

          The properties required to query Salesforce.

          • object (string) -- [REQUIRED]

            The object specified in the Salesforce flow destination.

          • idFieldNames (list) --

            The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

            • (string) --
          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

          • writeOperationType (string) --

            This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT , then idFieldNames is required.

        • Snowflake (dict) --

          The properties required to query Snowflake.

          • object (string) -- [REQUIRED]

            The object specified in the Snowflake flow destination.

          • intermediateBucketName (string) -- [REQUIRED]

            The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.

          • bucketPrefix (string) --

            The object key for the destination bucket in which Amazon AppFlow places the files.

          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

        • EventBridge (dict) --

          The properties required to query Amazon EventBridge.

          • object (string) -- [REQUIRED]

            The object specified in the Amazon EventBridge flow destination.

          • errorHandlingConfig (dict) --

            The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

            • failOnFirstDestinationError (boolean) --

              Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

            • bucketPrefix (string) --

              Specifies the Amazon S3 bucket prefix.

            • bucketName (string) --

              Specifies the name of the Amazon S3 bucket.

  • tasks (list) --

    [REQUIRED]

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

    • (dict) --

      A class for modeling different type of tasks. Task implementation varies based on the TaskType .

      • sourceFields (list) -- [REQUIRED]

        The source fields to which a particular task is applied.

        • (string) --
      • connectorOperator (dict) --

        The operation to be performed on the provided source fields.

        • Amplitude (string) --

          The operation to be performed on the provided Amplitude source fields.

        • Datadog (string) --

          The operation to be performed on the provided Datadog source fields.

        • Dynatrace (string) --

          The operation to be performed on the provided Dynatrace source fields.

        • GoogleAnalytics (string) --

          The operation to be performed on the provided Google Analytics source fields.

        • InforNexus (string) --

          The operation to be performed on the provided Infor Nexus source fields.

        • Marketo (string) --

          The operation to be performed on the provided Marketo source fields.

        • S3 (string) --

          The operation to be performed on the provided Amazon S3 source fields.

        • Salesforce (string) --

          The operation to be performed on the provided Salesforce source fields.

        • ServiceNow (string) --

          The operation to be performed on the provided ServiceNow source fields.

        • Singular (string) --

          The operation to be performed on the provided Singular source fields.

        • Slack (string) --

          The operation to be performed on the provided Slack source fields.

        • Trendmicro (string) --

          The operation to be performed on the provided Trend Micro source fields.

        • Veeva (string) --

          The operation to be performed on the provided Veeva source fields.

        • Zendesk (string) --

          The operation to be performed on the provided Zendesk source fields.

      • destinationField (string) --

        A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

      • taskType (string) -- [REQUIRED]

        Specifies the particular task implementation that Amazon AppFlow performs.

      • taskProperties (dict) --

        A map used to store task-related information. The execution service looks for particular information based on the TaskType .

        • (string) --
          • (string) --
Return type

dict

Returns

Response Syntax

{
    'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended'
}

Response Structure

  • (dict) --

    • flowStatus (string) --

      Indicates the current status of the flow.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class Appflow.Client.exceptions.ConflictException

There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Appflow.Client.exceptions.ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

Example

try:
  ...
except client.exceptions.ConnectorAuthenticationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An error occurred when authenticating with the connector endpoint.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Appflow.Client.exceptions.ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

Example

try:
  ...
except client.exceptions.ConnectorServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An error occurred when retrieving data from the connector endpoint.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Appflow.Client.exceptions.InternalServerException

An internal service error occurred during the processing of your request. Try again later.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An internal service error occurred during the processing of your request. Try again later.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Appflow.Client.exceptions.ResourceNotFoundException

The resource specified in the request (such as the source or destination connector profile) is not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource specified in the request (such as the source or destination connector profile) is not found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Appflow.Client.exceptions.ServiceQuotaExceededException

The request would cause a service quota (such as the number of flows) to be exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request would cause a service quota (such as the number of flows) to be exceeded.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Appflow.Client.exceptions.UnsupportedOperationException

The requested operation is not supported for the current flow.

Example

try:
  ...
except client.exceptions.UnsupportedOperationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested operation is not supported for the current flow.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Appflow.Client.exceptions.ValidationException

The request has invalid or missing parameters.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request has invalid or missing parameters.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: