aws_sdk_apigateway/client/
get_api_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 [`GetApiKey`](crate::operation::get_api_key::builders::GetApiKeyFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`api_key(impl Into<String>)`](crate::operation::get_api_key::builders::GetApiKeyFluentBuilder::api_key) / [`set_api_key(Option<String>)`](crate::operation::get_api_key::builders::GetApiKeyFluentBuilder::set_api_key):<br>required: **true**<br><p>The identifier of the ApiKey resource.</p><br>
7    ///   - [`include_value(bool)`](crate::operation::get_api_key::builders::GetApiKeyFluentBuilder::include_value) / [`set_include_value(Option<bool>)`](crate::operation::get_api_key::builders::GetApiKeyFluentBuilder::set_include_value):<br>required: **false**<br><p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains the key value.</p><br>
8    /// - On success, responds with [`GetApiKeyOutput`](crate::operation::get_api_key::GetApiKeyOutput) with field(s):
9    ///   - [`id(Option<String>)`](crate::operation::get_api_key::GetApiKeyOutput::id): <p>The identifier of the API Key.</p>
10    ///   - [`value(Option<String>)`](crate::operation::get_api_key::GetApiKeyOutput::value): <p>The value of the API Key.</p>
11    ///   - [`name(Option<String>)`](crate::operation::get_api_key::GetApiKeyOutput::name): <p>The name of the API Key.</p>
12    ///   - [`customer_id(Option<String>)`](crate::operation::get_api_key::GetApiKeyOutput::customer_id): <p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p>
13    ///   - [`description(Option<String>)`](crate::operation::get_api_key::GetApiKeyOutput::description): <p>The description of the API Key.</p>
14    ///   - [`enabled(bool)`](crate::operation::get_api_key::GetApiKeyOutput::enabled): <p>Specifies whether the API Key can be used by callers.</p>
15    ///   - [`created_date(Option<DateTime>)`](crate::operation::get_api_key::GetApiKeyOutput::created_date): <p>The timestamp when the API Key was created.</p>
16    ///   - [`last_updated_date(Option<DateTime>)`](crate::operation::get_api_key::GetApiKeyOutput::last_updated_date): <p>The timestamp when the API Key was last updated.</p>
17    ///   - [`stage_keys(Option<Vec::<String>>)`](crate::operation::get_api_key::GetApiKeyOutput::stage_keys): <p>A list of Stage resources that are associated with the ApiKey resource.</p>
18    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_api_key::GetApiKeyOutput::tags): <p>The collection of tags. Each tag element is associated with a given resource.</p>
19    /// - On failure, responds with [`SdkError<GetApiKeyError>`](crate::operation::get_api_key::GetApiKeyError)
20    pub fn get_api_key(&self) -> crate::operation::get_api_key::builders::GetApiKeyFluentBuilder {
21        crate::operation::get_api_key::builders::GetApiKeyFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_apigateway/client/get_api_key.rs

aws_sdk_apigateway/client/
get_api_key.rs
