Struct aws_sdk_alexaforbusiness::operation::send_announcement::builders::SendAnnouncementFluentBuilder

pub struct SendAnnouncementFluentBuilder { /* private fields */ }

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 SendAnnouncementFluentBuilder

pub fn as_input(&self) -> &SendAnnouncementInputBuilder

Access the SendAnnouncement as a reference.

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

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 customize( self ) -> CustomizableOperation<SendAnnouncementOutput, SendAnnouncementError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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 get_room_filters(&self) -> &Option<Vec<Filter>>

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 get_content(&self) -> &Option<Content>

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 get_time_to_live_in_seconds(&self) -> &Option<i32>

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.

pub fn get_client_request_token(&self) -> &Option<String>

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

Trait Implementations

impl Clone for SendAnnouncementFluentBuilder

fn clone(&self) -> SendAnnouncementFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendAnnouncementFluentBuilder

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

Formats the value using the given formatter.