aws_sdk_cloudhsm/client/
describe_hapg.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 [`DescribeHapg`](crate::operation::describe_hapg::builders::DescribeHapgFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`hapg_arn(impl Into<String>)`](crate::operation::describe_hapg::builders::DescribeHapgFluentBuilder::hapg_arn) / [`set_hapg_arn(Option<String>)`](crate::operation::describe_hapg::builders::DescribeHapgFluentBuilder::set_hapg_arn):<br>required: **true**<br><p>The ARN of the high-availability partition group to describe.</p><br>
7    /// - On success, responds with [`DescribeHapgOutput`](crate::operation::describe_hapg::DescribeHapgOutput) with field(s):
8    ///   - [`hapg_arn(Option<String>)`](crate::operation::describe_hapg::DescribeHapgOutput::hapg_arn): <p>The ARN of the high-availability partition group.</p>
9    ///   - [`hapg_serial(Option<String>)`](crate::operation::describe_hapg::DescribeHapgOutput::hapg_serial): <p>The serial number of the high-availability partition group.</p>
10    ///   - [`hsms_last_action_failed(Option<Vec::<String>>)`](crate::operation::describe_hapg::DescribeHapgOutput::hsms_last_action_failed): <p></p>
11    ///   - [`hsms_pending_deletion(Option<Vec::<String>>)`](crate::operation::describe_hapg::DescribeHapgOutput::hsms_pending_deletion): <p></p>
12    ///   - [`hsms_pending_registration(Option<Vec::<String>>)`](crate::operation::describe_hapg::DescribeHapgOutput::hsms_pending_registration): <p></p>
13    ///   - [`label(Option<String>)`](crate::operation::describe_hapg::DescribeHapgOutput::label): <p>The label for the high-availability partition group.</p>
14    ///   - [`last_modified_timestamp(Option<String>)`](crate::operation::describe_hapg::DescribeHapgOutput::last_modified_timestamp): <p>The date and time the high-availability partition group was last modified.</p>
15    ///   - [`partition_serial_list(Option<Vec::<String>>)`](crate::operation::describe_hapg::DescribeHapgOutput::partition_serial_list): <p>The list of partition serial numbers that belong to the high-availability partition group.</p>
16    ///   - [`state(Option<CloudHsmObjectState>)`](crate::operation::describe_hapg::DescribeHapgOutput::state): <p>The state of the high-availability partition group.</p>
17    /// - On failure, responds with [`SdkError<DescribeHapgError>`](crate::operation::describe_hapg::DescribeHapgError)
18    #[deprecated(note = "This API is deprecated.")]
19    pub fn describe_hapg(&self) -> crate::operation::describe_hapg::builders::DescribeHapgFluentBuilder {
20        crate::operation::describe_hapg::builders::DescribeHapgFluentBuilder::new(self.handle.clone())
21    }
22}