aws_sdk_pi/client/

get_performance_analysis_report.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetPerformanceAnalysisReport`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`service_type(ServiceType)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::service_type) / [`set_service_type(Option<ServiceType>)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::set_service_type):<br>required: **true**<br><p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p><br>
    ///   - [`identifier(impl Into<String>)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::set_identifier):<br>required: **true**<br><p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p> <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p><br>
    ///   - [`analysis_report_id(impl Into<String>)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::analysis_report_id) / [`set_analysis_report_id(Option<String>)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::set_analysis_report_id):<br>required: **true**<br><p>A unique identifier of the created analysis report. For example, <code>report-12345678901234567</code></p><br>
    ///   - [`text_format(TextFormat)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::text_format) / [`set_text_format(Option<TextFormat>)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::set_text_format):<br>required: **false**<br><p>Indicates the text format in the report. The options are <code>PLAIN_TEXT</code> or <code>MARKDOWN</code>. The default value is <code>plain text</code>.</p><br>
    ///   - [`accept_language(AcceptLanguage)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::accept_language) / [`set_accept_language(Option<AcceptLanguage>)`](crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::set_accept_language):<br>required: **false**<br><p>The text language in the report. The default language is <code>EN_US</code> (English).</p><br>
    /// - On success, responds with [`GetPerformanceAnalysisReportOutput`](crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportOutput) with field(s):
    ///   - [`analysis_report(Option<AnalysisReport>)`](crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportOutput::analysis_report): <p>The summary of the performance analysis report created for a time period.</p>
    /// - On failure, responds with [`SdkError<GetPerformanceAnalysisReportError>`](crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportError)
    pub fn get_performance_analysis_report(
        &self,
    ) -> crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder {
        crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportFluentBuilder::new(self.handle.clone())
    }
}