QConnect / Client / get_session

get_session

QConnect.Client.get_session(**kwargs)

Retrieves information for a specified session.

See also: AWS API Documentation

Request Syntax

response = client.get_session(
    assistantId='string',
    sessionId='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.

• sessionId (string) –

  [REQUIRED]

  The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type:

dict

Returns:

Response Syntax

{
    'session': {
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • session (dict) –

    The session.

    • description (string) –

      The description of the session.

    • integrationConfiguration (dict) –

      The configuration information for the session integration.

      • topicIntegrationArn (string) –

        The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

    • name (string) –

      The name of the session.

    • sessionArn (string) –

      The Amazon Resource Name (ARN) of the session.

    • sessionId (string) –

      The identifier of the session.

    • tags (dict) –

      The tags used to organize, track, or control access for this resource.

      • (string) –

        • (string) –

Exceptions

• QConnect.Client.exceptions.ValidationException

• QConnect.Client.exceptions.AccessDeniedException

• QConnect.Client.exceptions.ResourceNotFoundException