:doc:`RedshiftServerless <../../redshift-serverless>` / Client / list_usage_limits

*****************
list_usage_limits
*****************



.. py:method:: RedshiftServerless.Client.list_usage_limits(**kwargs)

  

  Lists all usage limits within Amazon Redshift Serverless.

  

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


  **Request Syntax**
  ::

    response = client.list_usage_limits(
        maxResults=123,
        nextToken='string',
        resourceArn='string',
        usageType='serverless-compute'|'cross-region-datasharing'
    )
    
  :type maxResults: integer
  :param maxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to get the next page of results. The default is 100.

    

  
  :type nextToken: string
  :param nextToken: 

    If your initial ``ListUsageLimits`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in following ``ListUsageLimits`` operations, which returns results in the next page.

    

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

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`RedshiftServerless.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`RedshiftServerless.Client.exceptions.InvalidPaginationException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ValidationException`

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

  