Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report.
DeleteCacheReport does not delete the report object from your Amazon S3 bucket.
Parameters:
-
cache_report_arn
(CacheReportARN)
–
The Amazon Resource Name (ARN) of the cache report you want to delete.
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 delete_cache_report(
self,
cache_report_arn: "capo_storage_gateway.types.cache_report_arn.CacheReportARN",
*,
config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> (
"capo_storage_gateway.types.delete_cache_report_output.DeleteCacheReportOutput"
):
"""<p>Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use <code>CancelCacheReport</code> to cancel an IN-PROGRESS report.</p> <note> <p> <code>DeleteCacheReport</code> does not delete the report object from your Amazon S3 bucket.</p> </note>
Args:
cache_report_arn: <p>The Amazon Resource Name (ARN) of the cache report you want to delete.</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.delete_cache_report_input.DeleteCacheReportInput]",
) -> OperationResponse[
"capo_storage_gateway.types.delete_cache_report_output.DeleteCacheReportOutput"
]:
import capo_storage_gateway._operations.storage_gateway_20130630.delete_cache_report
output, http_response = (
capo_storage_gateway._operations.storage_gateway_20130630.delete_cache_report.delete_cache_report(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteCacheReport")
)
input_: capo_storage_gateway.types.delete_cache_report_input.DeleteCacheReportInput = {
"cache_report_arn": cache_report_arn
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|