aws_sdk_backup/client/

create_report_plan.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateReportPlan`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`report_plan_name(impl Into<String>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::report_plan_name) / [`set_report_plan_name(Option<String>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::set_report_plan_name):<br>required: **true**<br><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><br>
    ///   - [`report_plan_description(impl Into<String>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::report_plan_description) / [`set_report_plan_description(Option<String>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::set_report_plan_description):<br>required: **false**<br><p>An optional description of the report plan with a maximum of 1,024 characters.</p><br>
    ///   - [`report_delivery_channel(ReportDeliveryChannel)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::report_delivery_channel) / [`set_report_delivery_channel(Option<ReportDeliveryChannel>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::set_report_delivery_channel):<br>required: **true**<br><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><br>
    ///   - [`report_setting(ReportSetting)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::report_setting) / [`set_report_setting(Option<ReportSetting>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::set_report_setting):<br>required: **true**<br><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</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><br>
    ///   - [`report_plan_tags(impl Into<String>, impl Into<String>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::report_plan_tags) / [`set_report_plan_tags(Option<HashMap::<String, String>>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::set_report_plan_tags):<br>required: **false**<br><p>The tags to assign to the report plan.</p><br>
    ///   - [`idempotency_token(impl Into<String>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::idempotency_token) / [`set_idempotency_token(Option<String>)`](crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::set_idempotency_token):<br>required: **false**<br><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><br>
    /// - On success, responds with [`CreateReportPlanOutput`](crate::operation::create_report_plan::CreateReportPlanOutput) with field(s):
    ///   - [`report_plan_name(Option<String>)`](crate::operation::create_report_plan::CreateReportPlanOutput::report_plan_name): <p>The unique name of the report plan.</p>
    ///   - [`report_plan_arn(Option<String>)`](crate::operation::create_report_plan::CreateReportPlanOutput::report_plan_arn): <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::create_report_plan::CreateReportPlanOutput::creation_time): <p>The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    /// - On failure, responds with [`SdkError<CreateReportPlanError>`](crate::operation::create_report_plan::CreateReportPlanError)
    pub fn create_report_plan(&self) -> crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder {
        crate::operation::create_report_plan::builders::CreateReportPlanFluentBuilder::new(self.handle.clone())
    }
}