:doc:`LexModelBuildingService <../../lex-models>` / Client / get_bot_channel_association

***************************
get_bot_channel_association
***************************



.. py:method:: LexModelBuildingService.Client.get_bot_channel_association(**kwargs)

  

  Returns information about the association between an Amazon Lex bot and a messaging platform.

   

  This operation requires permissions for the ``lex:GetBotChannelAssociation`` action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/GetBotChannelAssociation>`_  


  **Request Syntax**
  ::

    response = client.get_bot_channel_association(
        name='string',
        botName='string',
        botAlias='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the association between the bot and the channel. The name is case sensitive.

    

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

    The name of the Amazon Lex bot.

    

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

    An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

    

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

    
    ::

      {
          'name': 'string',
          'description': 'string',
          'botAlias': 'string',
          'botName': 'string',
          'createdDate': datetime(2015, 1, 1),
          'type': 'Facebook'|'Slack'|'Twilio-Sms'|'Kik',
          'botConfiguration': {
              'string': 'string'
          },
          'status': 'IN_PROGRESS'|'CREATED'|'FAILED',
          'failureReason': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The name of the association between the bot and the channel.

        
      

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

        A description of the association between the bot and the channel.

        
      

      - **botAlias** *(string) --* 

        An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

        
      

      - **botName** *(string) --* 

        The name of the Amazon Lex bot.

        
      

      - **createdDate** *(datetime) --* 

        The date that the association between the bot and the channel was created.

        
      

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

        The type of the messaging platform.

        
      

      - **botConfiguration** *(dict) --* 

        Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

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

        The status of the bot channel.

         

        
        * ``CREATED`` - The channel has been created and is ready for use.
         
        * ``IN_PROGRESS`` - Channel creation is in progress.
         
        * ``FAILED`` - There was an error creating the channel. For information about the reason for the failure, see the ``failureReason`` field.
        

        
      

      - **failureReason** *(string) --* 

        If ``status`` is ``FAILED``, Amazon Lex provides the reason that it failed to create the association.

        
  
  **Exceptions**
  
  *   :py:class:`LexModelBuildingService.Client.exceptions.NotFoundException`

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

  
  *   :py:class:`LexModelBuildingService.Client.exceptions.InternalFailureException`

  
  *   :py:class:`LexModelBuildingService.Client.exceptions.BadRequestException`

  