Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.
Parameters:
-
cache_report_arn
(CacheReportARN)
–
The Amazon Resource Name (ARN) of the cache report you want to cancel.
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 cancel_cache_report(
self,
cache_report_arn: "capo_storage_gateway.types.cache_report_arn.CacheReportARN",
*,
config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> (
"capo_storage_gateway.types.cancel_cache_report_output.CancelCacheReportOutput"
):
"""<p>Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.</p>
Args:
cache_report_arn: <p>The Amazon Resource Name (ARN) of the cache report you want to cancel.</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.cancel_cache_report_input.CancelCacheReportInput]",
) -> OperationResponse[
"capo_storage_gateway.types.cancel_cache_report_output.CancelCacheReportOutput"
]:
import capo_storage_gateway._operations.storage_gateway_20130630.cancel_cache_report
output, http_response = (
capo_storage_gateway._operations.storage_gateway_20130630.cancel_cache_report.cancel_cache_report(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CancelCacheReport")
)
input_: capo_storage_gateway.types.cancel_cache_report_input.CancelCacheReportInput = {
"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
|