QApps / Client / list_q_apps

list_q_apps#

QApps.Client.list_q_apps(**kwargs)#

Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

See also: AWS API Documentation

Request Syntax

response = client.list_q_apps(
    instanceId='string',
    limit=123,
    nextToken='string'
)
Parameters:

  • instanceId (string) –

    [REQUIRED]

    The unique identifier of the Amazon Q Business application environment instance.

  • limit (integer) – The maximum number of Q Apps to return in the response.

  • nextToken (string) – The token to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'apps': [
        {
            'appId': 'string',
            'appArn': 'string',
            'title': 'string',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'canEdit': True|False,
            'status': 'string',
            'isVerified': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • apps (list) –

      The list of Amazon Q Apps meeting the request criteria.

      • (dict) –

        An Amazon Q App associated with a user, either owned by the user or favorited.

        • appId (string) –

          The unique identifier of the Q App.

        • appArn (string) –

          The Amazon Resource Name (ARN) of the Q App.

        • title (string) –

          The title of the Q App.

        • description (string) –

          The description of the Q App.

        • createdAt (datetime) –

          The date and time the user’s association with the Q App was created.

        • canEdit (boolean) –

          A flag indicating whether the user can edit the Q App.

        • status (string) –

          The status of the user’s association with the Q App.

        • isVerified (boolean) –

          Indicates whether the Q App has been verified.

    • nextToken (string) –

      The token to use to request the next page of results.

Exceptions