QConnect / Client / get_quick_response

get_quick_response¶

QConnect.Client.get_quick_response(**kwargs)¶

Retrieves the quick response.

Request Syntax

response = client.get_quick_response(
    quickResponseId='string',
    knowledgeBaseId='string'
)

Parameters:

quickResponseId (string) –
[REQUIRED]

The identifier of the quick response.
knowledgeBaseId (string) –
[REQUIRED]

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

Return type:

dict

Returns:

Response Syntax

{
    'quickResponse': {
        'quickResponseArn': 'string',
        'quickResponseId': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'name': 'string',
        'contentType': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
        'createdTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'contents': {
            'plainText': {
                'content': 'string'
            },
            'markdown': {
                'content': 'string'
            }
        },
        'description': 'string',
        'groupingConfiguration': {
            'criteria': 'string',
            'values': [
                'string',
            ]
        },
        'shortcutKey': 'string',
        'lastModifiedBy': 'string',
        'isActive': True|False,
        'channels': [
            'string',
        ],
        'language': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) –
- quickResponse (dict) –
  
  The quick response.
  - quickResponseArn (string) –
    
    The Amazon Resource Name (ARN) of the quick response.
  - quickResponseId (string) –
    
    The identifier of the quick response.
  - knowledgeBaseArn (string) –
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - knowledgeBaseId (string) –
    
    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
  - name (string) –
    
    The name of the quick response.
  - contentType (string) –
    
    The media type of the quick response content.
    - Use application/x.quickresponse;format=plain for quick response written in plain text.
    - Use application/x.quickresponse;format=markdown for quick response written in richtext.
  - status (string) –
    
    The status of the quick response data.
  - createdTime (datetime) –
    
    The timestamp when the quick response was created.
  - lastModifiedTime (datetime) –
    
    The timestamp when the quick response data was last modified.
  - contents (dict) –
    
    The contents of the quick response.
    - plainText (dict) –
      
      The container quick response content.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: content. 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'}
      - content (string) –
        
        The content of the quick response.
    - markdown (dict) –
      
      The container quick response content.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: content. 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'}
      - content (string) –
        
        The content of the quick response.
  - description (string) –
    
    The description of the quick response.
  - groupingConfiguration (dict) –
    
    The configuration information of the user groups that the quick response is accessible to.
    - criteria (string) –
      
      The criteria used for grouping Amazon Q in Connect users.
      
      The following is the list of supported criteria values.
      - RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
    - values (list) –
      
      The list of values that define different groups of Amazon Q in Connect users.
      - When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
      - (string) –
  - shortcutKey (string) –
    
    The shortcut key of the quick response. The value should be unique across the knowledge base.
  - lastModifiedBy (string) –
    
    The Amazon Resource Name (ARN) of the user who last updated the quick response data.
  - isActive (boolean) –
    
    Whether the quick response is active.
  - channels (list) –
    
    The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
    - (string) –
  - language (string) –
    
    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
  - 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