aws_sdk_directory/client/

describe_ca_enrollment_policy.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeCAEnrollmentPolicy`](crate::operation::describe_ca_enrollment_policy::builders::DescribeCAEnrollmentPolicyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`directory_id(impl Into<String>)`](crate::operation::describe_ca_enrollment_policy::builders::DescribeCAEnrollmentPolicyFluentBuilder::directory_id) / [`set_directory_id(Option<String>)`](crate::operation::describe_ca_enrollment_policy::builders::DescribeCAEnrollmentPolicyFluentBuilder::set_directory_id):<br>required: **true**<br><p>The identifier of the directory for which to retrieve the CA enrollment policy information.</p><br>
    /// - On success, responds with [`DescribeCaEnrollmentPolicyOutput`](crate::operation::describe_ca_enrollment_policy::DescribeCaEnrollmentPolicyOutput) with field(s):
    ///   - [`directory_id(Option<String>)`](crate::operation::describe_ca_enrollment_policy::DescribeCaEnrollmentPolicyOutput::directory_id): <p>The identifier of the directory associated with this CA enrollment policy.</p>
    ///   - [`pca_connector_arn(Option<String>)`](crate::operation::describe_ca_enrollment_policy::DescribeCaEnrollmentPolicyOutput::pca_connector_arn): <p>The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority (PCA) connector that is configured for automatic certificate enrollment in this directory.</p>
    ///   - [`ca_enrollment_policy_status(Option<CaEnrollmentPolicyStatus>)`](crate::operation::describe_ca_enrollment_policy::DescribeCaEnrollmentPolicyOutput::ca_enrollment_policy_status): <p>The current status of the CA enrollment policy. This indicates if automatic certificate enrollment is currently active, inactive, or in a transitional state.</p> <p>Valid values:</p> <ul>  <li>   <p><code>IN_PROGRESS</code> - The policy is being activated T</p></li>  <li>   <p><code>SUCCESS</code> - The policy is active and automatic certificate enrollment is operational</p></li>  <li>   <p><code>FAILED</code> - The policy activation or deactivation failed</p></li>  <li>   <p><code>DISABLING</code> - The policy is being deactivated</p></li>  <li>   <p><code>DISABLED</code> - The policy is inactive and automatic certificate enrollment is not available</p></li>  <li>   <p><code>IMPAIRED</code> - Network connectivity is impaired.</p></li> </ul>
    ///   - [`last_updated_date_time(Option<DateTime>)`](crate::operation::describe_ca_enrollment_policy::DescribeCaEnrollmentPolicyOutput::last_updated_date_time): <p>The date and time when the CA enrollment policy was last modified or updated.</p>
    ///   - [`ca_enrollment_policy_status_reason(Option<String>)`](crate::operation::describe_ca_enrollment_policy::DescribeCaEnrollmentPolicyOutput::ca_enrollment_policy_status_reason): <p>Additional information explaining the current status of the CA enrollment policy, particularly useful when the policy is in an error or transitional state.</p>
    /// - On failure, responds with [`SdkError<DescribeCAEnrollmentPolicyError>`](crate::operation::describe_ca_enrollment_policy::DescribeCAEnrollmentPolicyError)
    pub fn describe_ca_enrollment_policy(
        &self,
    ) -> crate::operation::describe_ca_enrollment_policy::builders::DescribeCAEnrollmentPolicyFluentBuilder {
        crate::operation::describe_ca_enrollment_policy::builders::DescribeCAEnrollmentPolicyFluentBuilder::new(self.handle.clone())
    }
}