:doc:`Chatbot <../../chatbot>` / Client / create_chime_webhook_configuration

**********************************
create_chime_webhook_configuration
**********************************



.. py:method:: Chatbot.Client.create_chime_webhook_configuration(**kwargs)

  

  Creates an AWS Chatbot configuration for Amazon Chime.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chatbot-2017-10-11/CreateChimeWebhookConfiguration>`_  


  **Request Syntax**
  ::

    response = client.create_chime_webhook_configuration(
        WebhookDescription='string',
        WebhookUrl='string',
        SnsTopicArns=[
            'string',
        ],
        IamRoleArn='string',
        ConfigurationName='string',
        LoggingLevel='string',
        Tags=[
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    )
    
  :type WebhookDescription: string
  :param WebhookDescription: **[REQUIRED]** 

    A description of the webhook. We recommend using the convention ``RoomName/WebhookName``.

     

    For more information, see `Tutorial\: Get started with Amazon Chime <https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html>`__ in the *AWS Chatbot Administrator Guide*.

    

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

    The URL for the Amazon Chime webhook.

    

  
  :type SnsTopicArns: list
  :param SnsTopicArns: **[REQUIRED]** 

    The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

    

  
    - *(string) --* 

    

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

    A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

     

    For more information, see `IAM policies for AWS Chatbot <https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html>`__ in the *AWS Chatbot Administrator Guide*.

    

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

    The name of the configuration.

    

  
  :type LoggingLevel: string
  :param LoggingLevel: 

    Logging levels include ``ERROR``, ``INFO``, or ``NONE``.

    

  
  :type Tags: list
  :param Tags: 

    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

    

  
    - *(dict) --* 

      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

       

      .. warning::

         

        Do not include confidential or sensitive information in this field.

         

       

      For more information, see `User-Defined Tag Restrictions <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html>`__ in the *AWS Billing and Cost Management User Guide*.

      

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

        The key of the tag.

        

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

        The value of the tag.

        

      
    

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

    
    ::

      {
          'WebhookConfiguration': {
              'WebhookDescription': 'string',
              'ChatConfigurationArn': 'string',
              'IamRoleArn': 'string',
              'SnsTopicArns': [
                  'string',
              ],
              'ConfigurationName': 'string',
              'LoggingLevel': 'string',
              'Tags': [
                  {
                      'TagKey': 'string',
                      'TagValue': 'string'
                  },
              ],
              'State': 'string',
              'StateReason': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **WebhookConfiguration** *(dict) --* 

        An Amazon Chime webhook configuration.

        
        

        - **WebhookDescription** *(string) --* 

          A description of the webhook. We recommend using the convention ``RoomName/WebhookName``.

           

          For more information, see `Tutorial\: Get started with Amazon Chime <https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html>`__ in the *AWS Chatbot Administrator Guide*.

          
        

        - **ChatConfigurationArn** *(string) --* 

          The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

          
        

        - **IamRoleArn** *(string) --* 

          A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

           

          For more information, see `IAM policies for AWS Chatbot <https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html>`__ in the *AWS Chatbot Administrator Guide*.

          
        

        - **SnsTopicArns** *(list) --* 

          The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

          
          

          - *(string) --* 
      
        

        - **ConfigurationName** *(string) --* 

          The name of the configuration.

          
        

        - **LoggingLevel** *(string) --* 

          Logging levels include ``ERROR``, ``INFO``, or ``NONE``.

          
        

        - **Tags** *(list) --* 

          A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

          
          

          - *(dict) --* 

            A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

             

            .. warning::

               

              Do not include confidential or sensitive information in this field.

               

             

            For more information, see `User-Defined Tag Restrictions <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html>`__ in the *AWS Billing and Cost Management User Guide*.

            
            

            - **TagKey** *(string) --* 

              The key of the tag.

              
            

            - **TagValue** *(string) --* 

              The value of the tag.

              
        
      
        

        - **State** *(string) --* 

          Either ``ENABLED`` or ``DISABLED``. The resource returns ``DISABLED`` if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.

          
        

        - **StateReason** *(string) --* 

          Provided if State is ``DISABLED``. Provides context as to why the resource is disabled.

          
    
  
  **Exceptions**
  
  *   :py:class:`Chatbot.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Chatbot.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Chatbot.Client.exceptions.ConflictException`

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

  
  *   :py:class:`Chatbot.Client.exceptions.CreateChimeWebhookConfigurationException`

  