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 in Connect 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': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tagFilter': {
            'andConditions': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'orConditions': [
                {
                    'andConditions': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'tagCondition': {
                        'key': 'string',
                        'value': 'string'
                    }
                },
            ],
            'tagCondition': {
                'key': 'string',
                'value': 'string'
            }
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • session (dict) –

    The session.

    • aiAgentConfiguration (dict) –

      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

      • (string) –

        • (dict) –

          A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.

          • aiAgentId (string) –

            The ID of the AI Agent to be configured.

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

    • tagFilter (dict) –

      An object that can be used to specify Tag conditions.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • andConditions (list) –

        A list of conditions which would be applied together with an AND condition.

        • (dict) –

          A leaf node condition which can be used to specify a tag condition.

          • key (string) –

            The tag key in the tag condition.

          • value (string) –

            The tag value in the tag condition.

      • orConditions (list) –

        A list of conditions which would be applied together with an OR condition.

        • (dict) –

          A list of conditions which would be applied together with an OR condition.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • andConditions (list) –

            A list of conditions which would be applied together with an AND condition.

            • (dict) –

              A leaf node condition which can be used to specify a tag condition.

              • key (string) –

                The tag key in the tag condition.

              • value (string) –

                The tag value in the tag condition.

          • tagCondition (dict) –

            A leaf node condition which can be used to specify a tag condition.

            • key (string) –

              The tag key in the tag condition.

            • value (string) –

              The tag value in the tag condition.

      • tagCondition (dict) –

        A leaf node condition which can be used to specify a tag condition.

        • key (string) –

          The tag key in the tag condition.

        • value (string) –

          The tag value in the tag condition.

    • 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