Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
-
next_token
(Optional[string], default:
None
)
–
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Raises:
Source code in docs_src/capo_backup/_services/backup.py
| def list_report_plans(
self,
*,
config_overrides: Optional[BackupClientConfig] = None,
max_results: Optional["capo_backup.types.max_results.MaxResults"] = None,
next_token: Optional["capo_backup.types.string.string"] = None,
) -> "capo_backup.types.list_report_plans_output.ListReportPlansOutput":
"""<p>Returns a list of your report plans. For detailed information about a single report plan, use <code>DescribeReportPlan</code>.</p>
Args:
max_results: <p>The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.</p>
next_token: <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
Raises:
capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_backup.types.list_report_plans_input.ListReportPlansInput]",
) -> OperationResponse[
"capo_backup.types.list_report_plans_output.ListReportPlansOutput"
]:
import capo_backup._operations.cryo_controller_user_manager.list_report_plans
output, http_response = (
capo_backup._operations.cryo_controller_user_manager.list_report_plans.list_report_plans(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListReportPlans")
)
input_: capo_backup.types.list_report_plans_input.ListReportPlansInput = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|