aws_sdk_apigateway/client/
update_usage_plan.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 [`UpdateUsagePlan`](crate::operation::update_usage_plan::builders::UpdateUsagePlanFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`usage_plan_id(impl Into<String>)`](crate::operation::update_usage_plan::builders::UpdateUsagePlanFluentBuilder::usage_plan_id) / [`set_usage_plan_id(Option<String>)`](crate::operation::update_usage_plan::builders::UpdateUsagePlanFluentBuilder::set_usage_plan_id):<br>required: **true**<br><p>The Id of the to-be-updated usage plan.</p><br>
7    ///   - [`patch_operations(PatchOperation)`](crate::operation::update_usage_plan::builders::UpdateUsagePlanFluentBuilder::patch_operations) / [`set_patch_operations(Option<Vec::<PatchOperation>>)`](crate::operation::update_usage_plan::builders::UpdateUsagePlanFluentBuilder::set_patch_operations):<br>required: **false**<br><p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p><br>
8    /// - On success, responds with [`UpdateUsagePlanOutput`](crate::operation::update_usage_plan::UpdateUsagePlanOutput) with field(s):
9    ///   - [`id(Option<String>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::id): <p>The identifier of a UsagePlan resource.</p>
10    ///   - [`name(Option<String>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::name): <p>The name of a usage plan.</p>
11    ///   - [`description(Option<String>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::description): <p>The description of a usage plan.</p>
12    ///   - [`api_stages(Option<Vec::<ApiStage>>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::api_stages): <p>The associated API stages of a usage plan.</p>
13    ///   - [`throttle(Option<ThrottleSettings>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::throttle): <p>A map containing method level throttling information for API stage in a usage plan.</p>
14    ///   - [`quota(Option<QuotaSettings>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::quota): <p>The target maximum number of permitted requests per a given unit time interval.</p>
15    ///   - [`product_code(Option<String>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::product_code): <p>The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.</p>
16    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::update_usage_plan::UpdateUsagePlanOutput::tags): <p>The collection of tags. Each tag element is associated with a given resource.</p>
17    /// - On failure, responds with [`SdkError<UpdateUsagePlanError>`](crate::operation::update_usage_plan::UpdateUsagePlanError)
18    pub fn update_usage_plan(&self) -> crate::operation::update_usage_plan::builders::UpdateUsagePlanFluentBuilder {
19        crate::operation::update_usage_plan::builders::UpdateUsagePlanFluentBuilder::new(self.handle.clone())
20    }
21}