QConnect / Client / list_assistants

list_assistants¶

QConnect.Client.list_assistants(**kwargs)¶

Lists information about assistants.

Request Syntax

response = client.list_assistants(
    nextToken='string',
    maxResults=123
)

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.

Return type:

dict

Returns:

Response Syntax

{
    'assistantSummaries': [
        {
            'assistantId': 'string',
            'assistantArn': 'string',
            'name': 'string',
            'type': 'AGENT',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'description': 'string',
            'tags': {
                'string': 'string'
            },
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            },
            'integrationConfiguration': {
                'topicIntegrationArn': 'string'
            },
            'capabilityConfiguration': {
                'type': 'V1'|'V2'
            },
            'aiAgentConfiguration': {
                'string': {
                    'aiAgentId': 'string'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- assistantSummaries (list) –
  
  Information about the assistants.
  - (dict) –
    
    Summary information about the assistant.
    - 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.
    - name (string) –
      
      The name of the assistant.
    - type (string) –
      
      The type of the assistant.
    - status (string) –
      
      The status of the assistant.
    - description (string) –
      
      The description of the assistant.
    - tags (dict) –
      
      The tags used to organize, track, or control access for this resource.
      - (string) –
        
        (string) –
    - serverSideEncryptionConfiguration (dict) –
      
      The configuration information for the customer managed key used for encryption.
      
      This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
      
      For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
      - kmsKeyId (string) –
        
        The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
    - integrationConfiguration (dict) –
      
      The configuration information for the Amazon Q in Connect assistant integration.
      - topicIntegrationArn (string) –
        
        The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
    - capabilityConfiguration (dict) –
      
      The configuration information for the Amazon Q in Connect assistant capability.
      - type (string) –
        
        The type of Amazon Q in Connect assistant capability.
    - aiAgentConfiguration (dict) –
      
      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
      - (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.
- 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