entities

Creates, updates, deletes, gets or lists an entities resource.

Overview

Name	entities
Type	Resource
Id	aws.glue.entities

Fields

The following fields are returned by SELECT queries:

describe_entity

Name	Datatype	Description
custom_properties	object	Optional map of keys which may be returned.
description	string	A description of the field.
field_name	string	A unique identifier for the field.
field_type	string	The type of data in the field. (INT, SMALLINT, BIGINT, FLOAT, LONG, DATE, BOOLEAN, MAP, ARRAY, STRING, TIMESTAMP, DECIMAL, BYTE, SHORT, DOUBLE, STRUCT, BINARY, UNION)
is_createable	boolean	Indicates whether this field can be created as part of a destination write.
is_default_on_create	boolean	Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.
is_filterable	boolean	Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.
is_nullable	boolean	Indicates whether this field can be nullable or not.
is_partitionable	boolean	Indicates whether a given field can be used in partitioning the query made to SaaS.
is_primary_key	boolean	Indicates whether this field can used as a primary key for the given entity.
is_retrievable	boolean	Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.
is_updateable	boolean	Indicates whether this field can be updated as part of a destination write.
is_upsertable	boolean	Indicates whether this field can be upserted as part of a destination write.
label	string	A readable label used for the field.
native_data_type	string	The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.
parent_field	string	A parent field name for a nested field.
supported_filter_operators	array	Indicates the support filter operators for this field.
supported_values	array	A list of supported values for the field.

list_entities

Name	Datatype	Description
category	string	The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.
custom_properties	object	An optional map of keys which may be returned for an entity by a connector.
description	string	A description of the entity.
entity_name	string	The name of the entity.
is_parent_entity	boolean	A Boolean value which helps to determine whether there are sub objects that can be listed.
label	string	Label used for the entity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_entity	select	region		Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity. The response includes all the fields which make up the entity.
list_entities	select	region		Returns the available entities supported by the connection type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_entity

Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity. The response includes all the fields which make up the entity.

SELECT
custom_properties,
description,
field_name,
field_type,
is_createable,
is_default_on_create,
is_filterable,
is_nullable,
is_partitionable,
is_primary_key,
is_retrievable,
is_updateable,
is_upsertable,
label,
native_data_type,
parent_field,
supported_filter_operators,
supported_values
FROM aws.glue.entities
WHERE region = '{{ region }}' -- required
;

list_entities

Returns the available entities supported by the connection type.

SELECT
category,
custom_properties,
description,
entity_name,
is_parent_entity,
label
FROM aws.glue.entities
WHERE region = '{{ region }}' -- required
;