aws_sdk_iam/client/
get_ssh_public_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 [`GetSSHPublicKey`](crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_name(impl Into<String>)`](crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder::user_name) / [`set_user_name(Option<String>)`](crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder::set_user_name):<br>required: **true**<br><p>The name of the IAM user associated with the SSH public key.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p><br>
7    ///   - [`ssh_public_key_id(impl Into<String>)`](crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder::ssh_public_key_id) / [`set_ssh_public_key_id(Option<String>)`](crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder::set_ssh_public_key_id):<br>required: **true**<br><p>The unique identifier for the SSH public key.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters that can consist of any upper or lowercased letter or digit.</p><br>
8    ///   - [`encoding(EncodingType)`](crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder::encoding) / [`set_encoding(Option<EncodingType>)`](crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder::set_encoding):<br>required: **true**<br><p>Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use <code>SSH</code>. To retrieve the public key in PEM format, use <code>PEM</code>.</p><br>
9    /// - On success, responds with [`GetSshPublicKeyOutput`](crate::operation::get_ssh_public_key::GetSshPublicKeyOutput) with field(s):
10    ///   - [`ssh_public_key(Option<SshPublicKey>)`](crate::operation::get_ssh_public_key::GetSshPublicKeyOutput::ssh_public_key): <p>A structure containing details about the SSH public key.</p>
11    /// - On failure, responds with [`SdkError<GetSSHPublicKeyError>`](crate::operation::get_ssh_public_key::GetSSHPublicKeyError)
12    pub fn get_ssh_public_key(&self) -> crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder {
13        crate::operation::get_ssh_public_key::builders::GetSSHPublicKeyFluentBuilder::new(self.handle.clone())
14    }
15}