aws_sdk_apigateway/client/get_usage_plans.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 [`GetUsagePlans`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`position(impl Into<String>)`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::position) / [`set_position(Option<String>)`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::set_position):<br>required: **false**<br><p>The current pagination position in the paged result set.</p><br>
8 /// - [`key_id(impl Into<String>)`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::key_id) / [`set_key_id(Option<String>)`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::set_key_id):<br>required: **false**<br><p>The identifier of the API key associated with the usage plans.</p><br>
9 /// - [`limit(i32)`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p><br>
10 /// - On success, responds with [`GetUsagePlansOutput`](crate::operation::get_usage_plans::GetUsagePlansOutput) with field(s):
11 /// - [`items(Option<Vec::<UsagePlan>>)`](crate::operation::get_usage_plans::GetUsagePlansOutput::items): <p>The current page of elements from this collection.</p>
12 /// - [`position(Option<String>)`](crate::operation::get_usage_plans::GetUsagePlansOutput::position): <p>The current pagination position in the paged result set.</p>
13 /// - On failure, responds with [`SdkError<GetUsagePlansError>`](crate::operation::get_usage_plans::GetUsagePlansError)
14 pub fn get_usage_plans(&self) -> crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder {
15 crate::operation::get_usage_plans::builders::GetUsagePlansFluentBuilder::new(self.handle.clone())
16 }
17}