Post x amz targetlightsail_20161128.getbuckets

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14159650798.5 KB

Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

post/#X-Amz-Target=Lightsail_20161128.GetBuckets

Headers

X-Amz-Target'Lightsail_20161128.GetBuckets' required

Request body

bucketNamestring

The name of the bucket for which to return information. When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.

pageTokenstring

The token to advance to the next page of results from your request. To get a page token, perform an initial <code>GetBuckets</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

includeConnectedResourcesboolean

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html">SetResourceAccessForBucket</a> action.

Response

Success

nextPageTokenstring

The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another <code>GetBuckets</code> request and specify the next page token using the <code>pageToken</code> parameter.