aws_sdk_connect/client/

send_outbound_web_notification.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SendOutboundWebNotification`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p><br>
    ///   - [`browser_id(impl Into<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::browser_id) / [`set_browser_id(Option<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_browser_id):<br>required: **true**<br><p>A unique identifier for the customer's web browser instance to which the notification is being sent.</p><br>
    ///   - [`session_id(impl Into<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_session_id):<br>required: **true**<br><p>A unique identifier for the customer's web session to which the notification is being sent.</p><br>
    ///   - [`expires_at(DateTime)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::expires_at) / [`set_expires_at(Option<DateTime>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_expires_at):<br>required: **true**<br><p>The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.</p><br>
    ///   - [`source(WebNotificationSource)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::source) / [`set_source(Option<WebNotificationSource>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_source):<br>required: **true**<br><p>The source of the web notification. A <code>SourceCampaign</code> object identifies the campaign and outbound request that triggered this notification.</p><br>
    ///   - [`destination(WidgetDestination)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::destination) / [`set_destination(Option<WidgetDestination>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_destination):<br>required: **true**<br><p>The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.</p><br>
    ///   - [`content(WebNotificationContent)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::content) / [`set_content(Option<WebNotificationContent>)`](crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::set_content):<br>required: **true**<br><p>The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.</p><br>
    /// - On success, responds with [`SendOutboundWebNotificationOutput`](crate::operation::send_outbound_web_notification::SendOutboundWebNotificationOutput)
    /// - On failure, responds with [`SdkError<SendOutboundWebNotificationError>`](crate::operation::send_outbound_web_notification::SendOutboundWebNotificationError)
    pub fn send_outbound_web_notification(
        &self,
    ) -> crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder {
        crate::operation::send_outbound_web_notification::builders::SendOutboundWebNotificationFluentBuilder::new(self.handle.clone())
    }
}