list_cache_reports ¶

list_cache_reports(
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
    marker: Optional[Marker] = None,
) -> ListCacheReportsOutput

Returns a list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the DescribeCacheReport action, such as report name, status, completion progress, start time, end time, filters, and tags.

Parameters:

marker (Optional[Marker], default: None ) –

Opaque pagination token returned from a previous ListCacheReports operation. If present, Marker specifies where to continue the list from after a previous call to ListCacheReports. Optional.

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 list_cache_reports(
    self,
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
    marker: Optional["capo_storage_gateway.types.marker.Marker"] = None,
) -> "capo_storage_gateway.types.list_cache_reports_output.ListCacheReportsOutput":
    """<p>Returns a list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the <code>DescribeCacheReport</code> action, such as report name, status, completion progress, start time, end time, filters, and tags.</p>

    Args:
        marker: <p>Opaque pagination token returned from a previous <code>ListCacheReports</code> operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to <code>ListCacheReports</code>. Optional.</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.list_cache_reports_input.ListCacheReportsInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.list_cache_reports_output.ListCacheReportsOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.list_cache_reports

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCacheReports")
    )
    input_: capo_storage_gateway.types.list_cache_reports_input.ListCacheReportsInput = {}
    if marker is not None:
        input_["marker"] = marker

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