aws_sdk_apigateway/client/
get_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 [`GetUsagePlan`](crate::operation::get_usage_plan::builders::GetUsagePlanFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`usage_plan_id(impl Into<String>)`](crate::operation::get_usage_plan::builders::GetUsagePlanFluentBuilder::usage_plan_id) / [`set_usage_plan_id(Option<String>)`](crate::operation::get_usage_plan::builders::GetUsagePlanFluentBuilder::set_usage_plan_id):<br>required: **true**<br><p>The identifier of the UsagePlan resource to be retrieved.</p><br>
7    /// - On success, responds with [`GetUsagePlanOutput`](crate::operation::get_usage_plan::GetUsagePlanOutput) with field(s):
8    ///   - [`id(Option<String>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::id): <p>The identifier of a UsagePlan resource.</p>
9    ///   - [`name(Option<String>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::name): <p>The name of a usage plan.</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::description): <p>The description of a usage plan.</p>
11    ///   - [`api_stages(Option<Vec::<ApiStage>>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::api_stages): <p>The associated API stages of a usage plan.</p>
12    ///   - [`throttle(Option<ThrottleSettings>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::throttle): <p>A map containing method level throttling information for API stage in a usage plan.</p>
13    ///   - [`quota(Option<QuotaSettings>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::quota): <p>The target maximum number of permitted requests per a given unit time interval.</p>
14    ///   - [`product_code(Option<String>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::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>
15    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_usage_plan::GetUsagePlanOutput::tags): <p>The collection of tags. Each tag element is associated with a given resource.</p>
16    /// - On failure, responds with [`SdkError<GetUsagePlanError>`](crate::operation::get_usage_plan::GetUsagePlanError)
17    pub fn get_usage_plan(&self) -> crate::operation::get_usage_plan::builders::GetUsagePlanFluentBuilder {
18        crate::operation::get_usage_plan::builders::GetUsagePlanFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_apigateway/client/get_usage_plan.rs

aws_sdk_apigateway/client/
get_usage_plan.rs
