1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateKey`](crate::operation::update_key::builders::UpdateKeyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`key_name(impl Into<String>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::key_name) / [`set_key_name(Option<String>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::set_key_name):<br>required: **true**<br><p>The name of the API key resource to update.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::set_description):<br>required: **false**<br><p>Updates the description for the API key resource.</p><br>
    ///   - [`expire_time(DateTime)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::expire_time) / [`set_expire_time(Option<DateTime>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::set_expire_time):<br>required: **false**<br><p>Updates the timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p><br>
    ///   - [`no_expiry(bool)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::no_expiry) / [`set_no_expiry(Option<bool>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::set_no_expiry):<br>required: **false**<br><p>Whether the API key should expire. Set to <code>true</code> to set the API key to have no expiration time.</p><br>
    ///   - [`force_update(bool)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::force_update) / [`set_force_update(Option<bool>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::set_force_update):<br>required: **false**<br><p>The boolean flag to be included for updating <code>ExpireTime</code> or <code>Restrictions</code> details.</p> <p>Must be set to <code>true</code> to update an API key resource that has been used in the past 7 days.</p> <p><code>False</code> if force update is not preferred</p> <p>Default value: <code>False</code></p><br>
    ///   - [`restrictions(ApiKeyRestrictions)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::restrictions) / [`set_restrictions(Option<ApiKeyRestrictions>)`](crate::operation::update_key::builders::UpdateKeyFluentBuilder::set_restrictions):<br>required: **false**<br><p>Updates the API key restrictions for the API key resource.</p><br>
    /// - On success, responds with [`UpdateKeyOutput`](crate::operation::update_key::UpdateKeyOutput) with field(s):
    ///   - [`key_arn(String)`](crate::operation::update_key::UpdateKeyOutput::key_arn): <p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.</p> <ul>  <li>   <p>Format example: <code>arn:aws:geo:region:account-id:key/ExampleKey</code></p></li> </ul>
    ///   - [`key_name(String)`](crate::operation::update_key::UpdateKeyOutput::key_name): <p>The name of the API key resource.</p>
    ///   - [`update_time(DateTime)`](crate::operation::update_key::UpdateKeyOutput::update_time): <p>The timestamp for when the API key resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
    /// - On failure, responds with [`SdkError<UpdateKeyError>`](crate::operation::update_key::UpdateKeyError)
    pub fn update_key(&self) -> crate::operation::update_key::builders::UpdateKeyFluentBuilder {
        crate::operation::update_key::builders::UpdateKeyFluentBuilder::new(self.handle.clone())
    }
}