attach_disk `async` ¶

attach_disk(
    disk_name: ResourceName,
    instance_name: ResourceName,
    disk_path: NonEmptyString,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    auto_mounting: Optional[boolean] = None,
) -> AttachDiskResult

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

Parameters:

disk_name (ResourceName) –

The unique Lightsail disk name (my-disk).
instance_name (ResourceName) –

The name of the Lightsail instance where you want to utilize the storage disk.
disk_path (NonEmptyString) –

The disk path to expose to the instance (/dev/xvdf).
auto_mounting (Optional[boolean], default: None ) –

A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False.

This value only applies to Lightsail for Research resources.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
AccountSetupInProgressException –

Lightsail throws this exception when an account is still in the setup in progress state.
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.
OperationFailureException –

Lightsail throws this exception when an operation fails to execute.
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 attach_disk(
    self,
    disk_name: "capo_lightsail.types.resource_name.ResourceName",
    instance_name: "capo_lightsail.types.resource_name.ResourceName",
    disk_path: "capo_lightsail.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    auto_mounting: Optional["capo_lightsail.types.boolean.boolean"] = None,
) -> "capo_lightsail.types.attach_disk_result.AttachDiskResult":
    """<p>Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.</p> <p>The <code>attach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags">Amazon Lightsail Developer Guide</a>.</p>

    Args:
        disk_name: <p>The unique Lightsail disk name (<code>my-disk</code>).</p>
        instance_name: <p>The name of the Lightsail instance where you want to utilize the storage disk.</p>
        disk_path: <p>The disk path to expose to the instance (<code>/dev/xvdf</code>).</p>
        auto_mounting: <p>A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is <code>False</code>.</p> <important> <p>This value only applies to Lightsail for Research resources.</p> </important>

    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.account_setup_in_progress_exception.AccountSetupInProgressException: <p>Lightsail throws this exception when an account is still in the setup in progress state.</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.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</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.attach_disk_request.AttachDiskRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.attach_disk_result.AttachDiskResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.attach_disk

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.attach_disk.async_attach_disk(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AttachDisk")
    )
    input_: capo_lightsail.types.attach_disk_request.AttachDiskRequest = {
        "disk_name": disk_name,
        "instance_name": instance_name,
        "disk_path": disk_path,
    }
    if auto_mounting is not None:
        input_["auto_mounting"] = auto_mounting

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

attach_disk async ¶

attach_disk `async` ¶