:doc:`S3 <../../s3>` / Paginator / ListBuckets

***********
ListBuckets
***********



.. py:class:: S3.Paginator.ListBuckets

  ::

    
    paginator = client.get_paginator('list_buckets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`S3.Client.list_buckets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets>`_    


    **Request Syntax**
    ::

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

      Limits the response to bucket names that begin with the specified bucket name prefix.

      

    
    :type BucketRegion: string
    :param BucketRegion: 

      Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as ``us-west-2`` for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see `Regions and Endpoints <https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region>`__.

       

      .. note::

        

        Requests made to a Regional endpoint that is different from the ``bucket-region`` parameter are not supported. For example, if you want to limit the response to your buckets in Region ``us-west-2``, the request must be made to an endpoint in Region ``us-west-2``.

        

      

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

      
      ::

        {
            'Buckets': [
                {
                    'Name': 'string',
                    'CreationDate': datetime(2015, 1, 1),
                    'BucketRegion': 'string',
                    'BucketArn': 'string'
                },
            ],
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            },
            'Prefix': 'string',
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Buckets** *(list) --* 

          The list of buckets owned by the requester.

          
          

          - *(dict) --* 

            In terms of implementation, a Bucket is a resource.

            
            

            - **Name** *(string) --* 

              The name of the bucket.

              
            

            - **CreationDate** *(datetime) --* 

              Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

              
            

            - **BucketRegion** *(string) --* 

              ``BucketRegion`` indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.

              
            

            - **BucketArn** *(string) --* 

              The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.

               

              .. note::

                

                This parameter is only supported for S3 directory buckets. For more information, see `Using tags with directory buckets <https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html>`__.

                

              
        
      
        

        - **Owner** *(dict) --* 

          The owner of the buckets listed.

          
          

          - **DisplayName** *(string) --* 
          

          - **ID** *(string) --* 

            Container for the ID of the owner.

            
      
        

        - **Prefix** *(string) --* 

          If ``Prefix`` was sent with the request, it is included in the response.

           

          All bucket names in the response begin with the specified bucket name prefix.

          
        

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

          A token to resume pagination.

          
    