QuickSight / Paginator / SearchTopics

SearchTopics

class QuickSight.Paginator.SearchTopics

paginator = client.get_paginator('search_topics')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QuickSight.Client.search_topics().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'TopicSummaryList': [
        {
            'Arn': 'string',
            'TopicId': 'string',
            'Name': 'string',
            'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE'
        },
    ],
    '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.

  • Status (integer) –

    The HTTP status of the request.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.