Provides details regarding the entity used with the connector, with a description of the data model for each entity.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-connector-entity
--connector-entity-name <value>
[--connector-type <value>]
[--connector-profile-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--connector-entity-name
(string)
The entity name for that connector.
--connector-type
(string)
The type of connector application, such as Salesforce, Amplitude, and so on.
Possible values:
Salesforce
Singular
Slack
Redshift
S3
Marketo
Googleanalytics
Zendesk
Servicenow
Datadog
Trendmicro
Snowflake
Dynatrace
Infornexus
Amplitude
Veeva
EventBridge
LookoutMetrics
Upsolver
Honeycode
CustomerProfiles
SAPOData
--connector-profile-name
(string)
The name of the connector profile. The name is unique for each
ConnectorProfile
in the Amazon Web Services account.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
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.
(structure)
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 -> (structure)
Contains details regarding the supported
FieldType
, including the correspondingfilterOperators
andsupportedValues
.v1 -> (structure)
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 -> (structure)
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 -> (structure)
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
orUPSERT
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.