:doc:`S3Control <../../s3control>` / Client / list_regional_buckets

*********************
list_regional_buckets
*********************



.. py:method:: S3Control.Client.list_regional_buckets(**kwargs)

  

  .. note::

    

    This operation is not supported by directory buckets.

    

   

  Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see `Using Amazon S3 on Outposts <https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html>`__ in the *Amazon S3 User Guide*.

   

  For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and ``x-amz-outpost-id`` in your request, see the `Examples <https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples>`__ section.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListRegionalBuckets>`_  


  **Request Syntax**
  ::

    response = client.list_regional_buckets(
        AccountId='string',
        NextToken='string',
        MaxResults=123,
        OutpostId='string'
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The Amazon Web Services account ID of the Outposts bucket.

    

  
  :type NextToken: string
  :param NextToken: 

  
  :type MaxResults: integer
  :param MaxResults: 

  
  :type OutpostId: string
  :param OutpostId: 

    The ID of the Outposts resource.

     

    .. note::

      

      This ID is required by Amazon S3 on Outposts buckets.

      

    

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

    
    ::

      {
          'RegionalBucketList': [
              {
                  'Bucket': 'string',
                  'BucketArn': 'string',
                  'PublicAccessBlockEnabled': True|False,
                  'CreationDate': datetime(2015, 1, 1),
                  'OutpostId': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RegionalBucketList** *(list) --* 
        

        - *(dict) --* 

          The container for the regional bucket.

          
          

          - **Bucket** *(string) --* 
          

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

            The Amazon Resource Name (ARN) for the regional bucket.

            
          

          - **PublicAccessBlockEnabled** *(boolean) --* 
          

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

            The creation date of the regional bucket

            
          

          - **OutpostId** *(string) --* 

            The Outposts ID of the regional bucket.

            
      
    
      

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

        ``NextToken`` is sent when ``isTruncated`` is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this ``NextToken``. ``NextToken`` is obfuscated and is not a real key.

        
  