Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateBucket

Updates an existing Amazon Lightsail bucket.

Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the AWS accounts that can access the bucket.

Request Syntax


{
   "accessLogConfig": { 
      "destination": "string",
      "enabled": boolean,
      "prefix": "string"
   },
   "accessRules": { 
      "allowPublicOverrides": boolean,
      "getObject": "string"
   },
   "bucketName": "string",
   "readonlyAccessAccounts": [ "string" ],
   "versioning": "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.

accessLogConfig

An object that describes the access log configuration for the bucket.

Type: BucketAccessLogConfig object

Required: No

accessRules

An object that sets the public accessibility of objects in the specified bucket.

Type: AccessRules object

Required: No

bucketName

The name of the bucket to update.

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

readonlyAccessAccounts

An array of strings to specify the AWS account IDs that can access the bucket.

You can give a maximum of 10 AWS accounts access to a bucket.

Type: Array of strings

Array Members: Maximum number of 10 items.

Pattern: .*\S.*

Required: No

versioning

Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

Enabled - Enables versioning of objects in the specified bucket.
Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

Type: String

Pattern: .*\S.*

Required: No

Response Syntax


{
   "bucket": { 
      "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"
   },
   "operations": [ 
      { 
         "createdAt": number,
         "errorCode": "string",
         "errorDetails": "string",
         "id": "string",
         "isTerminal": boolean,
         "location": { 
            "availabilityZone": "string",
            "regionName": "string"
         },
         "operationDetails": "string",
         "operationType": "string",
         "resourceName": "string",
         "resourceType": "string",
         "status": "string",
         "statusChangedAt": number
      }
   ]
}

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.

bucket

An object that describes the bucket that is updated.

Type: Bucket object

operations

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

Type: Array of Operation objects

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 to us-east-1 to 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