Skip to content

describe_cachedi_scsi_volumes

describe_cachedi_scsi_volumes(
    volume_ar_ns: VolumeARNs,
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> DescribeCachediSCSIVolumesOutput

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

Parameters:

  • volume_ar_ns (VolumeARNs) –

    An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a 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.

Examples:

To describe gateway cached iSCSI volumes Returns a description of the gateway cached iSCSI volumes specified in the request.

>>> client.describe_cachedi_scsi_volumes(volume_ar_ns=['arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB'])
Source code in docs_src/capo_storage_gateway/_services/storage_gateway.py
def describe_cachedi_scsi_volumes(
    self,
    volume_ar_ns: "capo_storage_gateway.types.volume_ar_ns.VolumeARNs",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_cachedi_scsi_volumes_output.DescribeCachediSCSIVolumesOutput":
    """<p>Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.</p> <p>The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).</p>

    Args:
        volume_ar_ns: <p>An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a 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.

    Examples:
        To describe gateway cached iSCSI volumes
        Returns a description of the gateway cached iSCSI volumes specified in the request.

        >>> client.describe_cachedi_scsi_volumes(volume_ar_ns=['arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB'])
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.describe_cachedi_scsi_volumes_input.DescribeCachediSCSIVolumesInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.describe_cachedi_scsi_volumes_output.DescribeCachediSCSIVolumesOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_cachedi_scsi_volumes

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCachediSCSIVolumes")
    )
    input_: capo_storage_gateway.types.describe_cachedi_scsi_volumes_input.DescribeCachediSCSIVolumesInput = {
        "volume_ar_ns": volume_ar_ns
    }

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