:doc:`Connect <../../connect>` / Client / create_quick_connect

********************
create_quick_connect
********************



.. py:method:: Connect.Client.create_quick_connect(**kwargs)

  

  Creates a quick connect for the specified Amazon Connect instance.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnect>`_  


  **Request Syntax**
  ::

    response = client.create_quick_connect(
        InstanceId='string',
        Name='string',
        Description='string',
        QuickConnectConfig={
            'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW',
            'UserConfig': {
                'UserId': 'string',
                'ContactFlowId': 'string'
            },
            'QueueConfig': {
                'QueueId': 'string',
                'ContactFlowId': 'string'
            },
            'PhoneConfig': {
                'PhoneNumber': 'string'
            },
            'FlowConfig': {
                'ContactFlowId': 'string'
            }
        },
        Tags={
            'string': 'string'
        }
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

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

    A unique name of the quick connect.

    

  
  :type Description: string
  :param Description: 

    The description of the quick connect.

    

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

    Configuration settings for the quick connect.

    

  
    - **QuickConnectType** *(string) --* **[REQUIRED]** 

      The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

      

    
    - **UserConfig** *(dict) --* 

      The user configuration. This is required only if QuickConnectType is USER.

      

    
      - **UserId** *(string) --* **[REQUIRED]** 

        The identifier of the user.

        

      
      - **ContactFlowId** *(string) --* **[REQUIRED]** 

        The identifier of the flow.

        

      
    
    - **QueueConfig** *(dict) --* 

      The queue configuration. This is required only if QuickConnectType is QUEUE.

      

    
      - **QueueId** *(string) --* **[REQUIRED]** 

        The identifier for the queue.

        

      
      - **ContactFlowId** *(string) --* **[REQUIRED]** 

        The identifier of the flow.

        

      
    
    - **PhoneConfig** *(dict) --* 

      The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

      

    
      - **PhoneNumber** *(string) --* **[REQUIRED]** 

        The phone number in E.164 format.

        

      
    
    - **FlowConfig** *(dict) --* 

      Flow configuration for quick connect setup.

      

    
      - **ContactFlowId** *(string) --* **[REQUIRED]** 

        The contact flow ID for the quick connect configuration.

        

      
    
  
  :type Tags: dict
  :param Tags: 

    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'QuickConnectARN': 'string',
          'QuickConnectId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **QuickConnectARN** *(string) --* 

        The Amazon Resource Name (ARN) for the quick connect.

        
      

      - **QuickConnectId** *(string) --* 

        The identifier for the quick connect.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Connect.Client.exceptions.DuplicateResourceException`

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

  
  *   :py:class:`Connect.Client.exceptions.LimitExceededException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  