create_report_plan async ¶

async def create_report_plan(
    self,
    report_plan_name: "capo_backup.types.report_plan_name.ReportPlanName",
    report_delivery_channel: "capo_backup.types.report_delivery_channel.ReportDeliveryChannel",
    report_setting: "capo_backup.types.report_setting.ReportSetting",
    *,
    config_overrides: Optional[AsyncBackupClientConfig] = None,
    report_plan_description: Optional[
        "capo_backup.types.report_plan_description.ReportPlanDescription"
    ] = None,
    report_plan_tags: Optional["capo_backup.types.string_map.stringMap"] = None,
    idempotency_token: Optional["capo_backup.types.string.string"] = None,
) -> "capo_backup.types.create_report_plan_output.CreateReportPlanOutput":
    """<p>Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.</p> <p>If you call <code>CreateReportPlan</code> with a plan that already exists, you receive an <code>AlreadyExistsException</code> exception.</p>

    Args:
        report_plan_name: <p>The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
        report_plan_description: <p>An optional description of the report plan with a maximum of 1,024 characters.</p>
        report_delivery_channel: <p>A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.</p>
        report_setting: <p>Identifies the report template for the report. Reports are built using a report template. The report templates are:</p> <p> <code>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT </code> </p> <p>If the report template is <code>RESOURCE_COMPLIANCE_REPORT</code> or <code>CONTROL_COMPLIANCE_REPORT</code>, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.</p>
        report_plan_tags: <p>The tags to assign to the report plan.</p>
        idempotency_token: <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>

    Raises:
        capo_backup.errors.already_exists_exception.AlreadyExistsException: <p>The required resource already exists.</p>
        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.limit_exceeded_exception.LimitExceededException: <p>A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_backup.types.create_report_plan_input.CreateReportPlanInput]",
    ) -> AsyncOperationResponse[
        "capo_backup.types.create_report_plan_output.CreateReportPlanOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.create_report_plan

        (
            output,
            http_response,
        ) = await capo_backup._operations.cryo_controller_user_manager.create_report_plan.async_create_report_plan(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateReportPlan")
    )
    input_: capo_backup.types.create_report_plan_input.CreateReportPlanInput = {
        "report_plan_name": report_plan_name,
        "report_delivery_channel": report_delivery_channel,
        "report_setting": report_setting,
    }
    if report_plan_description is not None:
        input_["report_plan_description"] = report_plan_description
    if report_plan_tags is not None:
        input_["report_plan_tags"] = report_plan_tags
    if idempotency_token is None:
        idempotency_token = str(uuid.uuid4())
    input_["idempotency_token"] = idempotency_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output