QBusiness / Paginator / ListApplications

ListApplications

class QBusiness.Paginator.ListApplications

paginator = client.get_paginator('list_applications')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'applications': [
        {
            'applicationId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'displayName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • applications (list) –

    An array of summary information on the configuration of one or more Amazon Q Business applications.

    • (dict) –

      Summary information for an Amazon Q Business application.

      • applicationId (string) –

        The identifier for the Amazon Q Business application.

      • createdAt (datetime) –

        The Unix timestamp when the Amazon Q Business application was created.

      • displayName (string) –

        The name of the Amazon Q Business application.

      • status (string) –

        The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.

      • updatedAt (datetime) –

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

  • NextToken (string) –

    A token to resume pagination.