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.
Parameters:
-
resource_name
(ResourceName)
–
The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.
-
bucket_name
(BucketName)
–
The name of the bucket for which to set access to another Lightsail resource.
-
access
(ResourceBucketAccess)
–
The access setting.
The following access settings are available:
Raises:
-
AccessDeniedException
–
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
-
InvalidInputException
–
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 (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
-
NotFoundException
–
Lightsail throws this exception when it cannot find a resource.
-
RegionSetupInProgressException
–
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
-
ServiceException
–
A general service exception.
-
UnauthenticatedException
–
Lightsail throws this exception when the user has not been authenticated.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_lightsail/_services/async_lightsail.py
| async def set_resource_access_for_bucket(
self,
resource_name: "capo_lightsail.types.resource_name.ResourceName",
bucket_name: "capo_lightsail.types.bucket_name.BucketName",
access: "capo_lightsail.types.resource_bucket_access.ResourceBucketAccess",
*,
config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> "capo_lightsail.types.set_resource_access_for_bucket_result.SetResourceAccessForBucketResult":
"""<p>Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.</p> <p>Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.</p>
Args:
resource_name: <p>The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.</p>
bucket_name: <p>The name of the bucket for which to set access to another Lightsail resource.</p>
access: <p>The access setting.</p> <p>The following access settings are available:</p> <ul> <li> <p> <code>allow</code> - Allows access to the bucket and its objects.</p> </li> <li> <p> <code>deny</code> - Denies access to the bucket and its objects. Use this setting to remove access for a resource previously set to <code>allow</code>.</p> </li> </ul>
Raises:
capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_lightsail.types.set_resource_access_for_bucket_request.SetResourceAccessForBucketRequest]",
) -> AsyncOperationResponse[
"capo_lightsail.types.set_resource_access_for_bucket_result.SetResourceAccessForBucketResult"
]:
import capo_lightsail._operations.lightsail_20161128.set_resource_access_for_bucket
(
output,
http_response,
) = await capo_lightsail._operations.lightsail_20161128.set_resource_access_for_bucket.async_set_resource_access_for_bucket(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("SetResourceAccessForBucket")
)
input_: capo_lightsail.types.set_resource_access_for_bucket_request.SetResourceAccessForBucketRequest = {
"resource_name": resource_name,
"bucket_name": bucket_name,
"access": access,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|