aws_sdk_ssmcontacts/client/
describe_page.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 [`DescribePage`](crate::operation::describe_page::builders::DescribePageFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`page_id(impl Into<String>)`](crate::operation::describe_page::builders::DescribePageFluentBuilder::page_id) / [`set_page_id(Option<String>)`](crate::operation::describe_page::builders::DescribePageFluentBuilder::set_page_id):<br>required: **true**<br><p>The ID of the engagement to a contact channel.</p><br>
7    /// - On success, responds with [`DescribePageOutput`](crate::operation::describe_page::DescribePageOutput) with field(s):
8    ///   - [`page_arn(String)`](crate::operation::describe_page::DescribePageOutput::page_arn): <p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>
9    ///   - [`engagement_arn(String)`](crate::operation::describe_page::DescribePageOutput::engagement_arn): <p>The ARN of the engagement that engaged the contact channel.</p>
10    ///   - [`contact_arn(String)`](crate::operation::describe_page::DescribePageOutput::contact_arn): <p>The ARN of the contact that was engaged.</p>
11    ///   - [`sender(String)`](crate::operation::describe_page::DescribePageOutput::sender): <p>The user that started the engagement.</p>
12    ///   - [`subject(String)`](crate::operation::describe_page::DescribePageOutput::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>
13    ///   - [`content(String)`](crate::operation::describe_page::DescribePageOutput::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>
14    ///   - [`public_subject(Option<String>)`](crate::operation::describe_page::DescribePageOutput::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>
15    ///   - [`public_content(Option<String>)`](crate::operation::describe_page::DescribePageOutput::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>
16    ///   - [`incident_id(Option<String>)`](crate::operation::describe_page::DescribePageOutput::incident_id): <p>The ARN of the incident that engaged the contact channel.</p>
17    ///   - [`sent_time(Option<DateTime>)`](crate::operation::describe_page::DescribePageOutput::sent_time): <p>The time the engagement was sent to the contact channel.</p>
18    ///   - [`read_time(Option<DateTime>)`](crate::operation::describe_page::DescribePageOutput::read_time): <p>The time that the contact channel acknowledged the engagement.</p>
19    ///   - [`delivery_time(Option<DateTime>)`](crate::operation::describe_page::DescribePageOutput::delivery_time): <p>The time that the contact channel received the engagement.</p>
20    /// - On failure, responds with [`SdkError<DescribePageError>`](crate::operation::describe_page::DescribePageError)
21    pub fn describe_page(&self) -> crate::operation::describe_page::builders::DescribePageFluentBuilder {
22        crate::operation::describe_page::builders::DescribePageFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_ssmcontacts/client/describe_page.rs

aws_sdk_ssmcontacts/client/
describe_page.rs
