aws_sdk_securityhub/client/

describe_hub.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeHub`](crate::operation::describe_hub::builders::DescribeHubFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`hub_arn(impl Into<String>)`](crate::operation::describe_hub::builders::DescribeHubFluentBuilder::hub_arn) / [`set_hub_arn(Option<String>)`](crate::operation::describe_hub::builders::DescribeHubFluentBuilder::set_hub_arn):<br>required: **false**<br><p>The ARN of the Hub resource to retrieve.</p><br>
    /// - On success, responds with [`DescribeHubOutput`](crate::operation::describe_hub::DescribeHubOutput) with field(s):
    ///   - [`hub_arn(Option<String>)`](crate::operation::describe_hub::DescribeHubOutput::hub_arn): <p>The ARN of the Hub resource that was retrieved.</p>
    ///   - [`subscribed_at(Option<String>)`](crate::operation::describe_hub::DescribeHubOutput::subscribed_at): <p>The date and time when Security Hub was enabled in the account.</p>
    ///   - [`auto_enable_controls(Option<bool>)`](crate::operation::describe_hub::DescribeHubOutput::auto_enable_controls): <p>Whether to automatically enable new controls when they are added to standards that are enabled.</p> <p>If set to <code>true</code>, then new controls for enabled standards are enabled automatically. If set to <code>false</code>, then new controls are not enabled.</p> <p>When you automatically enable new controls, you can interact with the controls in the console and programmatically immediately after release. However, automatically enabled controls have a temporary default status of <code>DISABLED</code>. It can take up to several days for Security Hub to process the control release and designate the control as <code>ENABLED</code> in your account. During the processing period, you can manually enable or disable a control, and Security Hub will maintain that designation regardless of whether you have <code>AutoEnableControls</code> set to <code>true</code>.</p>
    ///   - [`control_finding_generator(Option<ControlFindingGenerator>)`](crate::operation::describe_hub::DescribeHubOutput::control_finding_generator): <p>Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to <code>SECURITY_CONTROL</code>, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.</p> <p>If the value for this field is set to <code>STANDARD_CONTROL</code>, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.</p> <p>The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is <code>SECURITY_CONTROL</code> if you enabled Security Hub on or after February 23, 2023.</p>
    /// - On failure, responds with [`SdkError<DescribeHubError>`](crate::operation::describe_hub::DescribeHubError)
    pub fn describe_hub(&self) -> crate::operation::describe_hub::builders::DescribeHubFluentBuilder {
        crate::operation::describe_hub::builders::DescribeHubFluentBuilder::new(self.handle.clone())
    }
}