- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
SetResourceAccessForBucketCommand
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LightsailClient, SetResourceAccessForBucketCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, SetResourceAccessForBucketCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // SetResourceAccessForBucketRequest
resourceName: "STRING_VALUE", // required
bucketName: "STRING_VALUE", // required
access: "allow" || "deny", // required
};
const command = new SetResourceAccessForBucketCommand(input);
const response = await client.send(command);
// { // SetResourceAccessForBucketResult
// operations: [ // OperationList
// { // Operation
// id: "STRING_VALUE",
// resourceName: "STRING_VALUE",
// resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket",
// createdAt: new Date("TIMESTAMP"),
// location: { // ResourceLocation
// availabilityZone: "STRING_VALUE",
// regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "eu-north-1",
// },
// isTerminal: true || false,
// operationDetails: "STRING_VALUE",
// operationType: "DeleteKnownHostKeys" || "DeleteInstance" || "CreateInstance" || "StopInstance" || "StartInstance" || "RebootInstance" || "OpenInstancePublicPorts" || "PutInstancePublicPorts" || "CloseInstancePublicPorts" || "AllocateStaticIp" || "ReleaseStaticIp" || "AttachStaticIp" || "DetachStaticIp" || "UpdateDomainEntry" || "DeleteDomainEntry" || "CreateDomain" || "DeleteDomain" || "CreateInstanceSnapshot" || "DeleteInstanceSnapshot" || "CreateInstancesFromSnapshot" || "CreateLoadBalancer" || "DeleteLoadBalancer" || "AttachInstancesToLoadBalancer" || "DetachInstancesFromLoadBalancer" || "UpdateLoadBalancerAttribute" || "CreateLoadBalancerTlsCertificate" || "DeleteLoadBalancerTlsCertificate" || "AttachLoadBalancerTlsCertificate" || "CreateDisk" || "DeleteDisk" || "AttachDisk" || "DetachDisk" || "CreateDiskSnapshot" || "DeleteDiskSnapshot" || "CreateDiskFromSnapshot" || "CreateRelationalDatabase" || "UpdateRelationalDatabase" || "DeleteRelationalDatabase" || "CreateRelationalDatabaseFromSnapshot" || "CreateRelationalDatabaseSnapshot" || "DeleteRelationalDatabaseSnapshot" || "UpdateRelationalDatabaseParameters" || "StartRelationalDatabase" || "RebootRelationalDatabase" || "StopRelationalDatabase" || "EnableAddOn" || "DisableAddOn" || "PutAlarm" || "GetAlarms" || "DeleteAlarm" || "TestAlarm" || "CreateContactMethod" || "GetContactMethods" || "SendContactMethodVerification" || "DeleteContactMethod" || "CreateDistribution" || "UpdateDistribution" || "DeleteDistribution" || "ResetDistributionCache" || "AttachCertificateToDistribution" || "DetachCertificateFromDistribution" || "UpdateDistributionBundle" || "SetIpAddressType" || "CreateCertificate" || "DeleteCertificate" || "CreateContainerService" || "UpdateContainerService" || "DeleteContainerService" || "CreateContainerServiceDeployment" || "CreateContainerServiceRegistryLogin" || "RegisterContainerImage" || "DeleteContainerImage" || "CreateBucket" || "DeleteBucket" || "CreateBucketAccessKey" || "DeleteBucketAccessKey" || "UpdateBucketBundle" || "UpdateBucket" || "SetResourceAccessForBucket" || "UpdateInstanceMetadataOptions" || "StartGUISession" || "StopGUISession" || "SetupInstanceHttps",
// status: "NotStarted" || "Started" || "Failed" || "Completed" || "Succeeded",
// statusChangedAt: new Date("TIMESTAMP"),
// errorCode: "STRING_VALUE",
// errorDetails: "STRING_VALUE",
// },
// ],
// };
SetResourceAccessForBucketCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
accessRequired | ResourceBucketAccess | undefined | The access setting. The following access settings are available:
|
bucketNameRequired | string | undefined | The name of the bucket for which to set access to another Lightsail resource. |
resourceNameRequired | string | undefined | The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state. |
SetResourceAccessForBucketCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
operations | Operation[] | undefined | 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. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
| InvalidInputException | client | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( |
| NotFoundException | client | Lightsail throws this exception when it cannot find a resource. |
| ServiceException | server | A general service exception. |
| UnauthenticatedException | client | Lightsail throws this exception when the user has not been authenticated. |
| LightsailServiceException | Base exception class for all service exceptions from Lightsail service. |