QBusiness / Client / list_applications

list_applications

QBusiness.Client.list_applications(**kwargs)

Lists Amazon Q Business applications.

Note

Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    nextToken='string',
    maxResults=123
)

Parameters:

• nextToken (string) – If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.

• maxResults (integer) – The maximum number of Amazon Q Business applications to return.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'applications': [
        {
            'displayName': 'string',
            'applicationId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
            'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP',
            'quickSightConfiguration': {
                'clientNamespace': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.

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

      • displayName (string) –

        The name of the 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.

      • updatedAt (datetime) –

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

      • status (string) –

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

      • identityType (string) –

        The authentication type being used by a Amazon Q Business application.

      • quickSightConfiguration (dict) –

        The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.

        • clientNamespace (string) –

          The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.

Exceptions

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException