QBusiness / Client / list_applications
list_applications#
- QBusiness.Client.list_applications(**kwargs)#
Lists Amazon Q applications.
See also: AWS API Documentation
Request Syntax
response = client.list_applications( maxResults=123, nextToken='string' )
- Parameters:
maxResults (integer) – The maximum number of Amazon Q applications to return.
nextToken (string) – If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q applications.
- 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 applications.
(dict) –
Summary information for an Amazon Q application.
applicationId (string) –
The identifier for the Amazon Q application.
createdAt (datetime) –
The Unix timestamp when the Amazon Q application was created.
displayName (string) –
The name of the Amazon Q application.
status (string) –
The status of the Amazon Q application. The application is ready to use when the status is
ACTIVE
.updatedAt (datetime) –
The Unix timestamp when the Amazon Q application was last updated.
nextToken (string) –
If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
Exceptions
QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException