Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

SetResourceAccessForBucket

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Lightsail buckets currently support setting access for Lightsail instances in the same AWS Region.

Request Syntax


{
   "access": "string",
   "bucketName": "string",
   "resourceName": "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.

access

The access setting.

The following access settings are available:

allow - Allows access to the bucket and its objects.
deny - Denies access to the bucket and its objects. Use this setting to remove access for a resource previously set to allow.

Type: String

Valid Values: allow | deny

Required: Yes

bucketName

The name of the bucket for which to set access to another Lightsail resource.

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

resourceName

The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

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

RegionSetupInProgressException

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.

docs: Regions and Availability Zones for Lightsail
tip: Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.

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