delete_tape ¶

def delete_tape(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    tape_arn: "capo_storage_gateway.types.tape_arn.TapeARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
    bypass_governance_retention: Optional[
        "capo_storage_gateway.types.boolean2.Boolean2"
    ] = None,
) -> "capo_storage_gateway.types.delete_tape_output.DeleteTapeOutput":
    """<p>Deletes the specified virtual tape. This operation is only supported in the tape gateway type.</p>

    Args:
        gateway_arn: <p>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.</p>
        tape_arn: <p>The Amazon Resource Name (ARN) of the virtual tape to delete.</p>
        bypass_governance_retention: <p>Set to <code>TRUE</code> to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to <code>governance</code> can be deleted. Archived tapes with tape retention lock set to <code>compliance</code> can't be deleted.</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 delete a virtual tape
        This example deletes the specified virtual tape.

        >>> client.delete_tape(gateway_arn='arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B', tape_arn='arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0')
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.delete_tape_input.DeleteTapeInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.delete_tape_output.DeleteTapeOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.delete_tape

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTape")
    )
    input_: capo_storage_gateway.types.delete_tape_input.DeleteTapeInput = {
        "gateway_arn": gateway_arn,
        "tape_arn": tape_arn,
    }
    if bypass_governance_retention is not None:
        input_["bypass_governance_retention"] = bypass_governance_retention

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