outgoing_typed_links
Creates, updates, deletes, gets or lists an outgoing_typed_links resource.
Overview
| Name | outgoing_typed_links |
| Type | Resource |
| Id | aws.clouddirectory.outgoing_typed_links |
Fields
The following fields are returned by SELECT queries:
- list_outgoing_typed_links
| Name | Datatype | Description |
|---|---|---|
identity_attribute_values | array | Identifies the attribute value to update. |
source_object_reference | object | The reference that identifies an object. |
target_object_reference | object | The reference that identifies an object. |
typed_link_facet | object | Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_outgoing_typed_links | select | x-amz-data-partition, region | Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. 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) of the directory where you want to list the typed links. |
SELECT examples
- list_outgoing_typed_links
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
SELECT
identity_attribute_values,
source_object_reference,
target_object_reference,
typed_link_facet
FROM aws.clouddirectory.outgoing_typed_links
WHERE `x-amz-data-partition` = '{{ x-amz-data-partition }}' -- required
AND region = '{{ region }}' -- required
;