aws_sdk_cloudhsm/client/
describe_hsm.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 [`DescribeHsm`](crate::operation::describe_hsm::builders::DescribeHsmFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`hsm_arn(impl Into<String>)`](crate::operation::describe_hsm::builders::DescribeHsmFluentBuilder::hsm_arn) / [`set_hsm_arn(Option<String>)`](crate::operation::describe_hsm::builders::DescribeHsmFluentBuilder::set_hsm_arn):<br>required: **false**<br><p>The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code> parameter must be specified.</p><br>
7    ///   - [`hsm_serial_number(impl Into<String>)`](crate::operation::describe_hsm::builders::DescribeHsmFluentBuilder::hsm_serial_number) / [`set_hsm_serial_number(Option<String>)`](crate::operation::describe_hsm::builders::DescribeHsmFluentBuilder::set_hsm_serial_number):<br>required: **false**<br><p>The serial number of the HSM. Either the <code>HsmArn</code> or the <code>HsmSerialNumber</code> parameter must be specified.</p><br>
8    /// - On success, responds with [`DescribeHsmOutput`](crate::operation::describe_hsm::DescribeHsmOutput) with field(s):
9    ///   - [`hsm_arn(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::hsm_arn): <p>The ARN of the HSM.</p>
10    ///   - [`status(Option<HsmStatus>)`](crate::operation::describe_hsm::DescribeHsmOutput::status): <p>The status of the HSM.</p>
11    ///   - [`status_details(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::status_details): <p>Contains additional information about the status of the HSM.</p>
12    ///   - [`availability_zone(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::availability_zone): <p>The Availability Zone that the HSM is in.</p>
13    ///   - [`eni_id(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::eni_id): <p>The identifier of the elastic network interface (ENI) attached to the HSM.</p>
14    ///   - [`eni_ip(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::eni_ip): <p>The IP address assigned to the HSM's ENI.</p>
15    ///   - [`subscription_type(Option<SubscriptionType>)`](crate::operation::describe_hsm::DescribeHsmOutput::subscription_type): <p>Specifies the type of subscription for the HSM.</p> <ul>  <li>   <p><b>PRODUCTION</b> - The HSM is being used in a production environment.</p></li>  <li>   <p><b>TRIAL</b> - The HSM is being used in a product trial.</p></li> </ul>
16    ///   - [`subscription_start_date(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::subscription_start_date): <p>The subscription start date.</p>
17    ///   - [`subscription_end_date(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::subscription_end_date): <p>The subscription end date.</p>
18    ///   - [`vpc_id(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::vpc_id): <p>The identifier of the VPC that the HSM is in.</p>
19    ///   - [`subnet_id(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::subnet_id): <p>The identifier of the subnet that the HSM is in.</p>
20    ///   - [`iam_role_arn(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::iam_role_arn): <p>The ARN of the IAM role assigned to the HSM.</p>
21    ///   - [`serial_number(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::serial_number): <p>The serial number of the HSM.</p>
22    ///   - [`vendor_name(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::vendor_name): <p>The name of the HSM vendor.</p>
23    ///   - [`hsm_type(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::hsm_type): <p>The HSM model type.</p>
24    ///   - [`software_version(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::software_version): <p>The HSM software version.</p>
25    ///   - [`ssh_public_key(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::ssh_public_key): <p>The public SSH key.</p>
26    ///   - [`ssh_key_last_updated(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::ssh_key_last_updated): <p>The date and time that the SSH key was last updated.</p>
27    ///   - [`server_cert_uri(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::server_cert_uri): <p>The URI of the certificate server.</p>
28    ///   - [`server_cert_last_updated(Option<String>)`](crate::operation::describe_hsm::DescribeHsmOutput::server_cert_last_updated): <p>The date and time that the server certificate was last updated.</p>
29    ///   - [`partitions(Option<Vec::<String>>)`](crate::operation::describe_hsm::DescribeHsmOutput::partitions): <p>The list of partitions on the HSM.</p>
30    /// - On failure, responds with [`SdkError<DescribeHsmError>`](crate::operation::describe_hsm::DescribeHsmError)
31    #[deprecated(note = "This API is deprecated.")]
32    pub fn describe_hsm(&self) -> crate::operation::describe_hsm::builders::DescribeHsmFluentBuilder {
33        crate::operation::describe_hsm::builders::DescribeHsmFluentBuilder::new(self.handle.clone())
34    }
35}
aws_sdk_cloudhsm/client/describe_hsm.rs

aws_sdk_cloudhsm/client/
describe_hsm.rs
