:doc:`BillingandCostManagementDashboards <../../bcm-dashboards>` / Paginator / ListDashboards

**************
ListDashboards
**************



.. py:class:: BillingandCostManagementDashboards.Paginator.ListDashboards

  ::

    
    paginator = client.get_paginator('list_dashboards')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`BillingandCostManagementDashboards.Client.list_dashboards`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bcm-dashboards-2025-08-18/ListDashboards>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'dashboards': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'description': 'string',
                    'type': 'CUSTOM',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **dashboards** *(list) --* 

          An array of dashboard references, containing basic information about each dashboard.

          
          

          - *(dict) --* 

            Contains basic information about a dashboard, including its ARN, name, type, and timestamps.

            
            

            - **arn** *(string) --* 

              The ARN of the referenced dashboard.

              
            

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

              The name of the referenced dashboard.

              
            

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

              The description of the referenced dashboard.

              
            

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

              The dashboard type.

              
            

            - **createdAt** *(datetime) --* 

              The timestamp when the dashboard was created.

              
            

            - **updatedAt** *(datetime) --* 

              The timestamp when the dashboard was last modified.

              
        
      
        

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

          A token to resume pagination.

          
    