aws_sdk_apigateway/client/
create_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 [`CreateApiKey`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_name):<br>required: **false**<br><p>The name of the ApiKey.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_description):<br>required: **false**<br><p>The description of the ApiKey.</p><br>
8    ///   - [`enabled(bool)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::enabled) / [`set_enabled(Option<bool>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_enabled):<br>required: **false**<br><p>Specifies whether the ApiKey can be used by callers.</p><br>
9    ///   - [`generate_distinct_id(bool)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::generate_distinct_id) / [`set_generate_distinct_id(Option<bool>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_generate_distinct_id):<br>required: **false**<br><p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.</p><br>
10    ///   - [`value(impl Into<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::value) / [`set_value(Option<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_value):<br>required: **false**<br><p>Specifies a value of the API key.</p><br>
11    ///   - [`stage_keys(StageKey)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::stage_keys) / [`set_stage_keys(Option<Vec::<StageKey>>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_stage_keys):<br>required: **false**<br><p>DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.</p><br>
12    ///   - [`customer_id(impl Into<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::customer_id) / [`set_customer_id(Option<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_customer_id):<br>required: **false**<br><p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p><br>
13    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::set_tags):<br>required: **false**<br><p>The key-value map of strings. The valid character set is \[a-zA-Z+-=._:/\]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.</p><br>
14    /// - On success, responds with [`CreateApiKeyOutput`](crate::operation::create_api_key::CreateApiKeyOutput) with field(s):
15    ///   - [`id(Option<String>)`](crate::operation::create_api_key::CreateApiKeyOutput::id): <p>The identifier of the API Key.</p>
16    ///   - [`value(Option<String>)`](crate::operation::create_api_key::CreateApiKeyOutput::value): <p>The value of the API Key.</p>
17    ///   - [`name(Option<String>)`](crate::operation::create_api_key::CreateApiKeyOutput::name): <p>The name of the API Key.</p>
18    ///   - [`customer_id(Option<String>)`](crate::operation::create_api_key::CreateApiKeyOutput::customer_id): <p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p>
19    ///   - [`description(Option<String>)`](crate::operation::create_api_key::CreateApiKeyOutput::description): <p>The description of the API Key.</p>
20    ///   - [`enabled(bool)`](crate::operation::create_api_key::CreateApiKeyOutput::enabled): <p>Specifies whether the API Key can be used by callers.</p>
21    ///   - [`created_date(Option<DateTime>)`](crate::operation::create_api_key::CreateApiKeyOutput::created_date): <p>The timestamp when the API Key was created.</p>
22    ///   - [`last_updated_date(Option<DateTime>)`](crate::operation::create_api_key::CreateApiKeyOutput::last_updated_date): <p>The timestamp when the API Key was last updated.</p>
23    ///   - [`stage_keys(Option<Vec::<String>>)`](crate::operation::create_api_key::CreateApiKeyOutput::stage_keys): <p>A list of Stage resources that are associated with the ApiKey resource.</p>
24    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_api_key::CreateApiKeyOutput::tags): <p>The collection of tags. Each tag element is associated with a given resource.</p>
25    /// - On failure, responds with [`SdkError<CreateApiKeyError>`](crate::operation::create_api_key::CreateApiKeyError)
26    pub fn create_api_key(&self) -> crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder {
27        crate::operation::create_api_key::builders::CreateApiKeyFluentBuilder::new(self.handle.clone())
28    }
29}
aws_sdk_apigateway/client/create_api_key.rs

aws_sdk_apigateway/client/
create_api_key.rs
