GetBuckets
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.
Request Syntax
{
"bucketName": "string",
"includeConnectedResources": boolean,
"pageToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- bucketName
-
The name of the bucket for which to return information.
When omitted, the response includes all of your buckets in the AWS Region where the request is made.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 54.
Pattern:
^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$Required: No
- includeConnectedResources
-
A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.
Type: Boolean
Required: No
- pageToken
-
The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetBucketsrequest. 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.Type: String
Required: No
Response Syntax
{
"accountLevelBpaSync": {
"bpaImpactsLightsail": boolean,
"lastSyncedAt": number,
"message": "string",
"status": "string"
},
"buckets": [
{
"ableToUpdateBundle": boolean,
"accessLogConfig": {
"destination": "string",
"enabled": boolean,
"prefix": "string"
},
"accessRules": {
"allowPublicOverrides": boolean,
"getObject": "string"
},
"arn": "string",
"bundleId": "string",
"createdAt": number,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"name": "string",
"objectVersioning": "string",
"readonlyAccessAccounts": [ "string" ],
"resourcesReceivingAccess": [
{
"name": "string",
"resourceType": "string"
}
],
"resourceType": "string",
"state": {
"code": "string",
"message": "string"
},
"supportCode": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"url": "string"
}
],
"nextPageToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- accountLevelBpaSync
-
An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.
For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.
Type: AccountLevelBpaSync object
- buckets
-
An array of objects that describe buckets.
Type: Array of Bucket objects
- nextPageToken
-
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
GetBucketsrequest and specify the next page token using thepageTokenparameter.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
- InvalidInputException
-
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Note
Domain and distribution APIs are only available in the N. Virginia (
us-east-1) AWS Region. Please set your AWS Region configuration tous-east-1to create, view, or edit these resources.HTTP Status Code: 400
- NotFoundException
-
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
- ServiceException
-
A general service exception.
HTTP Status Code: 500
- UnauthenticatedException
-
Lightsail throws this exception when the user has not been authenticated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
