Skip to content
AWS for Query.Farm

aws.appflow.describe_connector_entity

Example SQL Queries

SELECT * FROM
aws.appflow.describe_connector_entity
WHERE
"connector_entity_name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
connector_entity_name Required Input Column

The entity name for that connector. 

VARCHAR
api_version Input Column

The version of the API that's used by the connector.

VARCHAR
connector_profile_name Input Column

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account. 

VARCHAR
connector_type Input Column

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

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
connector_entity_fields

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

STRUCT(
    "identifier" VARCHAR,
    "parent_identifier" VARCHAR,
    "label" VARCHAR,
    "is_primary_key" BOOLEAN,
    "default_value" VARCHAR,
    "is_deprecated" BOOLEAN,
    "supported_field_type_details" STRUCT(
        "v1" STRUCT(
            "field_type" VARCHAR,
            "filter_operators" VARCHAR[],
            "supported_values" VARCHAR[],
            "value_regex_pattern" VARCHAR,
            "supported_date_format" VARCHAR,
            "field_value_range" STRUCT(
                "maximum" DOUBLE,
                "minimum" DOUBLE
            ),
            "field_length_range" STRUCT(
                "maximum" DOUBLE,
                "minimum" DOUBLE
            )
        )
    ),
    "description" VARCHAR,
    "source_properties" STRUCT(
        "is_retrievable" BOOLEAN,
        "is_queryable" BOOLEAN,
        "is_timestamp_field_for_incremental_queries" BOOLEAN
    ),
    "destination_properties" STRUCT(
        "is_creatable" BOOLEAN,
        "is_nullable" BOOLEAN,
        "is_upsertable" BOOLEAN,
        "is_updatable" BOOLEAN,
        "is_defaulted_on_create" BOOLEAN,
        "supported_write_operations" VARCHAR[]
    ),
    "custom_properties" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
connector_entity_fields[]
Show child fields
connector_entity_fields[].custom_properties

A map that has specific properties related to the ConnectorEntityField.

connector_entity_fields[].default_value

Default value that can be assigned to this field.

connector_entity_fields[].description

A description of the connector entity field.

connector_entity_fields[].destination_properties

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

Show child fields
connector_entity_fields[].destination_properties.is_creatable

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

connector_entity_fields[].destination_properties.is_defaulted_on_create

Specifies whether the field can use the default value during a Create operation.

connector_entity_fields[].destination_properties.is_nullable

Specifies if the destination field can have a null value.

connector_entity_fields[].destination_properties.is_updatable

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

connector_entity_fields[].destination_properties.is_upsertable

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.

connector_entity_fields[].destination_properties.supported_write_operations[]
connector_entity_fields[].identifier

The unique identifier of the connector field.

connector_entity_fields[].is_deprecated

Booelan value that indicates whether this field is deprecated or not.

connector_entity_fields[].is_primary_key

Booelan value that indicates whether this field can be used as a primary key.

connector_entity_fields[].label

The label applied to a connector entity field.

connector_entity_fields[].parent_identifier

The parent identifier of the connector field.

connector_entity_fields[].source_properties

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

Show child fields
connector_entity_fields[].source_properties.is_queryable

Indicates if the field can be queried.

connector_entity_fields[].source_properties.is_retrievable

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

connector_entity_fields[].source_properties.is_timestamp_field_for_incremental_queries

Indicates if this timestamp field can be used for incremental queries.

connector_entity_fields[].supported_field_type_details

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

Show child fields
connector_entity_fields[].supported_field_type_details.v1

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

Show child fields
connector_entity_fields[].supported_field_type_details.v1.field_length_range

This is the allowable length range for this field's value.

Show child fields
connector_entity_fields[].supported_field_type_details.v1.field_length_range.maximum

Maximum value supported by the field.

connector_entity_fields[].supported_field_type_details.v1.field_length_range.minimum

Minimum value supported by the field.

connector_entity_fields[].supported_field_type_details.v1.field_type

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

connector_entity_fields[].supported_field_type_details.v1.field_value_range

The range of values this field can hold.

Show child fields
connector_entity_fields[].supported_field_type_details.v1.field_value_range.maximum

Maximum value supported by the field.

connector_entity_fields[].supported_field_type_details.v1.field_value_range.minimum

Minimum value supported by the field.

connector_entity_fields[].supported_field_type_details.v1.filter_operators[]
connector_entity_fields[].supported_field_type_details.v1.supported_date_format

The date format that the field supports.

connector_entity_fields[].supported_field_type_details.v1.supported_values[]
connector_entity_fields[].supported_field_type_details.v1.value_regex_pattern

The regular expression pattern for the field name.