Skip to content
AWS for Query.Farm

aws.clouddirectory.get_link_attributes

Example SQL Queries

SELECT * FROM
aws.clouddirectory.get_link_attributes
WHERE
"directory_arn" = 'VALUE'
AND "typed_link_specifier" = 'VALUE'
AND "attribute_names" = 'VALUE';

Description

Retrieves attributes that are associated with a typed link.

Table Definition

Column NameColumn Data Type
attribute_names Required Input Column

A list of attribute names whose values will be retrieved.

VARCHAR[]
Show child fields
attribute_names[]
directory_arn Required Input Column

The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links.

VARCHAR
typed_link_specifier Required Input Column

Allows a typed link specifier to be accepted as input.

STRUCT(
    "typed_link_facet" STRUCT(
        "schema_arn" VARCHAR,
        "typed_link_name" VARCHAR
    ),
    "source_object_reference" STRUCT(
        "selector" VARCHAR
    ),
    "target_object_reference" STRUCT(
        "selector" VARCHAR
    ),
    "identity_attribute_values" STRUCT(
        "attribute_name" VARCHAR,
        "value" STRUCT(
            "string_value" VARCHAR,
            "binary_value" BLOB,
            "boolean_value" BOOLEAN,
            "number_value" VARCHAR,
            "datetime_value" TIMESTAMP_S
        )
    )[]
)
Show child fields
typed_link_specifier.identity_attribute_values[]
Show child fields
typed_link_specifier.identity_attribute_values[].attribute_name

The attribute name of the typed link.

typed_link_specifier.identity_attribute_values[].value

The value for the typed link.

Show child fields
typed_link_specifier.identity_attribute_values[].value.binary_value

A binary data value.

typed_link_specifier.identity_attribute_values[].value.boolean_value

A Boolean data value.

typed_link_specifier.identity_attribute_values[].value.datetime_value

A date and time value.

typed_link_specifier.identity_attribute_values[].value.number_value

A number data value.

typed_link_specifier.identity_attribute_values[].value.string_value

A string data value.

typed_link_specifier.source_object_reference

Identifies the source object that the typed link will attach to.

Show child fields
typed_link_specifier.source_object_reference.selector

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

  • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

  • /some/path - Identifies the object based on path

  • #SomeBatchReference - Identifies the object in a batch call

typed_link_specifier.target_object_reference

Identifies the target object that the typed link will attach to.

Show child fields
typed_link_specifier.target_object_reference.selector

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

  • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

  • /some/path - Identifies the object based on path

  • #SomeBatchReference - Identifies the object in a batch call

typed_link_specifier.typed_link_facet

Identifies the typed link facet that is associated with the typed link.

Show child fields
typed_link_specifier.typed_link_facet.schema_arn

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

typed_link_specifier.typed_link_facet.typed_link_name

The unique name of the typed link facet.

consistency_level Input Column

The consistency level at which to retrieve the attributes on a typed link.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
attributes

The attributes that are associated with the typed link.

STRUCT(
    "key" STRUCT(
        "schema_arn" VARCHAR,
        "facet_name" VARCHAR,
        "name" VARCHAR
    ),
    "value" STRUCT(
        "string_value" VARCHAR,
        "binary_value" BLOB,
        "boolean_value" BOOLEAN,
        "number_value" VARCHAR,
        "datetime_value" TIMESTAMP_S
    )
)[]
Show child fields
attributes[]
Show child fields
attributes[].key

The key of the attribute.

Show child fields
attributes[].key.facet_name

The name of the facet that the attribute exists within.

attributes[].key.name

The name of the attribute.

attributes[].key.schema_arn

The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

attributes[].value

The value of the attribute.

Show child fields
attributes[].value.binary_value

A binary data value.

attributes[].value.boolean_value

A Boolean data value.

attributes[].value.datetime_value

A date and time value.

attributes[].value.number_value

A number data value.

attributes[].value.string_value

A string data value.