QConnect / Client / search_sessions

search_sessions#

QConnect.Client.search_sessions(**kwargs)#

Searches for sessions.

See also: AWS API Documentation

Request Syntax

response = client.search_sessions(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    searchExpression={
        'filters': [
            {
                'field': 'NAME',
                'operator': 'EQUALS',
                'value': 'string'
            },
        ]
    }
)
Parameters:

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • searchExpression (dict) –

    [REQUIRED]

    The search expression to filter results.

    • filters (list) – [REQUIRED]

      The search expression filters.

      • (dict) –

        A search filter.

        • field (string) – [REQUIRED]

          The field on which to filter.

        • operator (string) – [REQUIRED]

          The operator to use for comparing the field’s value with the provided value.

        • value (string) – [REQUIRED]

          The desired field value on which to filter.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'sessionSummaries': [
        {
            'assistantArn': 'string',
            'assistantId': 'string',
            'sessionArn': 'string',
            'sessionId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If there are additional results, this is the token for the next set of results.

    • sessionSummaries (list) –

      Summary information about the sessions.

      • (dict) –

        Summary information about the session.

        • assistantArn (string) –

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

        • assistantId (string) –

          The identifier of the Amazon Q assistant.

        • sessionArn (string) –

          The Amazon Resource Name (ARN) of the session.

        • sessionId (string) –

          The identifier of the session.

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException