describe_vtl_devices ¶

def describe_vtl_devices(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
    vtl_device_ar_ns: Optional[
        "capo_storage_gateway.types.vtl_device_ar_ns.VTLDeviceARNs"
    ] = None,
    marker: Optional["capo_storage_gateway.types.marker.Marker"] = None,
    limit: Optional[
        "capo_storage_gateway.types.positive_int_object.PositiveIntObject"
    ] = None,
) -> "capo_storage_gateway.types.describe_vtl_devices_output.DescribeVTLDevicesOutput":
    """<p>Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.</p> <p>This operation is only supported in the tape gateway type.</p>

    Args:
        vtl_device_ar_ns: <p>An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.</p> <note> <p>All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.</p> </note>
        marker: <p>An opaque string that indicates the position at which to begin describing the VTL devices.</p>
        limit: <p>Specifies that the number of VTL devices described be limited to the specified number.</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 virtual tape library (VTL) devices of a single gateway
        Returns a description of virtual tape library (VTL) devices for the specified gateway.

        >>> client.describe_vtl_devices(gateway_arn='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B', vtl_device_ar_ns=[], marker='1', limit=123)
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.describe_vtl_devices_input.DescribeVTLDevicesInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.describe_vtl_devices_output.DescribeVTLDevicesOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_vtl_devices

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeVTLDevices")
    )
    input_: capo_storage_gateway.types.describe_vtl_devices_input.DescribeVTLDevicesInput = {
        "gateway_arn": gateway_arn
    }
    if vtl_device_ar_ns is not None:
        input_["vtl_device_ar_ns"] = vtl_device_ar_ns
    if marker is not None:
        input_["marker"] = marker
    if limit is not None:
        input_["limit"] = limit

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