Struct aws_sdk_chime::operation::create_channel::builders::CreateChannelFluentBuilder

pub struct CreateChannelFluentBuilder { /* private fields */ }

👎Deprecated: Replaced by CreateChannel in the Amazon Chime SDK Messaging Namespace

Fluent builder constructing a request to CreateChannel.

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Implementations

impl CreateChannelFluentBuilder

pub fn as_input(&self) -> &CreateChannelInputBuilder

Access the CreateChannel as a reference.

pub async fn send( self ) -> Result<CreateChannelOutput, SdkError<CreateChannelError, 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<CreateChannelOutput, CreateChannelError, Self>

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

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

The ARN of the channel request.

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

The ARN of the channel request.

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

The ARN of the channel request.

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

The name of the channel.

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

The name of the channel.

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

The name of the channel.

pub fn mode(self, input: ChannelMode) -> Self

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

pub fn set_mode(self, input: Option<ChannelMode>) -> Self

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

pub fn get_mode(&self) -> &Option<ChannelMode>

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

pub fn privacy(self, input: ChannelPrivacy) -> Self

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

pub fn set_privacy(self, input: Option<ChannelPrivacy>) -> Self

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

pub fn get_privacy(&self) -> &Option<ChannelPrivacy>

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

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

The metadata of the creation request. Limited to 1KB and UTF-8.

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

The metadata of the creation request. Limited to 1KB and UTF-8.

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

The metadata of the creation request. Limited to 1KB and UTF-8.

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

The client token for the request. An Idempotency token.

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

The client token for the request. An Idempotency token.

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

The client token for the request. An Idempotency token.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The tags for the creation request.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags for the creation request.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The tags for the creation request.

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

The AppInstanceUserArn of the user that makes the API call.

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

The AppInstanceUserArn of the user that makes the API call.

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

The AppInstanceUserArn of the user that makes the API call.

Trait Implementations

impl Clone for CreateChannelFluentBuilder

fn clone(&self) -> CreateChannelFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChannelFluentBuilder

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

Formats the value using the given formatter.