Skip to content
AWS for Query.Farm

aws.quicksight.search_data_sets

Example SQL Queries

SELECT * FROM
aws.quicksight.search_data_sets
WHERE
"aws_account_id" = 'VALUE'
AND "filters" = 'VALUE';

Description

Use the SearchDataSets operation to search for datasets that belong to an account.

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The Amazon Web Services account ID.

VARCHAR
filters Required Input Column

The filters to apply to the search.

STRUCT(
    "operator" VARCHAR,
    "name" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

  • QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.

  • QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.

  • DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.

  • DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.

  • DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.

  • DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.

filters[].operator

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

filters[].value

The value of the named item, in this case QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

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

A DataSetSummaries object that returns a summary of a dataset.

STRUCT(
    "arn" VARCHAR,
    "data_set_id" VARCHAR,
    "name" VARCHAR,
    "created_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "import_mode" VARCHAR,
    "row_level_permission_data_set" STRUCT(
        "namespace" VARCHAR,
        "arn" VARCHAR,
        "permission_policy" VARCHAR,
        "format_version" VARCHAR,
        "status" VARCHAR
    ),
    "row_level_permission_tag_configuration_applied" BOOLEAN,
    "column_level_permission_rules_applied" BOOLEAN
)[]
Show child fields
data_set_summaries[]
Show child fields
data_set_summaries[].arn

The Amazon Resource Name (ARN) of the dataset.

data_set_summaries[].column_level_permission_rules_applied

A value that indicates if the dataset has column level permission configured.

data_set_summaries[].created_time

The time that this dataset was created.

data_set_summaries[].data_set_id

The ID of the dataset.

data_set_summaries[].import_mode

A value that indicates whether you want to import the data into SPICE.

data_set_summaries[].last_updated_time

The last time that this dataset was updated.

data_set_summaries[].name

A display name for the dataset.

data_set_summaries[].row_level_permission_data_set

The row-level security configuration for the dataset.

Show child fields
data_set_summaries[].row_level_permission_data_set.arn

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

data_set_summaries[].row_level_permission_data_set.format_version

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

data_set_summaries[].row_level_permission_data_set.namespace

The namespace associated with the dataset that contains permissions for RLS.

data_set_summaries[].row_level_permission_data_set.permission_policy

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

data_set_summaries[].row_level_permission_data_set.status

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

data_set_summaries[].row_level_permission_tag_configuration_applied

Whether or not the row level permission tags are applied.

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT