Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateBucket

Creates an Amazon Lightsail bucket.

A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Request Syntax


{
   "bucketName": "string",
   "bundleId": "string",
   "enableObjectVersioning": boolean,
   "tags": [ 
      { 
         "key": "string",
         "value": "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 for the bucket.

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.

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

bundleId

The ID of the bundle to use for the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

Use the UpdateBucketBundle action to change the bundle after the bucket is created.

Type: String

Pattern: .*\S.*

Required: Yes

enableObjectVersioning

A Boolean value that indicates whether to enable versioning of objects in the bucket.

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Type: Boolean

Required: No

tags

The tag keys and optional values to add to the bucket during creation.

Use the TagResource action to tag the bucket after it's created.

Type: Array of Tag objects

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 created.

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

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