aws-sdk-pi 1.101.0

AWS SDK for AWS Performance Insights
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_performance_analysis_report::_get_performance_analysis_report_input::GetPerformanceAnalysisReportInputBuilder;

pub use crate::operation::get_performance_analysis_report::_get_performance_analysis_report_output::GetPerformanceAnalysisReportOutputBuilder;

impl crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.get_performance_analysis_report();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `GetPerformanceAnalysisReport`.
///
/// <p>Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be <code>RUNNING</code>, <code>SUCCEEDED</code>, or <code>FAILED</code>. The insights include the <code>description</code> and <code>recommendation</code> fields.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetPerformanceAnalysisReportFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportOutput,
        crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportError,
    > for GetPerformanceAnalysisReportFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportOutput,
            crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl GetPerformanceAnalysisReportFluentBuilder {
    /// Creates a new `GetPerformanceAnalysisReportFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the GetPerformanceAnalysisReport as a reference.
    pub fn as_input(&self) -> &crate::operation::get_performance_analysis_report::builders::GetPerformanceAnalysisReportInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReport::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReport::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportOutput,
        crate::operation::get_performance_analysis_report::GetPerformanceAnalysisReportError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>
    pub fn service_type(mut self, input: crate::types::ServiceType) -> Self {
        self.inner = self.inner.service_type(input);
        self
    }
    /// <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>
    pub fn set_service_type(mut self, input: ::std::option::Option<crate::types::ServiceType>) -> Self {
        self.inner = self.inner.set_service_type(input);
        self
    }
    /// <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>
    pub fn get_service_type(&self) -> &::std::option::Option<crate::types::ServiceType> {
        self.inner.get_service_type()
    }
    /// <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>
    pub fn identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.identifier(input.into());
        self
    }
    /// <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>
    pub fn set_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_identifier(input);
        self
    }
    /// <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>
    pub fn get_identifier(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_identifier()
    }
    /// <p>A unique identifier of the created analysis report. For example, <code>report-12345678901234567</code></p>
    pub fn analysis_report_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.analysis_report_id(input.into());
        self
    }
    /// <p>A unique identifier of the created analysis report. For example, <code>report-12345678901234567</code></p>
    pub fn set_analysis_report_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_analysis_report_id(input);
        self
    }
    /// <p>A unique identifier of the created analysis report. For example, <code>report-12345678901234567</code></p>
    pub fn get_analysis_report_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_analysis_report_id()
    }
    /// <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>
    pub fn text_format(mut self, input: crate::types::TextFormat) -> Self {
        self.inner = self.inner.text_format(input);
        self
    }
    /// <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>
    pub fn set_text_format(mut self, input: ::std::option::Option<crate::types::TextFormat>) -> Self {
        self.inner = self.inner.set_text_format(input);
        self
    }
    /// <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>
    pub fn get_text_format(&self) -> &::std::option::Option<crate::types::TextFormat> {
        self.inner.get_text_format()
    }
    /// <p>The text language in the report. The default language is <code>EN_US</code> (English).</p>
    pub fn accept_language(mut self, input: crate::types::AcceptLanguage) -> Self {
        self.inner = self.inner.accept_language(input);
        self
    }
    /// <p>The text language in the report. The default language is <code>EN_US</code> (English).</p>
    pub fn set_accept_language(mut self, input: ::std::option::Option<crate::types::AcceptLanguage>) -> Self {
        self.inner = self.inner.set_accept_language(input);
        self
    }
    /// <p>The text language in the report. The default language is <code>EN_US</code> (English).</p>
    pub fn get_accept_language(&self) -> &::std::option::Option<crate::types::AcceptLanguage> {
        self.inner.get_accept_language()
    }
}