Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteBucket

Deletes a Amazon Lightsail bucket.

Note

When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another AWS account.

Request Syntax


{
   "bucketName": "string",
   "forceDelete": boolean
}

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 to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

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

forceDelete

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

The bucket is the origin of a distribution.
The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.
The bucket has objects.
The bucket has access keys.

Important

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

Type: Boolean

Required: No

Response Syntax


{
   "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.

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