aws_sdk_codestarnotifications/client/
describe_notification_rule.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 [`DescribeNotificationRule`](crate::operation::describe_notification_rule::builders::DescribeNotificationRuleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`arn(impl Into<String>)`](crate::operation::describe_notification_rule::builders::DescribeNotificationRuleFluentBuilder::arn) / [`set_arn(Option<String>)`](crate::operation::describe_notification_rule::builders::DescribeNotificationRuleFluentBuilder::set_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the notification rule.</p><br>
7    /// - On success, responds with [`DescribeNotificationRuleOutput`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput) with field(s):
8    ///   - [`arn(String)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::arn): <p>The Amazon Resource Name (ARN) of the notification rule.</p>
9    ///   - [`name(Option<String>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::name): <p>The name of the notification rule.</p>
10    ///   - [`event_types(Option<Vec::<EventTypeSummary>>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::event_types): <p>A list of the event types associated with the notification rule.</p>
11    ///   - [`resource(Option<String>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::resource): <p>The Amazon Resource Name (ARN) of the resource associated with the notification rule.</p>
12    ///   - [`targets(Option<Vec::<TargetSummary>>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::targets): <p>A list of the Chatbot topics and Chatbot clients associated with the notification rule.</p>
13    ///   - [`detail_type(Option<DetailType>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::detail_type): <p>The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.</p>
14    ///   - [`created_by(Option<String>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::created_by): <p>The name or email alias of the person who created the notification rule.</p>
15    ///   - [`status(Option<NotificationRuleStatus>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::status): <p>The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).</p>
16    ///   - [`created_timestamp(Option<DateTime>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::created_timestamp): <p>The date and time the notification rule was created, in timestamp format.</p>
17    ///   - [`last_modified_timestamp(Option<DateTime>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::last_modified_timestamp): <p>The date and time the notification rule was most recently updated, in timestamp format.</p>
18    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_notification_rule::DescribeNotificationRuleOutput::tags): <p>The tags associated with the notification rule.</p>
19    /// - On failure, responds with [`SdkError<DescribeNotificationRuleError>`](crate::operation::describe_notification_rule::DescribeNotificationRuleError)
20    pub fn describe_notification_rule(&self) -> crate::operation::describe_notification_rule::builders::DescribeNotificationRuleFluentBuilder {
21        crate::operation::describe_notification_rule::builders::DescribeNotificationRuleFluentBuilder::new(self.handle.clone())
22    }
23}