aws_sdk_redshift/client/
modify_usage_limit.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ModifyUsageLimit`](crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`usage_limit_id(impl Into<String>)`](crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder::usage_limit_id) / [`set_usage_limit_id(Option<String>)`](crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder::set_usage_limit_id):<br>required: **true**<br><p>The identifier of the usage limit to modify.</p><br>
7    ///   - [`amount(i64)`](crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder::amount) / [`set_amount(Option<i64>)`](crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder::set_amount):<br>required: **false**<br><p>The new limit amount. For more information about this parameter, see <code>UsageLimit</code>.</p><br>
8    ///   - [`breach_action(UsageLimitBreachAction)`](crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder::breach_action) / [`set_breach_action(Option<UsageLimitBreachAction>)`](crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder::set_breach_action):<br>required: **false**<br><p>The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see <code>UsageLimit</code>.</p><br>
9    /// - On success, responds with [`ModifyUsageLimitOutput`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput) with field(s):
10    ///   - [`usage_limit_id(Option<String>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::usage_limit_id): <p>The identifier of the usage limit.</p>
11    ///   - [`cluster_identifier(Option<String>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::cluster_identifier): <p>The identifier of the cluster with a usage limit.</p>
12    ///   - [`feature_type(Option<UsageLimitFeatureType>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::feature_type): <p>The Amazon Redshift feature to which the limit applies.</p>
13    ///   - [`limit_type(Option<UsageLimitLimitType>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::limit_type): <p>The type of limit. Depending on the feature type, this can be based on a time duration or data size.</p>
14    ///   - [`amount(Option<i64>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::amount): <p>The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).</p>
15    ///   - [`period(Option<UsageLimitPeriod>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::period): <p>The time period that the amount applies to. A <code>weekly</code> period begins on Sunday. The default is <code>monthly</code>.</p>
16    ///   - [`breach_action(Option<UsageLimitBreachAction>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::breach_action): <p>The action that Amazon Redshift takes when the limit is reached. Possible values are:</p> <ul>  <li>   <p><b>log</b> - To log an event in a system table. The default is log.</p></li>  <li>   <p><b>emit-metric</b> - To emit CloudWatch metrics.</p></li>  <li>   <p><b>disable</b> - To disable the feature until the next usage period begins.</p></li> </ul>
17    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::modify_usage_limit::ModifyUsageLimitOutput::tags): <p>A list of tag instances.</p>
18    /// - On failure, responds with [`SdkError<ModifyUsageLimitError>`](crate::operation::modify_usage_limit::ModifyUsageLimitError)
19    pub fn modify_usage_limit(&self) -> crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder {
20        crate::operation::modify_usage_limit::builders::ModifyUsageLimitFluentBuilder::new(self.handle.clone())
21    }
22}