Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchDataSets

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

Request Syntax


POST /accounts/AwsAccountId/search/data-sets HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Filters

The filters to apply to the search.

Type: Array of DataSetSearchFilter objects

Array Members: Fixed number of 1 item.

Required: Yes

MaxResults

The maximum number of results to be returned per request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

Type: String

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "DataSetSummaries": [ 
      { 
         "Arn": "string",
         "ColumnLevelPermissionRulesApplied": boolean,
         "CreatedTime": number,
         "DataSetId": "string",
         "ImportMode": "string",
         "LastUpdatedTime": number,
         "Name": "string",
         "RowLevelPermissionDataSet": { 
            "Arn": "string",
            "FormatVersion": "string",
            "Namespace": "string",
            "PermissionPolicy": "string",
            "Status": "string"
         },
         "RowLevelPermissionTagConfigurationApplied": boolean
      }
   ],
   "NextToken": "string",
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

DataSetSummaries

A DataSetSummaries object that returns a summary of a dataset.

Type: Array of DataSetSummary objects

NextToken

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

Type: String

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidNextTokenException

The NextToken value isn't valid.

HTTP Status Code: 400

InvalidParameterValueException

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

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429