aws_sdk_apigateway/client/get_usage_plan_key.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 [`GetUsagePlanKey`](crate::operation::get_usage_plan_key::builders::GetUsagePlanKeyFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`usage_plan_id(impl Into<String>)`](crate::operation::get_usage_plan_key::builders::GetUsagePlanKeyFluentBuilder::usage_plan_id) / [`set_usage_plan_id(Option<String>)`](crate::operation::get_usage_plan_key::builders::GetUsagePlanKeyFluentBuilder::set_usage_plan_id):<br>required: **true**<br><p>The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.</p><br>
7 /// - [`key_id(impl Into<String>)`](crate::operation::get_usage_plan_key::builders::GetUsagePlanKeyFluentBuilder::key_id) / [`set_key_id(Option<String>)`](crate::operation::get_usage_plan_key::builders::GetUsagePlanKeyFluentBuilder::set_key_id):<br>required: **true**<br><p>The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.</p><br>
8 /// - On success, responds with [`GetUsagePlanKeyOutput`](crate::operation::get_usage_plan_key::GetUsagePlanKeyOutput) with field(s):
9 /// - [`id(Option<String>)`](crate::operation::get_usage_plan_key::GetUsagePlanKeyOutput::id): <p>The Id of a usage plan key.</p>
10 /// - [`r#type(Option<String>)`](crate::operation::get_usage_plan_key::GetUsagePlanKeyOutput::type): <p>The type of a usage plan key. Currently, the valid key type is <code>API_KEY</code>.</p>
11 /// - [`value(Option<String>)`](crate::operation::get_usage_plan_key::GetUsagePlanKeyOutput::value): <p>The value of a usage plan key.</p>
12 /// - [`name(Option<String>)`](crate::operation::get_usage_plan_key::GetUsagePlanKeyOutput::name): <p>The name of a usage plan key.</p>
13 /// - On failure, responds with [`SdkError<GetUsagePlanKeyError>`](crate::operation::get_usage_plan_key::GetUsagePlanKeyError)
14 pub fn get_usage_plan_key(&self) -> crate::operation::get_usage_plan_key::builders::GetUsagePlanKeyFluentBuilder {
15 crate::operation::get_usage_plan_key::builders::GetUsagePlanKeyFluentBuilder::new(self.handle.clone())
16 }
17}