list_volume_initiators ¶

list_volume_initiators(
    volume_arn: VolumeARN,
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> ListVolumeInitiatorsOutput

Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

Parameters:

volume_arn (VolumeARN) –

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.

Raises:

InternalServerError –

An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException –

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
UnknownServiceError –

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

Source code in docs_src/capo_storage_gateway/_services/storage_gateway.py

def list_volume_initiators(
    self,
    volume_arn: "capo_storage_gateway.types.volume_arn.VolumeARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.list_volume_initiators_output.ListVolumeInitiatorsOutput":
    """<p>Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.</p>

    Args:
        volume_arn: <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes for the gateway.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.list_volume_initiators_input.ListVolumeInitiatorsInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.list_volume_initiators_output.ListVolumeInitiatorsOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.list_volume_initiators

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.list_volume_initiators.list_volume_initiators(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVolumeInitiators")
    )
    input_: capo_storage_gateway.types.list_volume_initiators_input.ListVolumeInitiatorsInput = {
        "volume_arn": volume_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output