Skip to content
AWS for Query.Farm

aws.clouddirectory.list_index

Example SQL Queries

SELECT * FROM
aws.clouddirectory.list_index
WHERE
"directory_arn" = 'VALUE'
AND "index_reference" = 'VALUE';

Description

Lists objects attached to the specified index.

Table Definition

Column NameColumn Data Type
directory_arn Required Input Column

The ARN of the directory that the index exists in.

VARCHAR
index_reference Required Input Column

The reference to the index to list.

STRUCT(
    "selector" VARCHAR
)
Show child fields
index_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

consistency_level Input Column

The consistency level to execute the request at.

VARCHAR
ranges_on_indexed_values Input Column

Specifies the ranges of indexed values that you want to query.

STRUCT(
    "attribute_key" STRUCT(
        "schema_arn" VARCHAR,
        "facet_name" VARCHAR,
        "name" VARCHAR
    ),
    "range" STRUCT(
        "start_mode" VARCHAR,
        "start_value" STRUCT(
            "string_value" VARCHAR,
            "binary_value" BLOB,
            "boolean_value" BOOLEAN,
            "number_value" VARCHAR,
            "datetime_value" TIMESTAMP_S
        ),
        "end_mode" VARCHAR,
        "end_value" STRUCT(
            "string_value" VARCHAR,
            "binary_value" BLOB,
            "boolean_value" BOOLEAN,
            "number_value" VARCHAR,
            "datetime_value" TIMESTAMP_S
        )
    )
)[]
Show child fields
ranges_on_indexed_values[]
Show child fields
ranges_on_indexed_values[].attribute_key

The key of the attribute that the attribute range covers.

Show child fields
ranges_on_indexed_values[].attribute_key.facet_name

The name of the facet that the attribute exists within.

ranges_on_indexed_values[].attribute_key.name

The name of the attribute.

ranges_on_indexed_values[].attribute_key.schema_arn

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

ranges_on_indexed_values[].range

The range of attribute values being selected.

Show child fields
ranges_on_indexed_values[].range.end_mode

The inclusive or exclusive range end.

ranges_on_indexed_values[].range.end_value

The attribute value to terminate the range at.

Show child fields
ranges_on_indexed_values[].range.end_value.binary_value

A binary data value.

ranges_on_indexed_values[].range.end_value.boolean_value

A Boolean data value.

ranges_on_indexed_values[].range.end_value.datetime_value

A date and time value.

ranges_on_indexed_values[].range.end_value.number_value

A number data value.

ranges_on_indexed_values[].range.end_value.string_value

A string data value.

ranges_on_indexed_values[].range.start_mode

The inclusive or exclusive range start.

ranges_on_indexed_values[].range.start_value

The value to start the range at.

Show child fields
ranges_on_indexed_values[].range.start_value.binary_value

A binary data value.

ranges_on_indexed_values[].range.start_value.boolean_value

A Boolean data value.

ranges_on_indexed_values[].range.start_value.datetime_value

A date and time value.

ranges_on_indexed_values[].range.start_value.number_value

A number data value.

ranges_on_indexed_values[].range.start_value.string_value

A string data value.

_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
indexed_attributes

The indexed attribute values.

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
indexed_attributes[]
Show child fields
indexed_attributes[].key

The key of the attribute.

Show child fields
indexed_attributes[].key.facet_name

The name of the facet that the attribute exists within.

indexed_attributes[].key.name

The name of the attribute.

indexed_attributes[].key.schema_arn

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

indexed_attributes[].value

The value of the attribute.

Show child fields
indexed_attributes[].value.binary_value

A binary data value.

indexed_attributes[].value.boolean_value

A Boolean data value.

indexed_attributes[].value.datetime_value

A date and time value.

indexed_attributes[].value.number_value

A number data value.

indexed_attributes[].value.string_value

A string data value.

object_identifier

In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

VARCHAR