QConnect / Client / search_sessions

search_sessions¶

QConnect.Client.search_sessions(**kwargs)¶

Searches for sessions.

Request Syntax

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

Parameters:

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.
maxResults (integer) – The maximum number of results to return per page.
assistantId (string) –
[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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

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

Response Structure

(dict) –
- sessionSummaries (list) –
  
  Summary information about the sessions.
  - (dict) –
    
    Summary information about the session.
    - sessionId (string) –
      
      The identifier of the session.
    - sessionArn (string) –
      
      The Amazon Resource Name (ARN) of the session.
    - assistantId (string) –
      
      The identifier of the Amazon Q in Connect assistant.
    - assistantArn (string) –
      
      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- nextToken (string) –
  
  If there are additional results, this is the token for the next set of results.

Exceptions

QConnect.Client.exceptions.ValidationException
QConnect.Client.exceptions.UnauthorizedException
QConnect.Client.exceptions.AccessDeniedException
QConnect.Client.exceptions.ResourceNotFoundException