QBusiness / Client / list_web_experiences

list_web_experiences#

QBusiness.Client.list_web_experiences(**kwargs)#

Lists one or more Amazon Q Business Web Experiences.

See also: AWS API Documentation

Request Syntax

response = client.list_web_experiences(
    applicationId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'webExperiences': [
        {
            'createdAt': datetime(2015, 1, 1),
            'defaultEndpoint': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG',
            'updatedAt': datetime(2015, 1, 1),
            'webExperienceId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

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

        • createdAt (datetime) –

          The Unix timestamp when the Amazon Q Business application was last 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.

        • updatedAt (datetime) –

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

        • webExperienceId (string) –

          The identifier of your Amazon Q Business web experience.

Exceptions