Appflow / Client / describe_connector_entity

describe_connector_entity#

Appflow.Client.describe_connector_entity(**kwargs)#

Provides details regarding the entity used with the connector, with a description of the data model for each field in that 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'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
    connectorProfileName='string',
    apiVersion='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 Amazon Web Services account.

  • apiVersion (string) – The version of the API that’s used by the connector.

Return type:

dict

Returns:

Response Syntax

{
    'connectorEntityFields': [
        {
            'identifier': 'string',
            'parentIdentifier': 'string',
            'label': 'string',
            'isPrimaryKey': True|False,
            'defaultValue': 'string',
            'isDeprecated': True|False,
            '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',
                    ],
                    'valueRegexPattern': 'string',
                    'supportedDateFormat': 'string',
                    'fieldValueRange': {
                        'maximum': 123.0,
                        'minimum': 123.0
                    },
                    'fieldLengthRange': {
                        'maximum': 123.0,
                        'minimum': 123.0
                    }
                }
            },
            'description': 'string',
            'sourceProperties': {
                'isRetrievable': True|False,
                'isQueryable': True|False,
                'isTimestampFieldForIncrementalQueries': True|False
            },
            'destinationProperties': {
                'isCreatable': True|False,
                'isNullable': True|False,
                'isUpsertable': True|False,
                'isUpdatable': True|False,
                'isDefaultedOnCreate': True|False,
                'supportedWriteOperations': [
                    'INSERT'|'UPSERT'|'UPDATE'|'DELETE',
                ]
            },
            'customProperties': {
                'string': 'string'
            }
        },
    ]
}

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.

        • parentIdentifier (string) –

          The parent identifier of the connector field.

        • label (string) –

          The label applied to a connector entity field.

        • isPrimaryKey (boolean) –

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

        • defaultValue (string) –

          Default value that can be assigned to this field.

        • isDeprecated (boolean) –

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

        • 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) –

            • valueRegexPattern (string) –

              The regular expression pattern for the field name.

            • supportedDateFormat (string) –

              The date format that the field supports.

            • fieldValueRange (dict) –

              The range of values this field can hold.

              • maximum (float) –

                Maximum value supported by the field.

              • minimum (float) –

                Minimum value supported by the field.

            • fieldLengthRange (dict) –

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

              • maximum (float) –

                Maximum value supported by the field.

              • minimum (float) –

                Minimum value supported by the field.

        • 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.

          • isTimestampFieldForIncrementalQueries (boolean) –

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

        • 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.

          • isDefaultedOnCreate (boolean) –

            Specifies whether the field can use the default value during a Create 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.

        • customProperties (dict) –

          A map that has specific properties related to the ConnectorEntityField.

          • (string) –

            • (string) –

Exceptions