aws_sdk_ssmcontacts/client/
describe_engagement.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 [`DescribeEngagement`](crate::operation::describe_engagement::builders::DescribeEngagementFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`engagement_id(impl Into<String>)`](crate::operation::describe_engagement::builders::DescribeEngagementFluentBuilder::engagement_id) / [`set_engagement_id(Option<String>)`](crate::operation::describe_engagement::builders::DescribeEngagementFluentBuilder::set_engagement_id):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the engagement you want the details of.</p><br>
7    /// - On success, responds with [`DescribeEngagementOutput`](crate::operation::describe_engagement::DescribeEngagementOutput) with field(s):
8    ///   - [`contact_arn(String)`](crate::operation::describe_engagement::DescribeEngagementOutput::contact_arn): <p>The ARN of the escalation plan or contacts involved in the engagement.</p>
9    ///   - [`engagement_arn(String)`](crate::operation::describe_engagement::DescribeEngagementOutput::engagement_arn): <p>The ARN of the engagement.</p>
10    ///   - [`sender(String)`](crate::operation::describe_engagement::DescribeEngagementOutput::sender): <p>The user that started the engagement.</p>
11    ///   - [`subject(String)`](crate::operation::describe_engagement::DescribeEngagementOutput::subject): <p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>
12    ///   - [`content(String)`](crate::operation::describe_engagement::DescribeEngagementOutput::content): <p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>
13    ///   - [`public_subject(Option<String>)`](crate::operation::describe_engagement::DescribeEngagementOutput::public_subject): <p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>
14    ///   - [`public_content(Option<String>)`](crate::operation::describe_engagement::DescribeEngagementOutput::public_content): <p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>
15    ///   - [`incident_id(Option<String>)`](crate::operation::describe_engagement::DescribeEngagementOutput::incident_id): <p>The ARN of the incident in which the engagement occurred.</p>
16    ///   - [`start_time(Option<DateTime>)`](crate::operation::describe_engagement::DescribeEngagementOutput::start_time): <p>The time that the engagement started.</p>
17    ///   - [`stop_time(Option<DateTime>)`](crate::operation::describe_engagement::DescribeEngagementOutput::stop_time): <p>The time that the engagement ended.</p>
18    /// - On failure, responds with [`SdkError<DescribeEngagementError>`](crate::operation::describe_engagement::DescribeEngagementError)
19    pub fn describe_engagement(&self) -> crate::operation::describe_engagement::builders::DescribeEngagementFluentBuilder {
20        crate::operation::describe_engagement::builders::DescribeEngagementFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_ssmcontacts/client/describe_engagement.rs

aws_sdk_ssmcontacts/client/
describe_engagement.rs
