QuickSight / Client / search_topics

search_topics#

QuickSight.Client.search_topics(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.search_topics(
    AwsAccountId='string',
    Filters=[
        {
            'Operator': 'StringEquals'|'StringLike',
            'Name': 'QUICKSIGHT_USER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'TOPIC_NAME',
            'Value': 'string'
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the topic that you want to find.

  • Filters (list) –

    [REQUIRED]

    The filters that you want to use to search for the topic.

    • (dict) –

      The filter that is used to search for a topic.

      • Operator (string) – [REQUIRED]

        The operator like equals or like.

      • Name (string) – [REQUIRED]

        The name of the topic search filter.

      • Value (string) – [REQUIRED]

        The value of the topic search filter.

  • NextToken (string) – The token for the next set of results, or null if there are no more results.

  • MaxResults (integer) – The maximum number of results to be returned per request.

Return type:

dict

Returns:

Response Syntax

{
    'TopicSummaryList': [
        {
            'Arn': 'string',
            'TopicId': 'string',
            'Name': 'string',
            'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE'
        },
    ],
    'NextToken': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • TopicSummaryList (list) –

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

      • (dict) –

        A topic summary.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the topic.

        • TopicId (string) –

          The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

        • Name (string) –

          The name of the topic.

        • UserExperienceVersion (string) –

          The user experience version of the topic.

    • NextToken (string) –

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

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions