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

SearchTopics

Searches for any Q topic that exists in an Amazon QuickSight account.

Request Syntax


POST /accounts/AwsAccountId/search/topics 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 ID of the AWS account that contains the topic that you want to find.

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 that you want to use to search for the topic.

Type: Array of TopicSearchFilter 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

The token for the next set of results, or null if there are no more results.

Type: String

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "NextToken": "string",
   "RequestId": "string",
   "TopicSummaryList": [ 
      { 
         "Arn": "string",
         "Name": "string",
         "TopicId": "string",
         "UserExperienceVersion": "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.

NextToken

The token for the next set of results, or null if there are no more results.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

TopicSummaryList

A list of topic summaries that is returned by the search topic request.

Type: Array of TopicSummary objects

Errors

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

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

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403