QBusiness / Paginator / ListWebExperiences


class QBusiness.Paginator.ListWebExperiences#
paginator = client.get_paginator('list_web_experiences')

Creates an iterator that will paginate through responses from QBusiness.Client.list_web_experiences().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • applicationId (string) –


    The identifier of the Amazon Q Business application linked to the listed web experiences.

  • 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:



Response Syntax

    'webExperiences': [
            'webExperienceId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'defaultEndpoint': 'string',
    'NextToken': 'string'

Response Structure

  • (dict) –

    • webExperiences (list) –

      An array of summary information for one or more Amazon Q Business experiences.

      • (dict) –

        Provides information for an Amazon Q Business web experience.

        • webExperienceId (string) –

          The identifier of your Amazon Q Business web experience.

        • createdAt (datetime) –

          The Unix timestamp when the Amazon Q Business application was last updated.

        • updatedAt (datetime) –

          The Unix timestamp when your Amazon Q Business web experience was updated.

        • defaultEndpoint (string) –

          The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.

        • status (string) –

          The status of your Amazon Q Business web experience.

    • NextToken (string) –

      A token to resume pagination.