:doc:`RedshiftServerless <../../redshift-serverless>` / Paginator / ListUsageLimits

***************
ListUsageLimits
***************



.. py:class:: RedshiftServerless.Paginator.ListUsageLimits

  ::

    
    paginator = client.get_paginator('list_usage_limits')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`RedshiftServerless.Client.list_usage_limits`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListUsageLimits>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          resourceArn='string',
          usageType='serverless-compute'|'cross-region-datasharing',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type resourceArn: string
    :param resourceArn: 

      The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

      

    
    :type usageType: string
    :param usageType: 

      The Amazon Redshift Serverless feature whose limits you want to see.

      

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

      
      ::

        {
            'usageLimits': [
                {
                    'amount': 123,
                    'breachAction': 'log'|'emit-metric'|'deactivate',
                    'period': 'daily'|'weekly'|'monthly',
                    'resourceArn': 'string',
                    'usageLimitArn': 'string',
                    'usageLimitId': 'string',
                    'usageType': 'serverless-compute'|'cross-region-datasharing'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **usageLimits** *(list) --* 

          An array of returned usage limit objects.

          
          

          - *(dict) --* 

            The usage limit object.

            
            

            - **amount** *(integer) --* 

              The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

              
            

            - **breachAction** *(string) --* 

              The action that Amazon Redshift Serverless takes when the limit is reached.

              
            

            - **period** *(string) --* 

              The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

              
            

            - **resourceArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

              
            

            - **usageLimitArn** *(string) --* 

              The Amazon Resource Name (ARN) of the resource associated with the usage limit.

              
            

            - **usageLimitId** *(string) --* 

              The identifier of the usage limit.

              
            

            - **usageType** *(string) --* 

              The Amazon Redshift Serverless feature to limit.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    