delete_tape_archive ¶

def delete_tape_archive(
    self,
    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_archive_output.DeleteTapeArchiveOutput"
):
    """<p>Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.</p>

    Args:
        tape_arn: <p>The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).</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 from the shelf (VTS)
        Deletes the specified virtual tape from the virtual tape shelf (VTS).

        >>> client.delete_tape_archive(tape_arn='arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0')
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.delete_tape_archive_input.DeleteTapeArchiveInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.delete_tape_archive_output.DeleteTapeArchiveOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.delete_tape_archive

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTapeArchive")
    )
    input_: capo_storage_gateway.types.delete_tape_archive_input.DeleteTapeArchiveInput = {
        "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