get_volume `async` ¶

get_volume(
    farm_id: FarmId,
    fleet_id: FleetId,
    volume_id: VolumeId,
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> GetVolumeResponse

Gets a persistent volume.

Parameters:

farm_id (FarmId) –

The farm ID of the farm that contains the fleet.
fleet_id (FleetId) –

The fleet ID of the fleet that contains the volume.
volume_id (VolumeId) –

The volume ID of the volume to retrieve.

Raises:

AccessDeniedException –

You don't have permission to perform the action.
InternalServerErrorException –

Deadline Cloud can't process your request right now. Try again later.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a request rate quota.
ValidationException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

Get a volume

>>> await client.get_volume(farm_id='farm-1234567890abcdef1234567890abcdef', fleet_id='fleet-1234567890abcdef1234567890abcdef', volume_id='volume-1234567890abcdef1234567890abcdef')

Source code in docs_src/capo_deadline/_services/async_deadline.py

async def get_volume(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    fleet_id: "capo_deadline.types.fleet_id.FleetId",
    volume_id: "capo_deadline.types.volume_id.VolumeId",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> "capo_deadline.types.get_volume_response.GetVolumeResponse":
    """<p>Gets a persistent volume.</p>

    Args:
        farm_id: <p>The farm ID of the farm that contains the fleet.</p>
        fleet_id: <p>The fleet ID of the fleet that contains the volume.</p>
        volume_id: <p>The volume ID of the volume to retrieve.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get a volume

        >>> await client.get_volume(farm_id='farm-1234567890abcdef1234567890abcdef', fleet_id='fleet-1234567890abcdef1234567890abcdef', volume_id='volume-1234567890abcdef1234567890abcdef')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_deadline.types.get_volume_request.GetVolumeRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.get_volume_response.GetVolumeResponse"
    ]:
        import capo_deadline._operations.deadline.get_volume

        (
            output,
            http_response,
        ) = await capo_deadline._operations.deadline.get_volume.async_get_volume(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetVolume")
    )
    input_: capo_deadline.types.get_volume_request.GetVolumeRequest = {
        "farm_id": farm_id,
        "fleet_id": fleet_id,
        "volume_id": volume_id,
    }

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

get_volume async ¶

get_volume `async` ¶