Skip to content
AWS for Query.Farm

aws.quicksight.search_data_sources

Example SQL Queries

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

Description

Use the SearchDataSources operation to search for data sources 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": "DIRECT_QUICKSIGHT_OWNER".

Valid values are defined as follows:

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

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

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

  • DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are 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 data sources you want to search in the "Value" field. For example, "Name":"DIRECT_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 data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

filters[].value

The value of the named item, for example DIRECT_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_source_summaries

A DataSourceSummaries object that returns a summary of a data source.

STRUCT(
    "arn" VARCHAR,
    "data_source_id" VARCHAR,
    "name" VARCHAR,
    "type" VARCHAR,
    "created_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S
)[]
Show child fields
data_source_summaries[]
Show child fields
data_source_summaries[].arn

The arn of the datasource.

data_source_summaries[].created_time

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

data_source_summaries[].data_source_id

The unique ID of the data source.

data_source_summaries[].last_updated_time

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

data_source_summaries[].name

The name of the data source.

data_source_summaries[].type

The type of the data source.

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT