:doc:`Chatbot <../../chatbot>` / Paginator / DescribeChimeWebhookConfigurations

**********************************
DescribeChimeWebhookConfigurations
**********************************



.. py:class:: Chatbot.Paginator.DescribeChimeWebhookConfigurations

  ::

    
    paginator = client.get_paginator('describe_chime_webhook_configurations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Chatbot.Client.describe_chime_webhook_configurations`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ChatConfigurationArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ChatConfigurationArn: string
    :param ChatConfigurationArn: 

      An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

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

      

      - *(dict) --* 
        

        - **WebhookConfigurations** *(list) --* 

          A list of Amazon Chime webhooks associated with the account.

          
          

          - *(dict) --* 

            An AWS Chatbot configuration for Amazon Chime.

            
            

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

              
        
      
    