SearchDataSetsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QuickSightClient, SearchDataSetsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, SearchDataSetsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // SearchDataSetsRequest
  AwsAccountId: "STRING_VALUE", // required
  Filters: [ // DataSetSearchFilterList // required
    { // DataSetSearchFilter
      Operator: "StringEquals" || "StringLike", // required
      Name: "QUICKSIGHT_VIEWER_OR_OWNER" || "QUICKSIGHT_OWNER" || "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" || "DIRECT_QUICKSIGHT_OWNER" || "DIRECT_QUICKSIGHT_SOLE_OWNER" || "DATASET_NAME", // required
      Value: "STRING_VALUE", // required
    },
  ],
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new SearchDataSetsCommand(input);
const response = await client.send(command);
// { // SearchDataSetsResponse
//   DataSetSummaries: [ // DataSetSummaryList
//     { // DataSetSummary
//       Arn: "STRING_VALUE",
//       DataSetId: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       CreatedTime: new Date("TIMESTAMP"),
//       LastUpdatedTime: new Date("TIMESTAMP"),
//       ImportMode: "SPICE" || "DIRECT_QUERY",
//       RowLevelPermissionDataSet: { // RowLevelPermissionDataSet
//         Namespace: "STRING_VALUE",
//         Arn: "STRING_VALUE", // required
//         PermissionPolicy: "GRANT_ACCESS" || "DENY_ACCESS", // required
//         FormatVersion: "VERSION_1" || "VERSION_2",
//         Status: "ENABLED" || "DISABLED",
//       },
//       RowLevelPermissionTagConfigurationApplied: true || false,
//       ColumnLevelPermissionRulesApplied: true || false,
//       UseAs: "RLS_RULES",
//     },
//   ],
//   NextToken: "STRING_VALUE",
//   Status: Number("int"),
//   RequestId: "STRING_VALUE",
// };

SearchDataSetsCommand Input

See SearchDataSetsCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The Amazon Web Services account ID.

Filters
Required
DataSetSearchFilter[] | undefined

The filters to apply to the search.

MaxResults
number | undefined

The maximum number of results to be returned per request.

NextToken
string | undefined

A pagination token that can be used in a subsequent request.

SearchDataSetsCommand Output

See SearchDataSetsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DataSetSummaries
DataSetSummary[] | undefined

A DataSetSummaries object that returns a summary of a dataset.

NextToken
string | undefined

A pagination token that can be used in a subsequent request.

RequestId
string | undefined

The Amazon Web Services request ID for this operation.

Status
number | undefined

The HTTP status of the request.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

InternalFailureException
server

An internal failure occurred.

InvalidNextTokenException
client

The NextToken value isn't valid.

InvalidParameterValueException
client

One or more parameters has a value that isn't valid.

ResourceNotFoundException
client

One or more resources can't be found.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.