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': {
        'sessionArn': 'string',
        'sessionId': 'string',
        'name': 'string',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'tagFilter': {
            'tagCondition': {
                'key': 'string',
                'value': 'string'
            },
            'andConditions': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'orConditions': [
                {
                    'andConditions': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'tagCondition': {
                        'key': 'string',
                        'value': 'string'
                    }
                },
            ]
        },
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string',
                'enabled': True|False
            }
        },
        'origin': 'SYSTEM'|'CUSTOMER',
        'orchestratorConfigurationList': [
            {
                'aiAgentId': 'string',
                'orchestratorUseCase': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • session (dict) –

      The session.

      • sessionArn (string) –

        The Amazon Resource Name (ARN) of the session.

      • sessionId (string) –

        The identifier of the session.

      • name (string) –

        The name of the session.

      • description (string) –

        The description of the session.

      • tags (dict) –

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

        • (string) –

          • (string) –

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

      • 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: tagCondition, andConditions, orConditions. 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'}

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

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

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

            • enabled (boolean) –

              Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.

      • origin (string) –

        The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.

      • orchestratorConfigurationList (list) –

        The list of orchestrator configurations for the session.

        • (dict) –

          An entry in the orchestrator configuration list.

          • aiAgentId (string) –

            The identifier of the AI Agent in the orchestrator configuration.

          • orchestratorUseCase (string) –

            The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)

Exceptions