:doc:`QConnect <../../qconnect>` / Paginator / ListAIAgents

************
ListAIAgents
************



.. py:class:: QConnect.Paginator.ListAIAgents

  ::

    
    paginator = client.get_paginator('list_ai_agents')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`QConnect.Client.list_ai_agents`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assistantId='string',
          origin='SYSTEM'|'CUSTOMER',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assistantId: string
    :param assistantId: **[REQUIRED]** 

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

      

    
    :type origin: string
    :param origin: 

      The origin of the AI Agents to be listed. ``SYSTEM`` for a default AI Agent created by Q in Connect or ``CUSTOMER`` for an AI Agent created by calling AI Agent creation APIs.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'aiAgentSummaries': [
                {
                    'name': 'string',
                    'assistantId': 'string',
                    'assistantArn': 'string',
                    'aiAgentId': 'string',
                    'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
                    'aiAgentArn': 'string',
                    'modifiedTime': datetime(2015, 1, 1),
                    'visibilityStatus': 'SAVED'|'PUBLISHED',
                    'configuration': {
                        'manualSearchAIAgentConfiguration': {
                            'answerGenerationAIPromptId': 'string',
                            'answerGenerationAIGuardrailId': 'string',
                            'associationConfigurations': [
                                {
                                    'associationId': 'string',
                                    'associationType': 'KNOWLEDGE_BASE',
                                    'associationConfigurationData': {
                                        'knowledgeBaseAssociationConfigurationData': {
                                            'contentTagFilter': {
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                },
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'orConditions': [
                                                    {
                                                        'andConditions': [
                                                            {
                                                                'key': 'string',
                                                                'value': 'string'
                                                            },
                                                        ],
                                                        'tagCondition': {
                                                            'key': 'string',
                                                            'value': 'string'
                                                        }
                                                    },
                                                ]
                                            },
                                            'maxResults': 123,
                                            'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                        }
                                    }
                                },
                            ],
                            'locale': 'string'
                        },
                        'answerRecommendationAIAgentConfiguration': {
                            'intentLabelingGenerationAIPromptId': 'string',
                            'queryReformulationAIPromptId': 'string',
                            'answerGenerationAIPromptId': 'string',
                            'answerGenerationAIGuardrailId': 'string',
                            'associationConfigurations': [
                                {
                                    'associationId': 'string',
                                    'associationType': 'KNOWLEDGE_BASE',
                                    'associationConfigurationData': {
                                        'knowledgeBaseAssociationConfigurationData': {
                                            'contentTagFilter': {
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                },
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'orConditions': [
                                                    {
                                                        'andConditions': [
                                                            {
                                                                'key': 'string',
                                                                'value': 'string'
                                                            },
                                                        ],
                                                        'tagCondition': {
                                                            'key': 'string',
                                                            'value': 'string'
                                                        }
                                                    },
                                                ]
                                            },
                                            'maxResults': 123,
                                            'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                        }
                                    }
                                },
                            ],
                            'locale': 'string',
                            'suggestedMessages': [
                                'string',
                            ]
                        },
                        'selfServiceAIAgentConfiguration': {
                            'selfServicePreProcessingAIPromptId': 'string',
                            'selfServiceAnswerGenerationAIPromptId': 'string',
                            'selfServiceAIGuardrailId': 'string',
                            'associationConfigurations': [
                                {
                                    'associationId': 'string',
                                    'associationType': 'KNOWLEDGE_BASE',
                                    'associationConfigurationData': {
                                        'knowledgeBaseAssociationConfigurationData': {
                                            'contentTagFilter': {
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                },
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'orConditions': [
                                                    {
                                                        'andConditions': [
                                                            {
                                                                'key': 'string',
                                                                'value': 'string'
                                                            },
                                                        ],
                                                        'tagCondition': {
                                                            'key': 'string',
                                                            'value': 'string'
                                                        }
                                                    },
                                                ]
                                            },
                                            'maxResults': 123,
                                            'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                        }
                                    }
                                },
                            ]
                        },
                        'emailResponseAIAgentConfiguration': {
                            'emailResponseAIPromptId': 'string',
                            'emailQueryReformulationAIPromptId': 'string',
                            'locale': 'string',
                            'associationConfigurations': [
                                {
                                    'associationId': 'string',
                                    'associationType': 'KNOWLEDGE_BASE',
                                    'associationConfigurationData': {
                                        'knowledgeBaseAssociationConfigurationData': {
                                            'contentTagFilter': {
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                },
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'orConditions': [
                                                    {
                                                        'andConditions': [
                                                            {
                                                                'key': 'string',
                                                                'value': 'string'
                                                            },
                                                        ],
                                                        'tagCondition': {
                                                            'key': 'string',
                                                            'value': 'string'
                                                        }
                                                    },
                                                ]
                                            },
                                            'maxResults': 123,
                                            'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                        }
                                    }
                                },
                            ]
                        },
                        'emailOverviewAIAgentConfiguration': {
                            'emailOverviewAIPromptId': 'string',
                            'locale': 'string'
                        },
                        'emailGenerativeAnswerAIAgentConfiguration': {
                            'emailGenerativeAnswerAIPromptId': 'string',
                            'emailQueryReformulationAIPromptId': 'string',
                            'locale': 'string',
                            'associationConfigurations': [
                                {
                                    'associationId': 'string',
                                    'associationType': 'KNOWLEDGE_BASE',
                                    'associationConfigurationData': {
                                        'knowledgeBaseAssociationConfigurationData': {
                                            'contentTagFilter': {
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                },
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'orConditions': [
                                                    {
                                                        'andConditions': [
                                                            {
                                                                'key': 'string',
                                                                'value': 'string'
                                                            },
                                                        ],
                                                        'tagCondition': {
                                                            'key': 'string',
                                                            'value': 'string'
                                                        }
                                                    },
                                                ]
                                            },
                                            'maxResults': 123,
                                            'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                        }
                                    }
                                },
                            ]
                        },
                        'orchestrationAIAgentConfiguration': {
                            'orchestrationAIPromptId': 'string',
                            'orchestrationAIGuardrailId': 'string',
                            'toolConfigurations': [
                                {
                                    'toolName': 'string',
                                    'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
                                    'title': 'string',
                                    'toolId': 'string',
                                    'description': 'string',
                                    'instruction': {
                                        'instruction': 'string',
                                        'examples': [
                                            'string',
                                        ]
                                    },
                                    'overrideInputValues': [
                                        {
                                            'jsonPath': 'string',
                                            'value': {
                                                'constant': {
                                                    'type': 'STRING'|'NUMBER'|'JSON_STRING',
                                                    'value': 'string'
                                                }
                                            }
                                        },
                                    ],
                                    'outputFilters': [
                                        {
                                            'jsonPath': 'string',
                                            'outputConfiguration': {
                                                'outputVariableNameOverride': 'string',
                                                'sessionDataNamespace': 'string'
                                            }
                                        },
                                    ],
                                    'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
                                    'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
                                    'annotations': {
                                        'title': 'string',
                                        'destructiveHint': True|False
                                    },
                                    'userInteractionConfiguration': {
                                        'isUserConfirmationRequired': True|False
                                    }
                                },
                            ],
                            'connectInstanceArn': 'string',
                            'locale': 'string'
                        },
                        'noteTakingAIAgentConfiguration': {
                            'noteTakingAIPromptId': 'string',
                            'noteTakingAIGuardrailId': 'string',
                            'locale': 'string'
                        },
                        'caseSummarizationAIAgentConfiguration': {
                            'caseSummarizationAIPromptId': 'string',
                            'caseSummarizationAIGuardrailId': 'string',
                            'locale': 'string'
                        }
                    },
                    'origin': 'SYSTEM'|'CUSTOMER',
                    'description': 'string',
                    'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **aiAgentSummaries** *(list) --* 

          The summaries of AI Agents.

          
          

          - *(dict) --* 

            The summary of the AI Agent.

            
            

            - **name** *(string) --* 

              The name of the AI Agent.

              
            

            - **assistantId** *(string) --* 

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

              
            

            - **assistantArn** *(string) --* 

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

              
            

            - **aiAgentId** *(string) --* 

              The identifier of the AI Agent.

              
            

            - **type** *(string) --* 

              The type of the AI Agent.

              
            

            - **aiAgentArn** *(string) --* 

              The Amazon Resource Name (ARN) of the AI agent.

              
            

            - **modifiedTime** *(datetime) --* 

              The time the AI Agent was last modified.

              
            

            - **visibilityStatus** *(string) --* 

              The visibility status of the AI Agent.

              
            

            - **configuration** *(dict) --* 

              The configuration for the AI Agent.

              .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``manualSearchAIAgentConfiguration``, ``answerRecommendationAIAgentConfiguration``, ``selfServiceAIAgentConfiguration``, ``emailResponseAIAgentConfiguration``, ``emailOverviewAIAgentConfiguration``, ``emailGenerativeAnswerAIAgentConfiguration``, ``orchestrationAIAgentConfiguration``, ``noteTakingAIAgentConfiguration``, ``caseSummarizationAIAgentConfiguration``.     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'}


            
              

              - **manualSearchAIAgentConfiguration** *(dict) --* 

                The configuration for AI Agents of type ``MANUAL_SEARCH``.

                
                

                - **answerGenerationAIPromptId** *(string) --* 

                  The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.

                  
                

                - **answerGenerationAIGuardrailId** *(string) --* 

                  The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.

                  
                

                - **associationConfigurations** *(list) --* 

                  The association configurations for overriding behavior on this AI Agent.

                  
                  

                  - *(dict) --* 

                    The configuration for an Amazon Q in Connect Assistant Association.

                    
                    

                    - **associationId** *(string) --* 

                      The identifier of the association for this Association Configuration.

                      
                    

                    - **associationType** *(string) --* 

                      The type of the association for this Association Configuration.

                      
                    

                    - **associationConfigurationData** *(dict) --* 

                      The data of the configuration for an Amazon Q in Connect Assistant Association.

                      .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``knowledgeBaseAssociationConfigurationData``.     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'}


                    
                      

                      - **knowledgeBaseAssociationConfigurationData** *(dict) --* 

                        The data of the configuration for a ``KNOWLEDGE_BASE`` type Amazon Q in Connect Assistant Association.

                        
                        

                        - **contentTagFilter** *(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.

                                  
                            
                          
                        
                      
                        

                        - **maxResults** *(integer) --* 

                          The maximum number of results to return per page.

                          
                        

                        - **overrideKnowledgeBaseSearchType** *(string) --* 

                          The search type to be used against the Knowledge Base for this request. The values can be ``SEMANTIC`` which uses vector embeddings or ``HYBRID`` which use vector embeddings and raw text

                          
                    
                  
                
              
                

                - **locale** *(string) --* 

                  The locale to which specifies the language and region settings that determine the response language for `QueryAssistant <https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html>`__.

                   

                  .. note::

                    

                    For more information on supported locales, see `Language support for Amazon Q in Connect <https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#qic-notes-languages>`__.

                    

                  
            
              

              - **answerRecommendationAIAgentConfiguration** *(dict) --* 

                The configuration for AI Agents of type ``ANSWER_RECOMMENDATION``.

                
                

                - **intentLabelingGenerationAIPromptId** *(string) --* 

                  The AI Prompt identifier for the Intent Labeling prompt used by the ``ANSWER_RECOMMENDATION`` AI Agent.

                  
                

                - **queryReformulationAIPromptId** *(string) --* 

                  The AI Prompt identifier for the Query Reformulation prompt used by the ``ANSWER_RECOMMENDATION`` AI Agent.

                  
                

                - **answerGenerationAIPromptId** *(string) --* 

                  The AI Prompt identifier for the Answer Generation prompt used by the ``ANSWER_RECOMMENDATION`` AI Agent.

                  
                

                - **answerGenerationAIGuardrailId** *(string) --* 

                  The AI Guardrail identifier for the Answer Generation Guardrail used by the ``ANSWER_RECOMMENDATION`` AI Agent.

                  
                

                - **associationConfigurations** *(list) --* 

                  The association configurations for overriding behavior on this AI Agent.

                  
                  

                  - *(dict) --* 

                    The configuration for an Amazon Q in Connect Assistant Association.

                    
                    

                    - **associationId** *(string) --* 

                      The identifier of the association for this Association Configuration.

                      
                    

                    - **associationType** *(string) --* 

                      The type of the association for this Association Configuration.

                      
                    

                    - **associationConfigurationData** *(dict) --* 

                      The data of the configuration for an Amazon Q in Connect Assistant Association.

                      .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``knowledgeBaseAssociationConfigurationData``.     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'}


                    
                      

                      - **knowledgeBaseAssociationConfigurationData** *(dict) --* 

                        The data of the configuration for a ``KNOWLEDGE_BASE`` type Amazon Q in Connect Assistant Association.

                        
                        

                        - **contentTagFilter** *(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.

                                  
                            
                          
                        
                      
                        

                        - **maxResults** *(integer) --* 

                          The maximum number of results to return per page.

                          
                        

                        - **overrideKnowledgeBaseSearchType** *(string) --* 

                          The search type to be used against the Knowledge Base for this request. The values can be ``SEMANTIC`` which uses vector embeddings or ``HYBRID`` which use vector embeddings and raw text

                          
                    
                  
                
              
                

                - **locale** *(string) --* 

                  The locale to which specifies the language and region settings that determine the response language for `QueryAssistant <https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html>`__.

                   

                  .. note::

                    

                    For more information on supported locales, see `Language support for Amazon Q in Connect <https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#qic-notes-languages>`__.

                    

                  
                

                - **suggestedMessages** *(list) --* 

                  The suggested messages configuration for the Answer Recommendation AI Agent.

                  
                  

                  - *(string) --* 
              
            
              

              - **selfServiceAIAgentConfiguration** *(dict) --* 

                The configuration for AI Agents of type SELF_SERVICE.

                
                

                - **selfServicePreProcessingAIPromptId** *(string) --* 

                  The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent

                  
                

                - **selfServiceAnswerGenerationAIPromptId** *(string) --* 

                  The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent

                  
                

                - **selfServiceAIGuardrailId** *(string) --* 

                  The AI Guardrail identifier used by the SELF_SERVICE AI Agent.

                  
                

                - **associationConfigurations** *(list) --* 

                  The association configurations for overriding behavior on this AI Agent.

                  
                  

                  - *(dict) --* 

                    The configuration for an Amazon Q in Connect Assistant Association.

                    
                    

                    - **associationId** *(string) --* 

                      The identifier of the association for this Association Configuration.

                      
                    

                    - **associationType** *(string) --* 

                      The type of the association for this Association Configuration.

                      
                    

                    - **associationConfigurationData** *(dict) --* 

                      The data of the configuration for an Amazon Q in Connect Assistant Association.

                      .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``knowledgeBaseAssociationConfigurationData``.     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'}


                    
                      

                      - **knowledgeBaseAssociationConfigurationData** *(dict) --* 

                        The data of the configuration for a ``KNOWLEDGE_BASE`` type Amazon Q in Connect Assistant Association.

                        
                        

                        - **contentTagFilter** *(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.

                                  
                            
                          
                        
                      
                        

                        - **maxResults** *(integer) --* 

                          The maximum number of results to return per page.

                          
                        

                        - **overrideKnowledgeBaseSearchType** *(string) --* 

                          The search type to be used against the Knowledge Base for this request. The values can be ``SEMANTIC`` which uses vector embeddings or ``HYBRID`` which use vector embeddings and raw text

                          
                    
                  
                
              
            
              

              - **emailResponseAIAgentConfiguration** *(dict) --* 

                Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.

                
                

                - **emailResponseAIPromptId** *(string) --* 

                  The ID of the System AI prompt used for generating professional email responses based on knowledge base content.

                  
                

                - **emailQueryReformulationAIPromptId** *(string) --* 

                  The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.

                  
                

                - **locale** *(string) --* 

                  The locale setting for language-specific email response generation (for example, en_US, es_ES).

                  
                

                - **associationConfigurations** *(list) --* 

                  Configuration settings for knowledge base associations used by the email response agent.

                  
                  

                  - *(dict) --* 

                    The configuration for an Amazon Q in Connect Assistant Association.

                    
                    

                    - **associationId** *(string) --* 

                      The identifier of the association for this Association Configuration.

                      
                    

                    - **associationType** *(string) --* 

                      The type of the association for this Association Configuration.

                      
                    

                    - **associationConfigurationData** *(dict) --* 

                      The data of the configuration for an Amazon Q in Connect Assistant Association.

                      .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``knowledgeBaseAssociationConfigurationData``.     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'}


                    
                      

                      - **knowledgeBaseAssociationConfigurationData** *(dict) --* 

                        The data of the configuration for a ``KNOWLEDGE_BASE`` type Amazon Q in Connect Assistant Association.

                        
                        

                        - **contentTagFilter** *(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.

                                  
                            
                          
                        
                      
                        

                        - **maxResults** *(integer) --* 

                          The maximum number of results to return per page.

                          
                        

                        - **overrideKnowledgeBaseSearchType** *(string) --* 

                          The search type to be used against the Knowledge Base for this request. The values can be ``SEMANTIC`` which uses vector embeddings or ``HYBRID`` which use vector embeddings and raw text

                          
                    
                  
                
              
            
              

              - **emailOverviewAIAgentConfiguration** *(dict) --* 

                Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.

                
                

                - **emailOverviewAIPromptId** *(string) --* 

                  The ID of the System AI prompt used for generating structured email conversation summaries.

                  
                

                - **locale** *(string) --* 

                  The locale setting for language-specific email overview processing (for example, en_US, es_ES).

                  
            
              

              - **emailGenerativeAnswerAIAgentConfiguration** *(dict) --* 

                Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.

                
                

                - **emailGenerativeAnswerAIPromptId** *(string) --* 

                  The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.

                  
                

                - **emailQueryReformulationAIPromptId** *(string) --* 

                  The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.

                  
                

                - **locale** *(string) --* 

                  The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).

                  
                

                - **associationConfigurations** *(list) --* 

                  Configuration settings for knowledge base associations used by the email generative answer agent.

                  
                  

                  - *(dict) --* 

                    The configuration for an Amazon Q in Connect Assistant Association.

                    
                    

                    - **associationId** *(string) --* 

                      The identifier of the association for this Association Configuration.

                      
                    

                    - **associationType** *(string) --* 

                      The type of the association for this Association Configuration.

                      
                    

                    - **associationConfigurationData** *(dict) --* 

                      The data of the configuration for an Amazon Q in Connect Assistant Association.

                      .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``knowledgeBaseAssociationConfigurationData``.     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'}


                    
                      

                      - **knowledgeBaseAssociationConfigurationData** *(dict) --* 

                        The data of the configuration for a ``KNOWLEDGE_BASE`` type Amazon Q in Connect Assistant Association.

                        
                        

                        - **contentTagFilter** *(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.

                                  
                            
                          
                        
                      
                        

                        - **maxResults** *(integer) --* 

                          The maximum number of results to return per page.

                          
                        

                        - **overrideKnowledgeBaseSearchType** *(string) --* 

                          The search type to be used against the Knowledge Base for this request. The values can be ``SEMANTIC`` which uses vector embeddings or ``HYBRID`` which use vector embeddings and raw text

                          
                    
                  
                
              
            
              

              - **orchestrationAIAgentConfiguration** *(dict) --* 

                The configuration for AI Agents of type ``ORCHESTRATION``.

                
                

                - **orchestrationAIPromptId** *(string) --* 

                  The AI Prompt identifier used by the Orchestration AI Agent.

                  
                

                - **orchestrationAIGuardrailId** *(string) --* 

                  The AI Guardrail identifier used by the Orchestration AI Agent.

                  
                

                - **toolConfigurations** *(list) --* 

                  The tool configurations used by the Orchestration AI Agent.

                  
                  

                  - *(dict) --* 

                    Configuration settings for a tool used by AI Agents.

                    
                    

                    - **toolName** *(string) --* 

                      The name of the tool.

                      
                    

                    - **toolType** *(string) --* 

                      The type of the tool.

                      
                    

                    - **title** *(string) --* 

                      The title of the tool configuration.

                      
                    

                    - **toolId** *(string) --* 

                      The identifier of the tool, for example toolName from Model Context Provider server.

                      
                    

                    - **description** *(string) --* 

                      The description of the tool configuration.

                      
                    

                    - **instruction** *(dict) --* 

                      Instructions for using the tool.

                      
                      

                      - **instruction** *(string) --* 

                        The instruction text for the tool.

                        
                      

                      - **examples** *(list) --* 

                        Examples for using the tool.

                        
                        

                        - *(string) --* 
                    
                  
                    

                    - **overrideInputValues** *(list) --* 

                      Override input values for the tool configuration.

                      
                      

                      - *(dict) --* 

                        An input value override for tools.

                        
                        

                        - **jsonPath** *(string) --* 

                          The JSON path for the input value override.

                          
                        

                        - **value** *(dict) --* 

                          The override input value.

                          .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``constant``.     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'}


                        
                          

                          - **constant** *(dict) --* 

                            Constant input value configuration for tool override.

                            
                            

                            - **type** *(string) --* 

                              Override tool input value with constant values

                              
                            

                            - **value** *(string) --* 

                              The constant input override value.

                              
                        
                      
                    
                  
                    

                    - **outputFilters** *(list) --* 

                      Output filters applies to the tool result.

                      
                      

                      - *(dict) --* 

                        Filter configuration for tool output.

                        
                        

                        - **jsonPath** *(string) --* 

                          The JSON path for filtering tool output.

                          
                        

                        - **outputConfiguration** *(dict) --* 

                          The output configuration for the filter.

                          
                          

                          - **outputVariableNameOverride** *(string) --* 

                            Override the tool output results to different variable name.

                            
                          

                          - **sessionDataNamespace** *(string) --* 

                            The session data namespace for tool output.

                            
                      
                    
                  
                    

                    - **inputSchema** (:ref:`document<document>`) -- 

                      The input schema for the tool configuration.

                      
                    

                    - **outputSchema** (:ref:`document<document>`) -- 

                      The output schema for the tool configuration.

                      
                    

                    - **annotations** *(dict) --* 

                      Annotations for the tool configuration.

                      
                      

                      - **title** *(string) --* 

                        The title of the annotation.

                        
                      

                      - **destructiveHint** *(boolean) --* 

                        A hint indicating that the annotation contains potentially destructive content.

                        
                  
                    

                    - **userInteractionConfiguration** *(dict) --* 

                      Configuration for user interaction with the tool.

                      
                      

                      - **isUserConfirmationRequired** *(boolean) --* 

                        Indicates whether user confirmation is required for the interaction.

                        
                  
                
              
                

                - **connectInstanceArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.

                  
                

                - **locale** *(string) --* 

                  The locale setting for the Orchestration AI Agent.

                  
            
              

              - **noteTakingAIAgentConfiguration** *(dict) --* 

                The configuration for AI Agents of type ``NOTE_TAKING``.

                
                

                - **noteTakingAIPromptId** *(string) --* 

                  The AI Prompt identifier used by the Note Taking AI Agent.

                  
                

                - **noteTakingAIGuardrailId** *(string) --* 

                  The AI Guardrail identifier used by the Note Taking AI Agent.

                  
                

                - **locale** *(string) --* 

                  The locale setting for language-specific case summarization generation (for example, en_US, es_ES).

                  
            
              

              - **caseSummarizationAIAgentConfiguration** *(dict) --* 

                The configuration for AI Agents of type ``CASE_SUMMARIZATION``.

                
                

                - **caseSummarizationAIPromptId** *(string) --* 

                  The AI Prompt identifier used by the Case Summarization AI Agent.

                  
                

                - **caseSummarizationAIGuardrailId** *(string) --* 

                  The AI Guardrail identifier used by the Case Summarization AI Agent.

                  
                

                - **locale** *(string) --* 

                  The locale setting for the Case Summarization AI Agent.

                  
            
          
            

            - **origin** *(string) --* 

              The origin of the AI Agent. ``SYSTEM`` for a default AI Agent created by Q in Connect or ``CUSTOMER`` for an AI Agent created by calling AI Agent creation APIs.

              
            

            - **description** *(string) --* 

              The description of the AI Agent.

              
            

            - **status** *(string) --* 

              The status of the AI Agent.

              
            

            - **tags** *(dict) --* 

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

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    