typed_link_facet_attributes

Creates, updates, deletes, gets or lists a typed_link_facet_attributes resource.

Overview

Name	typed_link_facet_attributes
Type	Resource
Id	aws.clouddirectory.typed_link_facet_attributes

Fields

The following fields are returned by SELECT queries:

list_typed_link_facet_attributes

Name	Datatype	Description
default_value	object	The default value of the attribute (if configured).
is_immutable	boolean	Whether the attribute is mutable or not.
name	string	The unique name of the typed link attribute. (pattern: <code>^[a-zA-Z0-9._:-]*$</code>)
required_behavior	string	The required behavior of the TypedLinkAttributeDefinition. (REQUIRED_ALWAYS, NOT_REQUIRED)
rules	object	Validation rules that are attached to the attribute definition.
type	string	The type of the attribute. (STRING, BINARY, BOOLEAN, NUMBER, DATETIME, VARIANT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_typed_link_facet_attributes	select	x-amz-data-partition, region		Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.

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)
x-amz-data-partition	string	The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

SELECT examples

list_typed_link_facet_attributes

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.

SELECT
default_value,
is_immutable,
name,
required_behavior,
rules,
type
FROM aws.clouddirectory.typed_link_facet_attributes
WHERE `x-amz-data-partition` = '{{ x-amz-data-partition }}' -- required
AND region = '{{ region }}' -- required
;