QuickSight / Paginator / SearchApps

SearchApps

class QuickSight.Paginator.SearchApps

paginator = client.get_paginator('search_apps')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    Filters=[
        {
            'Name': 'APP_ID'|'APP_NAME'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER',
            'Operator': 'StringEquals'|'StringLike',
            'Value': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account that contains the apps to search.

• Filters (list) –

  [REQUIRED]

  The filters to apply to the search.

  • (dict) –

    A filter to apply when searching for apps.

    • Name (string) – [REQUIRED]

      The name of the filter attribute.

    • Operator (string) – [REQUIRED]

      The comparison operator for the filter.

    • Value (string) – [REQUIRED]

      The value to filter on.

• 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

{
    'AppSummaryList': [
        {
            'AppId': 'string',
            'Arn': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Visibility': 'PRIVATE'|'PUBLIC'
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • AppSummaryList (list) –

    A list of app summaries that match the search criteria.

    • (dict) –

      A summary of an app, including its identifier, name, and metadata.

      • AppId (string) –

        The ID of the app.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the app.

      • Name (string) –

        The display name of the app.

      • CreatedTime (datetime) –

        The time that the app was created.

      • LastUpdatedTime (datetime) –

        The time that the app was last updated.

      • Visibility (string) –

        The sharing status of the app: PUBLIC if the app is shared publicly, or PRIVATE if it is private.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.