aws_sdk_observabilityadmin/client/get_telemetry_rule_for_organization.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 [`GetTelemetryRuleForOrganization`](crate::operation::get_telemetry_rule_for_organization::builders::GetTelemetryRuleForOrganizationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`rule_identifier(impl Into<String>)`](crate::operation::get_telemetry_rule_for_organization::builders::GetTelemetryRuleForOrganizationFluentBuilder::rule_identifier) / [`set_rule_identifier(Option<String>)`](crate::operation::get_telemetry_rule_for_organization::builders::GetTelemetryRuleForOrganizationFluentBuilder::set_rule_identifier):<br>required: **true**<br><p>The identifier (name or ARN) of the organization telemetry rule to retrieve.</p><br>
7 /// - On success, responds with [`GetTelemetryRuleForOrganizationOutput`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput) with field(s):
8 /// - [`rule_name(Option<String>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::rule_name): <p>The name of the organization telemetry rule.</p>
9 /// - [`rule_arn(Option<String>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::rule_arn): <p>The Amazon Resource Name (ARN) of the organization telemetry rule.</p>
10 /// - [`created_time_stamp(Option<i64>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::created_time_stamp): <p>The timestamp when the organization telemetry rule was created.</p>
11 /// - [`last_update_time_stamp(Option<i64>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::last_update_time_stamp): <p>The timestamp when the organization telemetry rule was last updated.</p>
12 /// - [`telemetry_rule(Option<TelemetryRule>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::telemetry_rule): <p>The configuration details of the organization telemetry rule.</p>
13 /// - [`home_region(Option<String>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::home_region): <p>The Amazon Web Services Region where the organization telemetry rule was originally created. For replicated rules in spoke regions, this indicates the region that manages the rule. For rules created without multi-region scope, this field is not present.</p>
14 /// - [`is_replicated(Option<bool>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::is_replicated): <p>Indicates whether this organization telemetry rule is a replica that was created in this region through multi-region fan-out from the home region. Replicated rules cannot be directly updated or deleted in the spoke region. To modify a replicated rule, make changes in the home region.</p>
15 /// - [`region_statuses(Option<Vec::<RegionStatus>>)`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationOutput::region_statuses): <p>A list of per-region replication statuses for the organization telemetry rule. Each entry indicates the replication status of the rule in a specific spoke region. This field is only present for rules created with multi-region scope.</p>
16 /// - On failure, responds with [`SdkError<GetTelemetryRuleForOrganizationError>`](crate::operation::get_telemetry_rule_for_organization::GetTelemetryRuleForOrganizationError)
17 pub fn get_telemetry_rule_for_organization(
18 &self,
19 ) -> crate::operation::get_telemetry_rule_for_organization::builders::GetTelemetryRuleForOrganizationFluentBuilder {
20 crate::operation::get_telemetry_rule_for_organization::builders::GetTelemetryRuleForOrganizationFluentBuilder::new(self.handle.clone())
21 }
22}