Skip to content

associate_volume async

associate_volume(
    workspace_instance_id: WorkspaceInstanceId,
    volume_id: VolumeId,
    device: DeviceName,
    *,
    config_overrides: Optional[AsyncWorkspacesInstancesClientConfig] = None,
) -> AssociateVolumeResponse

Attaches a volume to a WorkSpace Instance.

Parameters:

  • workspace_instance_id (WorkspaceInstanceId) –

    WorkSpace Instance to attach volume to.

  • volume_id (VolumeId) –

    Volume to be attached.

  • device (DeviceName) –

    Device path for volume attachment.

Raises:

Source code in docs_src/capo_workspaces_instances/_services/async_workspaces_instances.py
async def associate_volume(
    self,
    workspace_instance_id: "capo_workspaces_instances.types.workspace_instance_id.WorkspaceInstanceId",
    volume_id: "capo_workspaces_instances.types.volume_id.VolumeId",
    device: "capo_workspaces_instances.types.device_name.DeviceName",
    *,
    config_overrides: Optional[AsyncWorkspacesInstancesClientConfig] = None,
) -> "capo_workspaces_instances.types.associate_volume_response.AssociateVolumeResponse":
    """<p>Attaches a volume to a WorkSpace Instance.</p>

    Args:
        workspace_instance_id: <p>WorkSpace Instance to attach volume to.</p>
        volume_id: <p>Volume to be attached.</p>
        device: <p>Device path for volume attachment.</p>

    Raises:
        capo_workspaces_instances.errors.access_denied_exception.AccessDeniedException: <p>Indicates insufficient permissions to perform the requested action.</p>
        capo_workspaces_instances.errors.conflict_exception.ConflictException: <p>Signals a conflict with the current state of the resource.</p>
        capo_workspaces_instances.errors.internal_server_exception.InternalServerException: <p>Indicates an unexpected server-side error occurred.</p>
        capo_workspaces_instances.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates the requested resource could not be found.</p>
        capo_workspaces_instances.errors.throttling_exception.ThrottlingException: <p>Indicates the request rate has exceeded limits.</p>
        capo_workspaces_instances.errors.validation_exception.ValidationException: <p>Indicates invalid input parameters in the request.</p>
        capo_workspaces_instances.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces_instances.types.associate_volume_request.AssociateVolumeRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces_instances.types.associate_volume_response.AssociateVolumeResponse"
    ]:
        import capo_workspaces_instances._operations.eucmi_frontend_api_service.associate_volume

        (
            output,
            http_response,
        ) = await capo_workspaces_instances._operations.eucmi_frontend_api_service.associate_volume.async_associate_volume(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateVolume")
    )
    input_: capo_workspaces_instances.types.associate_volume_request.AssociateVolumeRequest = {
        "workspace_instance_id": workspace_instance_id,
        "volume_id": volume_id,
        "device": device,
    }

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