Skip to content
AWS for Query.Farm

aws.appflow.describe_flow

Example SQL Queries

SELECT * FROM
aws.appflow.describe_flow
WHERE
"flow_name" = 'VALUE';

Description

Provides a description of the specified flow.

Table Definition

Column NameColumn Data Type
flow_name Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
created_at

Specifies when the flow was created. 

TIMESTAMP_S
created_by

The ARN of the user who created the flow. 

VARCHAR
description

A description of the flow. 

VARCHAR
destination_flow_config_list

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

STRUCT(
    "connector_type" VARCHAR,
    "api_version" VARCHAR,
    "connector_profile_name" VARCHAR,
    "destination_connector_properties" STRUCT(
        "redshift" STRUCT(
            "object" VARCHAR,
            "intermediate_bucket_name" VARCHAR,
            "bucket_prefix" VARCHAR,
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            )
        ),
        "s3" STRUCT(
            "bucket_name" VARCHAR,
            "bucket_prefix" VARCHAR,
            "s3_output_format_config" STRUCT(
                "file_type" VARCHAR,
                "prefix_config" STRUCT(
                    "prefix_type" VARCHAR,
                    "prefix_format" VARCHAR,
                    "path_prefix_hierarchy" VARCHAR[]
                ),
                "aggregation_config" STRUCT(
                    "aggregation_type" VARCHAR,
                    "target_file_size" BIGINT
                ),
                "preserve_source_data_typing" BOOLEAN
            )
        ),
        "salesforce" STRUCT(
            "object" VARCHAR,
            "id_field_names" VARCHAR[],
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            ),
            "write_operation_type" VARCHAR,
            "data_transfer_api" VARCHAR
        ),
        "snowflake" STRUCT(
            "object" VARCHAR,
            "intermediate_bucket_name" VARCHAR,
            "bucket_prefix" VARCHAR,
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            )
        ),
        "event_bridge" STRUCT(
            "object" VARCHAR,
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            )
        ),
        "lookout_metrics" BOOLEAN,
        "upsolver" STRUCT(
            "bucket_name" VARCHAR,
            "bucket_prefix" VARCHAR,
            "s3_output_format_config" STRUCT(
                "file_type" VARCHAR,
                "prefix_config" STRUCT(
                    "prefix_type" VARCHAR,
                    "prefix_format" VARCHAR,
                    "path_prefix_hierarchy" VARCHAR[]
                ),
                "aggregation_config" STRUCT(
                    "aggregation_type" VARCHAR,
                    "target_file_size" BIGINT
                )
            )
        ),
        "honeycode" STRUCT(
            "object" VARCHAR,
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            )
        ),
        "customer_profiles" STRUCT(
            "domain_name" VARCHAR,
            "object_type_name" VARCHAR
        ),
        "zendesk" STRUCT(
            "object" VARCHAR,
            "id_field_names" VARCHAR[],
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            ),
            "write_operation_type" VARCHAR
        ),
        "marketo" STRUCT(
            "object" VARCHAR,
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            )
        ),
        "custom_connector" STRUCT(
            "entity_name" VARCHAR,
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            ),
            "write_operation_type" VARCHAR,
            "id_field_names" VARCHAR[],
            "custom_properties" MAP(VARCHAR, VARCHAR)
        ),
        "sapo_data" STRUCT(
            "object_path" VARCHAR,
            "success_response_handling_config" STRUCT(
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            ),
            "id_field_names" VARCHAR[],
            "error_handling_config" STRUCT(
                "fail_on_first_destination_error" BOOLEAN,
                "bucket_prefix" VARCHAR,
                "bucket_name" VARCHAR
            ),
            "write_operation_type" VARCHAR
        )
    )
)[]
Show child fields
destination_flow_config_list[]
Show child fields
destination_flow_config_list[].api_version

The API version that the destination connector uses.

destination_flow_config_list[].connector_profile_name

The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.

destination_flow_config_list[].connector_type

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

destination_flow_config_list[].destination_connector_properties

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

Show child fields
destination_flow_config_list[].destination_connector_properties.custom_connector

The properties that are required to query the custom Connector.

Show child fields
destination_flow_config_list[].destination_connector_properties.custom_connector.custom_properties

The custom properties that are specific to the connector when it's used as a destination in the flow.

destination_flow_config_list[].destination_connector_properties.custom_connector.entity_name

The entity specified in the custom connector as a destination in the flow.

destination_flow_config_list[].destination_connector_properties.custom_connector.error_handling_config

The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.

Show child fields
destination_flow_config_list[].destination_connector_properties.custom_connector.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.custom_connector.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.custom_connector.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.custom_connector.id_field_names[]
destination_flow_config_list[].destination_connector_properties.custom_connector.write_operation_type

Specifies the type of write operation to be performed in the custom connector when it's used as destination.

destination_flow_config_list[].destination_connector_properties.customer_profiles

The properties required to query Amazon Connect Customer Profiles.

Show child fields
destination_flow_config_list[].destination_connector_properties.customer_profiles.domain_name

The unique name of the Amazon Connect Customer Profiles domain.

destination_flow_config_list[].destination_connector_properties.customer_profiles.object_type_name

The object specified in the Amazon Connect Customer Profiles flow destination.

destination_flow_config_list[].destination_connector_properties.event_bridge

The properties required to query Amazon EventBridge.

Show child fields
destination_flow_config_list[].destination_connector_properties.event_bridge.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.event_bridge.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.event_bridge.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.event_bridge.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.event_bridge.object

The object specified in the Amazon EventBridge flow destination.

destination_flow_config_list[].destination_connector_properties.honeycode

The properties required to query Amazon Honeycode.

Show child fields
destination_flow_config_list[].destination_connector_properties.honeycode.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.honeycode.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.honeycode.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.honeycode.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.honeycode.object

The object specified in the Amazon Honeycode flow destination.

destination_flow_config_list[].destination_connector_properties.lookout_metrics

The properties required to query Amazon Lookout for Metrics.

destination_flow_config_list[].destination_connector_properties.marketo

The properties required to query Marketo.

Show child fields
destination_flow_config_list[].destination_connector_properties.marketo.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.marketo.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.marketo.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.marketo.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.marketo.object

The object specified in the Marketo flow destination.

destination_flow_config_list[].destination_connector_properties.redshift

The properties required to query Amazon Redshift.

Show child fields
destination_flow_config_list[].destination_connector_properties.redshift.bucket_prefix

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

destination_flow_config_list[].destination_connector_properties.redshift.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.redshift.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.redshift.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.redshift.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.redshift.intermediate_bucket_name

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

destination_flow_config_list[].destination_connector_properties.redshift.object

The object specified in the Amazon Redshift flow destination.

destination_flow_config_list[].destination_connector_properties.s3

The properties required to query Amazon S3.

Show child fields
destination_flow_config_list[].destination_connector_properties.s3.bucket_name

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

destination_flow_config_list[].destination_connector_properties.s3.bucket_prefix

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

destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config

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

Show child fields
destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.aggregation_config

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

Show child fields
destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.aggregation_config.aggregation_type

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

destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.aggregation_config.target_file_size

The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this target based on the number and size of the records that each file contains.

destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.file_type

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

destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.prefix_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.prefix_config.path_prefix_hierarchy[]
destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.prefix_config.prefix_format

Determines the level of granularity for the date and time that's included in the prefix.

destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.prefix_config.prefix_type

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

destination_flow_config_list[].destination_connector_properties.s3.s3_output_format_config.preserve_source_data_typing

If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.

  • true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output.

  • false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output.

destination_flow_config_list[].destination_connector_properties.salesforce

The properties required to query Salesforce.

Show child fields
destination_flow_config_list[].destination_connector_properties.salesforce.data_transfer_api

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.

AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.

BULKV2

Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound fields.

REST_SYNC

Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.

destination_flow_config_list[].destination_connector_properties.salesforce.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.salesforce.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.salesforce.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.salesforce.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.salesforce.id_field_names[]
destination_flow_config_list[].destination_connector_properties.salesforce.object

The object specified in the Salesforce flow destination.

destination_flow_config_list[].destination_connector_properties.salesforce.write_operation_type

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

destination_flow_config_list[].destination_connector_properties.sapo_data

The properties required to query SAPOData.

Show child fields
destination_flow_config_list[].destination_connector_properties.sapo_data.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.sapo_data.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.sapo_data.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.sapo_data.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.sapo_data.id_field_names[]
destination_flow_config_list[].destination_connector_properties.sapo_data.object_path

The object path specified in the SAPOData flow destination.

destination_flow_config_list[].destination_connector_properties.sapo_data.success_response_handling_config

Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.

For example, this setting would determine where to write the response from a destination connector upon a successful insert operation.

Show child fields
destination_flow_config_list[].destination_connector_properties.sapo_data.success_response_handling_config.bucket_name

The name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.sapo_data.success_response_handling_config.bucket_prefix

The Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.sapo_data.write_operation_type

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

destination_flow_config_list[].destination_connector_properties.snowflake

The properties required to query Snowflake.

Show child fields
destination_flow_config_list[].destination_connector_properties.snowflake.bucket_prefix

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

destination_flow_config_list[].destination_connector_properties.snowflake.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.snowflake.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.snowflake.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.snowflake.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.snowflake.intermediate_bucket_name

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

destination_flow_config_list[].destination_connector_properties.snowflake.object

The object specified in the Snowflake flow destination.

destination_flow_config_list[].destination_connector_properties.upsolver

The properties required to query Upsolver.

Show child fields
destination_flow_config_list[].destination_connector_properties.upsolver.bucket_name

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

destination_flow_config_list[].destination_connector_properties.upsolver.bucket_prefix

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

destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config

The configuration that determines how data is formatted when Upsolver is used as the flow destination.

Show child fields
destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.aggregation_config

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

Show child fields
destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.aggregation_config.aggregation_type

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

destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.aggregation_config.target_file_size

The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this target based on the number and size of the records that each file contains.

destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.file_type

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

destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.prefix_config

Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.

Show child fields
destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.prefix_config.path_prefix_hierarchy[]
destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.prefix_config.prefix_format

Determines the level of granularity for the date and time that's included in the prefix.

destination_flow_config_list[].destination_connector_properties.upsolver.s3_output_format_config.prefix_config.prefix_type

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

destination_flow_config_list[].destination_connector_properties.zendesk

The properties required to query Zendesk.

Show child fields
destination_flow_config_list[].destination_connector_properties.zendesk.error_handling_config

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.

Show child fields
destination_flow_config_list[].destination_connector_properties.zendesk.error_handling_config.bucket_name

Specifies the name of the Amazon S3 bucket.

destination_flow_config_list[].destination_connector_properties.zendesk.error_handling_config.bucket_prefix

Specifies the Amazon S3 bucket prefix.

destination_flow_config_list[].destination_connector_properties.zendesk.error_handling_config.fail_on_first_destination_error

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

destination_flow_config_list[].destination_connector_properties.zendesk.id_field_names[]
destination_flow_config_list[].destination_connector_properties.zendesk.object

The object specified in the Zendesk flow destination.

destination_flow_config_list[].destination_connector_properties.zendesk.write_operation_type

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

flow_arn

The flow's Amazon Resource Name (ARN). 

VARCHAR
flow_status

Indicates the current status of the flow. 

VARCHAR
flow_status_message

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

VARCHAR
kms_arn

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. 

VARCHAR
last_run_execution_details

Describes the details of the most recent flow run. 

STRUCT(
    "most_recent_execution_message" VARCHAR,
    "most_recent_execution_time" TIMESTAMP_S,
    "most_recent_execution_status" VARCHAR
)
Show child fields
last_run_execution_details.most_recent_execution_message

Describes the details of the most recent flow run.

last_run_execution_details.most_recent_execution_status

Specifies the status of the most recent flow run.

last_run_execution_details.most_recent_execution_time

Specifies the time of the most recent flow run.

last_run_metadata_catalog_details

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

STRUCT(
    "catalog_type" VARCHAR,
    "table_name" VARCHAR,
    "table_registration_output" STRUCT(
        "message" VARCHAR,
        "result" VARCHAR,
        "status" VARCHAR
    ),
    "partition_registration_output" STRUCT(
        "message" VARCHAR,
        "result" VARCHAR,
        "status" VARCHAR
    )
)[]
Show child fields
last_run_metadata_catalog_details[]
Show child fields
last_run_metadata_catalog_details[].catalog_type

The type of metadata catalog that Amazon AppFlow used for the associated flow run. This parameter returns the following value:

GLUE

The metadata catalog is provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a component.

last_run_metadata_catalog_details[].partition_registration_output

Describes the status of the attempt from Amazon AppFlow to register the data partitions with the metadata catalog. The data partitions organize the flow output into a hierarchical path, such as a folder path in an S3 bucket. Amazon AppFlow creates the partitions (if they don't already exist) based on your flow configuration.

Show child fields
last_run_metadata_catalog_details[].partition_registration_output.message

Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains why.

last_run_metadata_catalog_details[].partition_registration_output.result

Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions.

last_run_metadata_catalog_details[].partition_registration_output.status

Indicates the status of the registration attempt from Amazon AppFlow.

last_run_metadata_catalog_details[].table_name

The name of the table that stores the metadata for the associated flow run. The table stores metadata that represents the data that the flow transferred. Amazon AppFlow stores the table in the metadata catalog.

last_run_metadata_catalog_details[].table_registration_output

Describes the status of the attempt from Amazon AppFlow to register the metadata table with the metadata catalog. Amazon AppFlow creates or updates this table for the associated flow run.

Show child fields
last_run_metadata_catalog_details[].table_registration_output.message

Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains why.

last_run_metadata_catalog_details[].table_registration_output.result

Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions.

last_run_metadata_catalog_details[].table_registration_output.status

Indicates the status of the registration attempt from Amazon AppFlow.

last_updated_at

Specifies when the flow was last updated. 

TIMESTAMP_S
last_updated_by

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

VARCHAR
metadata_catalog_config

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

STRUCT(
    "glue_data_catalog" STRUCT(
        "role_arn" VARCHAR,
        "database_name" VARCHAR,
        "table_prefix" VARCHAR
    )
)
Show child fields
metadata_catalog_config.glue_data_catalog

Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog.

Show child fields
metadata_catalog_config.glue_data_catalog.database_name

The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.

When you configure a new flow with this parameter, you must specify an existing database.

metadata_catalog_config.glue_data_catalog.role_arn

The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.

For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.

metadata_catalog_config.glue_data_catalog.table_prefix

A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.

schema_version

The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

  • Source-to-destination field mappings

  • Field data types

  • Partition keys

BIGINT
source_flow_config

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

STRUCT(
    "connector_type" VARCHAR,
    "api_version" VARCHAR,
    "connector_profile_name" VARCHAR,
    "source_connector_properties" STRUCT(
        "amplitude" STRUCT(
            "object" VARCHAR
        ),
        "datadog" STRUCT(
            "object" VARCHAR
        ),
        "dynatrace" STRUCT(
            "object" VARCHAR
        ),
        "google_analytics" STRUCT(
            "object" VARCHAR
        ),
        "infor_nexus" STRUCT(
            "object" VARCHAR
        ),
        "marketo" STRUCT(
            "object" VARCHAR
        ),
        "s3" STRUCT(
            "bucket_name" VARCHAR,
            "bucket_prefix" VARCHAR,
            "s3_input_format_config" STRUCT(
                "s3_input_file_type" VARCHAR
            )
        ),
        "salesforce" STRUCT(
            "object" VARCHAR,
            "enable_dynamic_field_update" BOOLEAN,
            "include_deleted_records" BOOLEAN,
            "data_transfer_api" VARCHAR
        ),
        "service_now" STRUCT(
            "object" VARCHAR
        ),
        "singular" STRUCT(
            "object" VARCHAR
        ),
        "slack" STRUCT(
            "object" VARCHAR
        ),
        "trendmicro" STRUCT(
            "object" VARCHAR
        ),
        "veeva" STRUCT(
            "object" VARCHAR,
            "document_type" VARCHAR,
            "include_source_files" BOOLEAN,
            "include_renditions" BOOLEAN,
            "include_all_versions" BOOLEAN
        ),
        "zendesk" STRUCT(
            "object" VARCHAR
        ),
        "sapo_data" STRUCT(
            "object_path" VARCHAR,
            "parallelism_config" STRUCT(
                "max_parallelism" BIGINT
            ),
            "pagination_config" STRUCT(
                "max_page_size" BIGINT
            )
        ),
        "custom_connector" STRUCT(
            "entity_name" VARCHAR,
            "custom_properties" MAP(VARCHAR, VARCHAR),
            "data_transfer_api" STRUCT(
                "name" VARCHAR,
                "type" VARCHAR
            )
        ),
        "pardot" STRUCT(
            "object" VARCHAR
        )
    ),
    "incremental_pull_config" STRUCT(
        "datetime_type_field_name" VARCHAR
    )
)
Show child fields
source_flow_config.api_version

The API version of the connector when it's used as a source in the flow.

source_flow_config.connector_profile_name

The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.

source_flow_config.connector_type

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

source_flow_config.incremental_pull_config

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.

Show child fields
source_flow_config.incremental_pull_config.datetime_type_field_name

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

source_flow_config.source_connector_properties

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

Show child fields
source_flow_config.source_connector_properties.amplitude

Specifies the information that is required for querying Amplitude.

Show child fields
source_flow_config.source_connector_properties.amplitude.object

The object specified in the Amplitude flow source.

source_flow_config.source_connector_properties.custom_connector

The properties that are applied when the custom connector is being used as a source.

Show child fields
source_flow_config.source_connector_properties.custom_connector.custom_properties

Custom properties that are required to use the custom connector as a source.

source_flow_config.source_connector_properties.custom_connector.data_transfer_api

The API of the connector application that Amazon AppFlow uses to transfer your data.

Show child fields
source_flow_config.source_connector_properties.custom_connector.data_transfer_api.name

The name of the connector application API.

source_flow_config.source_connector_properties.custom_connector.data_transfer_api.type

You can specify one of the following types:

AUTOMATIC

The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.

SYNC

A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.

ASYNC

An asynchronous API. This type of API optimizes a flow for large datasets.

source_flow_config.source_connector_properties.custom_connector.entity_name

The entity specified in the custom connector as a source in the flow.

source_flow_config.source_connector_properties.datadog

Specifies the information that is required for querying Datadog.

Show child fields
source_flow_config.source_connector_properties.datadog.object

The object specified in the Datadog flow source.

source_flow_config.source_connector_properties.dynatrace

Specifies the information that is required for querying Dynatrace.

Show child fields
source_flow_config.source_connector_properties.dynatrace.object

The object specified in the Dynatrace flow source.

source_flow_config.source_connector_properties.google_analytics

Specifies the information that is required for querying Google Analytics.

Show child fields
source_flow_config.source_connector_properties.google_analytics.object

The object specified in the Google Analytics flow source.

source_flow_config.source_connector_properties.infor_nexus

Specifies the information that is required for querying Infor Nexus.

Show child fields
source_flow_config.source_connector_properties.infor_nexus.object

The object specified in the Infor Nexus flow source.

source_flow_config.source_connector_properties.marketo

Specifies the information that is required for querying Marketo.

Show child fields
source_flow_config.source_connector_properties.marketo.object

The object specified in the Marketo flow source.

source_flow_config.source_connector_properties.pardot

Specifies the information that is required for querying Salesforce Pardot.

Show child fields
source_flow_config.source_connector_properties.pardot.object

The object specified in the Salesforce Pardot flow source.

source_flow_config.source_connector_properties.s3

Specifies the information that is required for querying Amazon S3.

Show child fields
source_flow_config.source_connector_properties.s3.bucket_name

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

source_flow_config.source_connector_properties.s3.bucket_prefix

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

source_flow_config.source_connector_properties.s3.s3_input_format_config

When you use Amazon S3 as the source, the configuration format that you provide the flow input data.

Show child fields
source_flow_config.source_connector_properties.s3.s3_input_format_config.s3_input_file_type

The file type that Amazon AppFlow gets from your Amazon S3 bucket.

source_flow_config.source_connector_properties.salesforce

Specifies the information that is required for querying Salesforce.

Show child fields
source_flow_config.source_connector_properties.salesforce.data_transfer_api

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.

AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.

BULKV2

Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound fields.

REST_SYNC

Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.

source_flow_config.source_connector_properties.salesforce.enable_dynamic_field_update

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

source_flow_config.source_connector_properties.salesforce.include_deleted_records

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

source_flow_config.source_connector_properties.salesforce.object

The object specified in the Salesforce flow source.

source_flow_config.source_connector_properties.sapo_data

The properties that are applied when using SAPOData as a flow source.

Show child fields
source_flow_config.source_connector_properties.sapo_data.object_path

The object path specified in the SAPOData flow source.

source_flow_config.source_connector_properties.sapo_data.pagination_config

Sets the page size for each concurrent process that transfers OData records from your SAP instance.

Show child fields
source_flow_config.source_connector_properties.sapo_data.pagination_config.max_page_size

The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes from an ODP provider, the maximum page size is 10,000.

source_flow_config.source_connector_properties.sapo_data.parallelism_config

Sets the number of concurrent processes that transfers OData records from your SAP instance.

Show child fields
source_flow_config.source_connector_properties.sapo_data.parallelism_config.max_parallelism

The maximum number of processes that Amazon AppFlow runs at the same time when it retrieves your data from your SAP application.

source_flow_config.source_connector_properties.service_now

Specifies the information that is required for querying ServiceNow.

Show child fields
source_flow_config.source_connector_properties.service_now.object

The object specified in the ServiceNow flow source.

source_flow_config.source_connector_properties.singular

Specifies the information that is required for querying Singular.

Show child fields
source_flow_config.source_connector_properties.singular.object

The object specified in the Singular flow source.

source_flow_config.source_connector_properties.slack

Specifies the information that is required for querying Slack.

Show child fields
source_flow_config.source_connector_properties.slack.object

The object specified in the Slack flow source.

source_flow_config.source_connector_properties.trendmicro

Specifies the information that is required for querying Trend Micro.

Show child fields
source_flow_config.source_connector_properties.trendmicro.object

The object specified in the Trend Micro flow source.

source_flow_config.source_connector_properties.veeva

Specifies the information that is required for querying Veeva.

Show child fields
source_flow_config.source_connector_properties.veeva.document_type

The document type specified in the Veeva document extract flow.

source_flow_config.source_connector_properties.veeva.include_all_versions

Boolean value to include All Versions of files in Veeva document extract flow.

source_flow_config.source_connector_properties.veeva.include_renditions

Boolean value to include file renditions in Veeva document extract flow.

source_flow_config.source_connector_properties.veeva.include_source_files

Boolean value to include source files in Veeva document extract flow.

source_flow_config.source_connector_properties.veeva.object

The object specified in the Veeva flow source.

source_flow_config.source_connector_properties.zendesk

Specifies the information that is required for querying Zendesk.

Show child fields
source_flow_config.source_connector_properties.zendesk.object

The object specified in the Zendesk flow source.

tags

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

MAP(VARCHAR, VARCHAR)
tasks

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

STRUCT(
    "source_fields" VARCHAR[],
    "connector_operator" STRUCT(
        "amplitude" VARCHAR,
        "datadog" VARCHAR,
        "dynatrace" VARCHAR,
        "google_analytics" VARCHAR,
        "infor_nexus" VARCHAR,
        "marketo" VARCHAR,
        "s3" VARCHAR,
        "salesforce" VARCHAR,
        "service_now" VARCHAR,
        "singular" VARCHAR,
        "slack" VARCHAR,
        "trendmicro" VARCHAR,
        "veeva" VARCHAR,
        "zendesk" VARCHAR,
        "sapo_data" VARCHAR,
        "custom_connector" VARCHAR,
        "pardot" VARCHAR
    ),
    "destination_field" VARCHAR,
    "task_type" VARCHAR,
    "task_properties" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
tasks[]
Show child fields
tasks[].connector_operator

The operation to be performed on the provided source fields.

Show child fields
tasks[].connector_operator.amplitude

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

tasks[].connector_operator.custom_connector

Operators supported by the custom connector.

tasks[].connector_operator.datadog

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

tasks[].connector_operator.dynatrace

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

tasks[].connector_operator.google_analytics

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

tasks[].connector_operator.infor_nexus

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

tasks[].connector_operator.marketo

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

tasks[].connector_operator.pardot

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

tasks[].connector_operator.s3

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

tasks[].connector_operator.salesforce

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

tasks[].connector_operator.sapo_data

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

tasks[].connector_operator.service_now

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

tasks[].connector_operator.singular

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

tasks[].connector_operator.slack

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

tasks[].connector_operator.trendmicro

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

tasks[].connector_operator.veeva

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

tasks[].connector_operator.zendesk

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

tasks[].destination_field

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

tasks[].source_fields[]
tasks[].task_properties

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

tasks[].task_type

Specifies the particular task implementation that Amazon AppFlow performs.

trigger_config

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

STRUCT(
    "trigger_type" VARCHAR,
    "trigger_properties" STRUCT(
        "scheduled" STRUCT(
            "schedule_expression" VARCHAR,
            "data_pull_mode" VARCHAR,
            "schedule_start_time" TIMESTAMP_S,
            "schedule_end_time" TIMESTAMP_S,
            "timezone" VARCHAR,
            "schedule_offset" BIGINT,
            "first_execution_from" TIMESTAMP_S,
            "flow_error_deactivation_threshold" BIGINT
        )
    )
)
Show child fields
trigger_config.trigger_properties

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

Show child fields
trigger_config.trigger_properties.scheduled

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

Show child fields
trigger_config.trigger_properties.scheduled.data_pull_mode

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

trigger_config.trigger_properties.scheduled.first_execution_from

Specifies the date range for the records to import from the connector in the first flow run.

trigger_config.trigger_properties.scheduled.flow_error_deactivation_threshold

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

trigger_config.trigger_properties.scheduled.schedule_end_time

The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

trigger_config.trigger_properties.scheduled.schedule_expression

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

trigger_config.trigger_properties.scheduled.schedule_offset

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

trigger_config.trigger_properties.scheduled.schedule_start_time

The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

trigger_config.trigger_properties.scheduled.timezone

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

trigger_config.trigger_type

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