Skip to content

describe_report_plan

describe_report_plan(
    report_plan_name: ReportPlanName,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> DescribeReportPlanOutput

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Parameters:

  • report_plan_name (ReportPlanName) –

    The unique name of a report plan.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def describe_report_plan(
    self,
    report_plan_name: "capo_backup.types.report_plan_name.ReportPlanName",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> "capo_backup.types.describe_report_plan_output.DescribeReportPlanOutput":
    """<p>Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.</p>

    Args:
        report_plan_name: <p>The unique name of a report plan.</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.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</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.describe_report_plan_input.DescribeReportPlanInput]",
    ) -> OperationResponse[
        "capo_backup.types.describe_report_plan_output.DescribeReportPlanOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.describe_report_plan

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.describe_report_plan.describe_report_plan(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReportPlan")
    )
    input_: capo_backup.types.describe_report_plan_input.DescribeReportPlanInput = {
        "report_plan_name": report_plan_name
    }

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