Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ExternalDataSrcDescriptor

Contains the metadata information for the external schema of an external data source. Use the metadata to map attributes from an AWS data source, such as Amazon DynamoDB and Amazon Athena, to Salesforce external object fields. Also, use the metadata to customize the data retrieval queries to an AWS data source. This object is available in API version 55.0 and later for Amazon DynamoDB and in API version 56.0 and later for Amazon Athena.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field	Details
CustomObjectId	Type reference Properties Filter, Group, Nillable, Sort Description If set, the ID of the external object associated with the descriptor. This is a relationship field. Relationship Name CustomObject Relationship Type Lookup Refers To CustomObject
Descriptor	Type base64 Properties Nillable Description The descriptor document that contains the metadata information.
DescriptorVersion	Type string Properties Filter, Group, Nillable, Sort Description If the external system supports schema versioning for the data source, the optional descriptor document version tracks the external system's schema version. Several descriptors with different document versions may be active.
DeveloperName	Type string Properties Filter, Group, Sort Description The unique name of the child-level setup entity.
ExternalDataSourceId	Type reference Properties Filter, Group, Sort Description Salesforce ID of the external data source that defines the external system. This is a relationship field. Relationship Name ExternalDataSource Relationship Type Lookup Refers To ExternalDataSource
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated type in Tooling API.
Language	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the descriptor document.

ManageableState	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The manageable state of the descriptor that is contained in a package. Possible values are: `beta`—Managed-Beta `deleted`—Managed-Proposed-Deleted `deprecated`—Managed-Proposed-Deprecated `deprecatedEditable`—SecondGen-Installed-Deprecated `installed`—Managed-Installed `installedEditable`—SecondGen-Installed-Editable `released`—Managed-Released `unmanaged`—Unmanaged
Metadata	Type complexvalue Properties Create, Nillable, Update Description The external data source descriptor's metadata.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object.
Subtype	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The subtype of the descriptor. Possible values are: `SchemaTableDDL`—Used to store the metadata for the external data source. `SchemaTableMetadata`—Used to cache information about the external system. `SchemaTableQualifiers`—Used to customize the data retrieval query to the external system.
SystemVersion	Type int Properties Filter, Group, Sort Description The version that defines the descriptor format and allows compatibility with descriptor formats between Salesforce releases.
Type	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of the descriptor. Possible value: `Schema`

Tooling API

ExternalDataSrcDescriptor

Supported SOAP API Calls

Supported REST API Methods

Fields