:doc:`ConnectWisdomService <../../wisdom>` / Client / create_quick_response

*********************
create_quick_response
*********************



.. py:method:: ConnectWisdomService.Client.create_quick_response(**kwargs)

  

  Creates a Wisdom quick response.

  

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


  **Request Syntax**
  ::

    response = client.create_quick_response(
        channels=[
            'string',
        ],
        clientToken='string',
        content={
            'content': 'string'
        },
        contentType='string',
        description='string',
        groupingConfiguration={
            'criteria': 'string',
            'values': [
                'string',
            ]
        },
        isActive=True|False,
        knowledgeBaseId='string',
        language='string',
        name='string',
        shortcutKey='string',
        tags={
            'string': 'string'
        }
    )
    
  :type channels: list
  :param channels: 

    The Amazon Connect channels this quick response applies to.

    

  
    - *(string) --* 

    

  :type clientToken: string
  :param clientToken: 

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see `Making retries safe with idempotent APIs <https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/>`__.

    This field is autopopulated if not provided.

  
  :type content: dict
  :param content: **[REQUIRED]** 

    The content of the quick response.

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``content``. 

  
    - **content** *(string) --* 

      The content of the quick response.

      

    
  
  :type contentType: string
  :param contentType: 

    The media type of the quick response content.

     

    
    * Use ``application/x.quickresponse;format=plain`` for a quick response written in plain text.
     
    * Use ``application/x.quickresponse;format=markdown`` for a quick response written in richtext.
    

    

  
  :type description: string
  :param description: 

    The description of the quick response.

    

  
  :type groupingConfiguration: dict
  :param groupingConfiguration: 

    The configuration information of the user groups that the quick response is accessible to.

    

  
    - **criteria** *(string) --* 

      The criteria used for grouping Wisdom users.

       

      The following is the list of supported criteria values.

       

      
      * ``RoutingProfileArn``: Grouping the users by their `Amazon Connect routing profile ARN <https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html>`__. User should have `SearchRoutingProfile <https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html>`__ and `DescribeRoutingProfile <https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html>`__ permissions when setting criteria to this value.
      

      

    
    - **values** *(list) --* 

      The list of values that define different groups of Wisdom users.

       

      
      * When setting ``criteria`` to ``RoutingProfileArn``, you need to provide a list of ARNs of `Amazon Connect routing profiles <https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html>`__ as values of this parameter.
      

      

    
      - *(string) --* 

      
  
  
  :type isActive: boolean
  :param isActive: 

    Whether the quick response is active.

    

  
  :type knowledgeBaseId: string
  :param knowledgeBaseId: **[REQUIRED]** 

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

    

  
  :type language: string
  :param language: 

    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``

    

  
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the quick response.

    

  
  :type shortcutKey: string
  :param shortcutKey: 

    The shortcut key of the quick response. The value should be unique across the knowledge base.

    

  
  :type tags: dict
  :param tags: 

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

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

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

    

    - *(dict) --* 
      

      - **quickResponse** *(dict) --* 

        The quick response.

        
        

        - **channels** *(list) --* 

          The Amazon Connect contact channels this quick response applies to. The supported contact channel types include ``Chat``.

          
          

          - *(string) --* 
      
        

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

          
        

        - **contents** *(dict) --* 

          The contents 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.

              
        
          

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

              
        
      
        

        - **createdTime** *(datetime) --* 

          The timestamp when the quick response was created.

          
        

        - **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 Wisdom users.

             

            The following is the list of supported criteria values.

             

            
            * ``RoutingProfileArn``: Grouping the users by their `Amazon Connect routing profile ARN <https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html>`__. User should have `SearchRoutingProfile <https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html>`__ and `DescribeRoutingProfile <https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html>`__ permissions when setting criteria to this value.
            

            
          

          - **values** *(list) --* 

            The list of values that define different groups of Wisdom users.

             

            
            * When setting ``criteria`` to ``RoutingProfileArn``, you need to provide a list of ARNs of `Amazon Connect routing profiles <https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html>`__ as values of this parameter.
            

            
            

            - *(string) --* 
        
      
        

        - **isActive** *(boolean) --* 

          Whether the quick response is active.

          
        

        - **knowledgeBaseArn** *(string) --* 

          The Amazon Resource Name (ARN) of the knowledge base.

          
        

        - **knowledgeBaseId** *(string) --* 

          The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

          
        

        - **language** *(string) --* 

          The language code value for the language in which the quick response is written.

          
        

        - **lastModifiedBy** *(string) --* 

          The Amazon Resource Name (ARN) of the user who last updated the quick response data.

          
        

        - **lastModifiedTime** *(datetime) --* 

          The timestamp when the quick response data was last modified.

          
        

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

          The name of the quick response.

          
        

        - **quickResponseArn** *(string) --* 

          The Amazon Resource Name (ARN) of the quick response.

          
        

        - **quickResponseId** *(string) --* 

          The identifier of the quick response.

          
        

        - **shortcutKey** *(string) --* 

          The shortcut key of the quick response. The value should be unique across the knowledge base.

          
        

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

          The status of the quick response data.

          
        

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

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

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`ConnectWisdomService.Client.exceptions.ConflictException`

  
  *   :py:class:`ConnectWisdomService.Client.exceptions.ValidationException`

  
  *   :py:class:`ConnectWisdomService.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`ConnectWisdomService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ConnectWisdomService.Client.exceptions.ResourceNotFoundException`

  