Struct aws_sdk_alexaforbusiness::client::fluent_builders::SendAnnouncement

source · [−]

pub struct SendAnnouncement { /* private fields */ }

Expand description

Fluent builder constructing a request to SendAnnouncement.

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

Implementations

impl SendAnnouncement

pub async fn send(
self
) -> Result<SendAnnouncementOutput, SdkError<SendAnnouncementError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn room_filters(self, input: Filter) -> Self

Appends an item to RoomFilters.

To override the contents of this collection use set_room_filters.

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

pub fn set_room_filters(self, input: Option<Vec<Filter>>) -> Self

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

pub fn content(self, input: Content) -> Self

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

pub fn set_content(self, input: Option<Content>) -> Self

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

pub fn time_to_live_in_seconds(self, input: i32) -> Self

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

pub fn set_time_to_live_in_seconds(self, input: Option<i32>) -> Self

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

pub fn client_request_token(self, input: impl Into<String>) -> Self

The unique, user-specified identifier for the request that ensures idempotency.

pub fn set_client_request_token(self, input: Option<String>) -> Self

The unique, user-specified identifier for the request that ensures idempotency.

Trait Implementations

impl Clone for SendAnnouncement

fn clone(&self) -> SendAnnouncement

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for SendAnnouncement

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for SendAnnouncement

impl Send for SendAnnouncement

impl Sync for SendAnnouncement

impl Unpin for SendAnnouncement

impl !UnwindSafe for SendAnnouncement

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more