aws_sdk_location/client/
describe_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 [`DescribeKey`](crate::operation::describe_key::builders::DescribeKeyFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`key_name(impl Into<String>)`](crate::operation::describe_key::builders::DescribeKeyFluentBuilder::key_name) / [`set_key_name(Option<String>)`](crate::operation::describe_key::builders::DescribeKeyFluentBuilder::set_key_name):<br>required: **true**<br><p>The name of the API key resource.</p><br>
7    /// - On success, responds with [`DescribeKeyOutput`](crate::operation::describe_key::DescribeKeyOutput) with field(s):
8    ///   - [`key(String)`](crate::operation::describe_key::DescribeKeyOutput::key): <p>The key value/string of an API key.</p>
9    ///   - [`key_arn(String)`](crate::operation::describe_key::DescribeKeyOutput::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>
10    ///   - [`key_name(String)`](crate::operation::describe_key::DescribeKeyOutput::key_name): <p>The name of the API key resource.</p>
11    ///   - [`restrictions(Option<ApiKeyRestrictions>)`](crate::operation::describe_key::DescribeKeyOutput::restrictions): <p>API Restrictions on the allowed actions, resources, and referers for an API key resource.</p>
12    ///   - [`create_time(DateTime)`](crate::operation::describe_key::DescribeKeyOutput::create_time): <p>The timestamp for when the API key resource was created 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>
13    ///   - [`expire_time(DateTime)`](crate::operation::describe_key::DescribeKeyOutput::expire_time): <p>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>
14    ///   - [`update_time(DateTime)`](crate::operation::describe_key::DescribeKeyOutput::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>
15    ///   - [`description(Option<String>)`](crate::operation::describe_key::DescribeKeyOutput::description): <p>The optional description for the API key resource.</p>
16    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_key::DescribeKeyOutput::tags): <p>Tags associated with the API key resource.</p>
17    /// - On failure, responds with [`SdkError<DescribeKeyError>`](crate::operation::describe_key::DescribeKeyError)
18    pub fn describe_key(&self) -> crate::operation::describe_key::builders::DescribeKeyFluentBuilder {
19        crate::operation::describe_key::builders::DescribeKeyFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_location/client/describe_key.rs

aws_sdk_location/client/
describe_key.rs
