Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Chime SDK Messaging

Client for invoking operations on Amazon Chime SDK Messaging. Each operation on Amazon Chime SDK Messaging is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_chimesdkmessaging::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_chimesdkmessaging::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateChannelFlow operation has a Client::associate_channel_flow, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_channel_flow()
    .channel_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_channel_flow(&self) -> AssociateChannelFlowFluentBuilder

Constructs a fluent builder for the AssociateChannelFlow operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • channel_flow_arn(impl Into<String>) / set_channel_flow_arn(Option<String>):
    required: true
    

    The ARN of the channel flow.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The AppInstanceUserArn of the user making the API call.

    
    
• On success, responds with AssociateChannelFlowOutput
• On failure, responds with SdkError<AssociateChannelFlowError>

impl Client

pub fn batch_create_channel_membership( &self, ) -> BatchCreateChannelMembershipFluentBuilder

Constructs a fluent builder for the BatchCreateChannelMembership operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel to which you’re adding users or bots.

    
    
  • r#type(ChannelMembershipType) / set_type(Option<ChannelMembershipType>):
    required: false
    

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

    
    
  • member_arns(impl Into<String>) / set_member_arns(Option<Vec::<String>>):
    required: true
    

    The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when creating membership in a SubChannel for a moderator in an elastic channel.

    
    
• On success, responds with BatchCreateChannelMembershipOutput with field(s):
  • batch_channel_memberships(Option<BatchChannelMemberships>):

    The list of channel memberships in the response.

  • errors(Option<Vec::<BatchCreateChannelMembershipError>>):

    If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.

• On failure, responds with SdkError<BatchCreateChannelMembershipError>

impl Client

pub fn channel_flow_callback(&self) -> ChannelFlowCallbackFluentBuilder

Constructs a fluent builder for the ChannelFlowCallback operation.

• The fluent builder is configurable:
  • callback_id(impl Into<String>) / set_callback_id(Option<String>):
    required: true
    

    The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.

    
    
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • delete_resource(bool) / set_delete_resource(Option<bool>):
    required: false
    

    When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.

    
    
  • channel_message(ChannelMessageCallback) / set_channel_message(Option<ChannelMessageCallback>):
    required: true
    

    Stores information about the processed message.

    
    
• On success, responds with ChannelFlowCallbackOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • callback_id(Option<String>):

    The call back ID passed in the request.

• On failure, responds with SdkError<ChannelFlowCallbackError>

impl Client

pub fn create_channel(&self) -> CreateChannelFluentBuilder

Constructs a fluent builder for the CreateChannel operation.

• The fluent builder is configurable:
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the channel request.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the channel.

    
    
  • mode(ChannelMode) / set_mode(Option<ChannelMode>):
    required: false
    

    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.

    
    
  • privacy(ChannelPrivacy) / set_privacy(Option<ChannelPrivacy>):
    required: false
    

    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.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: false
    

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

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    The client token for the request. An Idempotency token.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags for the creation request.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • channel_id(impl Into<String>) / set_channel_id(Option<String>):
    required: false
    

    The ID of the channel in the request.

    
    
  • member_arns(impl Into<String>) / set_member_arns(Option<Vec::<String>>):
    required: false
    

    The ARNs of the channel members in the request.

    
    
  • moderator_arns(impl Into<String>) / set_moderator_arns(Option<Vec::<String>>):
    required: false
    

    The ARNs of the channel moderators in the request.

    
    
  • elastic_channel_configuration(ElasticChannelConfiguration) / set_elastic_channel_configuration(Option<ElasticChannelConfiguration>):
    required: false
    

    The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

    
    
  • expiration_settings(ExpirationSettings) / set_expiration_settings(Option<ExpirationSettings>):
    required: false
    

    Settings that control the interval after which the channel is automatically deleted.

    
    
• On success, responds with CreateChannelOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

• On failure, responds with SdkError<CreateChannelError>

impl Client

pub fn create_channel_ban(&self) -> CreateChannelBanFluentBuilder

Constructs a fluent builder for the CreateChannelBan operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the ban request.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the member being banned.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with CreateChannelBanOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the response to the ban request.

  • member(Option<Identity>):

    The ChannelArn and BannedIdentity of the member in the ban response.

• On failure, responds with SdkError<CreateChannelBanError>

impl Client

pub fn create_channel_flow(&self) -> CreateChannelFlowFluentBuilder

Constructs a fluent builder for the CreateChannelFlow operation.

• The fluent builder is configurable:
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the channel flow request.

    
    
  • processors(Processor) / set_processors(Option<Vec::<Processor>>):
    required: true
    

    Information about the processor Lambda functions.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the channel flow.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags for the creation request.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    The client token for the request. An Idempotency token.

    
    
• On success, responds with CreateChannelFlowOutput with field(s):
  • channel_flow_arn(Option<String>):

    The ARN of the channel flow.

• On failure, responds with SdkError<CreateChannelFlowError>

impl Client

pub fn create_channel_membership(&self) -> CreateChannelMembershipFluentBuilder

Constructs a fluent builder for the CreateChannelMembership operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel to which you’re adding users.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the member you want to add to the channel.

    
    
  • r#type(ChannelMembershipType) / set_type(Option<ChannelMembershipType>):
    required: true
    

    The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when creating membership in a SubChannel for a moderator in an elastic channel.

    
    
• On success, responds with CreateChannelMembershipOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • member(Option<Identity>):

    The ARN and metadata of the member being added.

  • sub_channel_id(Option<String>):

    The ID of the SubChannel in the response.

• On failure, responds with SdkError<CreateChannelMembershipError>

impl Client

pub fn create_channel_moderator(&self) -> CreateChannelModeratorFluentBuilder

Constructs a fluent builder for the CreateChannelModerator operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • channel_moderator_arn(impl Into<String>) / set_channel_moderator_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the moderator.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with CreateChannelModeratorOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • channel_moderator(Option<Identity>):

    The ARNs of the channel and the moderator.

• On failure, responds with SdkError<CreateChannelModeratorError>

impl Client

pub fn delete_channel(&self) -> DeleteChannelFluentBuilder

Constructs a fluent builder for the DeleteChannel operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel being deleted.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DeleteChannelOutput
• On failure, responds with SdkError<DeleteChannelError>

impl Client

pub fn delete_channel_ban(&self) -> DeleteChannelBanFluentBuilder

Constructs a fluent builder for the DeleteChannelBan operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel from which the AppInstanceUser was banned.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser that you want to reinstate.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DeleteChannelBanOutput
• On failure, responds with SdkError<DeleteChannelBanError>

impl Client

pub fn delete_channel_flow(&self) -> DeleteChannelFlowFluentBuilder

Constructs a fluent builder for the DeleteChannelFlow operation.

• The fluent builder is configurable:
  • channel_flow_arn(impl Into<String>) / set_channel_flow_arn(Option<String>):
    required: true
    

    The ARN of the channel flow.

    
    
• On success, responds with DeleteChannelFlowOutput
• On failure, responds with SdkError<DeleteChannelFlowError>

impl Client

pub fn delete_channel_membership(&self) -> DeleteChannelMembershipFluentBuilder

Constructs a fluent builder for the DeleteChannelMembership operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel from which you want to remove the user.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the member that you’re removing from the channel.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only for use by moderators.

    
    
• On success, responds with DeleteChannelMembershipOutput
• On failure, responds with SdkError<DeleteChannelMembershipError>

impl Client

pub fn delete_channel_message(&self) -> DeleteChannelMessageFluentBuilder

Constructs a fluent builder for the DeleteChannelMessage operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The ID of the message being deleted.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when deleting messages in a SubChannel that the user belongs to.

    
    
• On success, responds with DeleteChannelMessageOutput
• On failure, responds with SdkError<DeleteChannelMessageError>

impl Client

pub fn delete_channel_moderator(&self) -> DeleteChannelModeratorFluentBuilder

Constructs a fluent builder for the DeleteChannelModerator operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • channel_moderator_arn(impl Into<String>) / set_channel_moderator_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the moderator being deleted.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DeleteChannelModeratorOutput
• On failure, responds with SdkError<DeleteChannelModeratorError>

impl Client

pub fn delete_messaging_streaming_configurations( &self, ) -> DeleteMessagingStreamingConfigurationsFluentBuilder

Constructs a fluent builder for the DeleteMessagingStreamingConfigurations operation.

• The fluent builder is configurable:
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the streaming configurations being deleted.

    
    
• On success, responds with DeleteMessagingStreamingConfigurationsOutput
• On failure, responds with SdkError<DeleteMessagingStreamingConfigurationsError>

impl Client

pub fn describe_channel(&self) -> DescribeChannelFluentBuilder

Constructs a fluent builder for the DescribeChannel operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DescribeChannelOutput with field(s):
  • channel(Option<Channel>):

    The channel details.

• On failure, responds with SdkError<DescribeChannelError>

impl Client

pub fn describe_channel_ban(&self) -> DescribeChannelBanFluentBuilder

Constructs a fluent builder for the DescribeChannelBan operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel from which the user is banned.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the member being banned.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DescribeChannelBanOutput with field(s):
  • channel_ban(Option<ChannelBan>):

    The details of the ban.

• On failure, responds with SdkError<DescribeChannelBanError>

impl Client

pub fn describe_channel_flow(&self) -> DescribeChannelFlowFluentBuilder

Constructs a fluent builder for the DescribeChannelFlow operation.

• The fluent builder is configurable:
  • channel_flow_arn(impl Into<String>) / set_channel_flow_arn(Option<String>):
    required: true
    

    The ARN of the channel flow.

    
    
• On success, responds with DescribeChannelFlowOutput with field(s):
  • channel_flow(Option<ChannelFlow>):

    The channel flow details.

• On failure, responds with SdkError<DescribeChannelFlowError>

impl Client

pub fn describe_channel_membership( &self, ) -> DescribeChannelMembershipFluentBuilder

Constructs a fluent builder for the DescribeChannelMembership operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the member.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

    Only required to get a user’s SubChannel membership details.

    
    
• On success, responds with DescribeChannelMembershipOutput with field(s):
  • channel_membership(Option<ChannelMembership>):

    The details of the membership.

• On failure, responds with SdkError<DescribeChannelMembershipError>

impl Client

pub fn describe_channel_membership_for_app_instance_user( &self, ) -> DescribeChannelMembershipForAppInstanceUserFluentBuilder

Constructs a fluent builder for the DescribeChannelMembershipForAppInstanceUser operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel to which the user belongs.

    
    
  • app_instance_user_arn(impl Into<String>) / set_app_instance_user_arn(Option<String>):
    required: true
    

    The ARN of the user or bot in a channel.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DescribeChannelMembershipForAppInstanceUserOutput with field(s):
  • channel_membership(Option<ChannelMembershipForAppInstanceUserSummary>):

    The channel to which a user belongs.

• On failure, responds with SdkError<DescribeChannelMembershipForAppInstanceUserError>

impl Client

pub fn describe_channel_moderated_by_app_instance_user( &self, ) -> DescribeChannelModeratedByAppInstanceUserFluentBuilder

Constructs a fluent builder for the DescribeChannelModeratedByAppInstanceUser operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the moderated channel.

    
    
  • app_instance_user_arn(impl Into<String>) / set_app_instance_user_arn(Option<String>):
    required: true
    

    The ARN of the user or bot in the moderated channel.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DescribeChannelModeratedByAppInstanceUserOutput with field(s):
  • channel(Option<ChannelModeratedByAppInstanceUserSummary>):

    The moderated channel.

• On failure, responds with SdkError<DescribeChannelModeratedByAppInstanceUserError>

impl Client

pub fn describe_channel_moderator( &self, ) -> DescribeChannelModeratorFluentBuilder

Constructs a fluent builder for the DescribeChannelModerator operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • channel_moderator_arn(impl Into<String>) / set_channel_moderator_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the channel moderator.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with DescribeChannelModeratorOutput with field(s):
  • channel_moderator(Option<ChannelModerator>):

    The details of the channel moderator.

• On failure, responds with SdkError<DescribeChannelModeratorError>

impl Client

pub fn disassociate_channel_flow(&self) -> DisassociateChannelFlowFluentBuilder

Constructs a fluent builder for the DisassociateChannelFlow operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • channel_flow_arn(impl Into<String>) / set_channel_flow_arn(Option<String>):
    required: true
    

    The ARN of the channel flow.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The AppInstanceUserArn of the user making the API call.

    
    
• On success, responds with DisassociateChannelFlowOutput
• On failure, responds with SdkError<DisassociateChannelFlowError>

impl Client

pub fn get_channel_membership_preferences( &self, ) -> GetChannelMembershipPreferencesFluentBuilder

Constructs a fluent builder for the GetChannelMembershipPreferences operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The AppInstanceUserArn of the member retrieving the preferences.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with GetChannelMembershipPreferencesOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • member(Option<Identity>):

    The details of a user.

  • preferences(Option<ChannelMembershipPreferences>):

    The channel membership preferences for an AppInstanceUser .

• On failure, responds with SdkError<GetChannelMembershipPreferencesError>

impl Client

pub fn get_channel_message(&self) -> GetChannelMessageFluentBuilder

Constructs a fluent builder for the GetChannelMessage operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The ID of the message.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when getting messages in a SubChannel that the user belongs to.

    
    
• On success, responds with GetChannelMessageOutput with field(s):
  • channel_message(Option<ChannelMessage>):

    The details of and content in the message.

• On failure, responds with SdkError<GetChannelMessageError>

impl Client

pub fn get_channel_message_status(&self) -> GetChannelMessageStatusFluentBuilder

Constructs a fluent builder for the GetChannelMessageStatus operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The ID of the message.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The AppInstanceUserArn of the user making the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when getting message status in a SubChannel that the user belongs to.

    
    
• On success, responds with GetChannelMessageStatusOutput with field(s):
  • status(Option<ChannelMessageStatusStructure>):

    The message status and details.

• On failure, responds with SdkError<GetChannelMessageStatusError>

impl Client

pub fn get_messaging_session_endpoint( &self, ) -> GetMessagingSessionEndpointFluentBuilder

Constructs a fluent builder for the GetMessagingSessionEndpoint operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetMessagingSessionEndpointOutput with field(s):
  • endpoint(Option<MessagingSessionEndpoint>):

    The endpoint returned in the response.

• On failure, responds with SdkError<GetMessagingSessionEndpointError>

impl Client

pub fn get_messaging_streaming_configurations( &self, ) -> GetMessagingStreamingConfigurationsFluentBuilder

Constructs a fluent builder for the GetMessagingStreamingConfigurations operation.

• The fluent builder is configurable:
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the streaming configurations.

    
    
• On success, responds with GetMessagingStreamingConfigurationsOutput with field(s):
  • streaming_configurations(Option<Vec::<StreamingConfiguration>>):

    The streaming settings.

• On failure, responds with SdkError<GetMessagingStreamingConfigurationsError>

impl Client

pub fn list_channel_bans(&self) -> ListChannelBansFluentBuilder

Constructs a fluent builder for the ListChannelBans operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of bans that you want returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested bans are returned.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with ListChannelBansOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested bans are returned.

  • channel_bans(Option<Vec::<ChannelBanSummary>>):

    The information for each requested ban.

• On failure, responds with SdkError<ListChannelBansError>

impl Client

pub fn list_channel_flows(&self) -> ListChannelFlowsFluentBuilder

Constructs a fluent builder for the ListChannelFlows operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the app instance.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channel flows that you want to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested channel flows are returned.

    
    
• On success, responds with ListChannelFlowsOutput with field(s):
  • channel_flows(Option<Vec::<ChannelFlowSummary>>):

    The information about each channel flow.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested channels are returned.

• On failure, responds with SdkError<ListChannelFlowsError>

impl Client

pub fn list_channel_memberships(&self) -> ListChannelMembershipsFluentBuilder

Constructs a fluent builder for the ListChannelMemberships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The maximum number of channel memberships that you want returned.

    
    
  • r#type(ChannelMembershipType) / set_type(Option<ChannelMembershipType>):
    required: false
    

    The membership type of a user, DEFAULT or HIDDEN. Default members are returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channel memberships that you want returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested channel memberships are returned.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when listing a user’s memberships in a particular sub-channel of an elastic channel.

    
    
• On success, responds with ListChannelMembershipsOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • channel_memberships(Option<Vec::<ChannelMembershipSummary>>):

    The information for the requested channel memberships.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested channel memberships are returned.

• On failure, responds with SdkError<ListChannelMembershipsError>

impl Client

pub fn list_channel_memberships_for_app_instance_user( &self, ) -> ListChannelMembershipsForAppInstanceUserFluentBuilder

Constructs a fluent builder for the ListChannelMembershipsForAppInstanceUser operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • app_instance_user_arn(impl Into<String>) / set_app_instance_user_arn(Option<String>):
    required: false
    

    The ARN of the user or bot.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of users that you want returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned from previous API requests until the number of channel memberships is reached.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with ListChannelMembershipsForAppInstanceUserOutput with field(s):
  • channel_memberships(Option<Vec::<ChannelMembershipForAppInstanceUserSummary>>):

    The information for the requested channel memberships.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested users are returned.

• On failure, responds with SdkError<ListChannelMembershipsForAppInstanceUserError>

impl Client

pub fn list_channel_messages(&self) -> ListChannelMessagesFluentBuilder

Constructs a fluent builder for the ListChannelMessages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The order in which you want messages sorted. Default is Descending, based on time created.

    
    
  • not_before(DateTime) / set_not_before(Option<DateTime>):
    required: false
    

    The initial or starting time stamp for your requested messages.

    
    
  • not_after(DateTime) / set_not_after(Option<DateTime>):
    required: false
    

    The final or ending time stamp for your requested messages.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of messages that you want returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested messages are returned.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when listing the messages in a SubChannel that the user belongs to.

    
    
• On success, responds with ListChannelMessagesOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel containing the requested messages.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested messages are returned.

  • channel_messages(Option<Vec::<ChannelMessageSummary>>):

    The information about, and content of, each requested message.

  • sub_channel_id(Option<String>):

    The ID of the SubChannel in the response.

• On failure, responds with SdkError<ListChannelMessagesError>

impl Client

pub fn list_channel_moderators(&self) -> ListChannelModeratorsFluentBuilder

Constructs a fluent builder for the ListChannelModerators operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of moderators that you want returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested moderators are returned.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with ListChannelModeratorsOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested moderators are returned.

  • channel_moderators(Option<Vec::<ChannelModeratorSummary>>):

    The information about and names of each moderator.

• On failure, responds with SdkError<ListChannelModeratorsError>

impl Client

pub fn list_channels(&self) -> ListChannelsFluentBuilder

Constructs a fluent builder for the ListChannels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the AppInstance.

    
    
  • privacy(ChannelPrivacy) / set_privacy(Option<ChannelPrivacy>):
    required: false
    

    The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channels that you want to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested channels are returned.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with ListChannelsOutput with field(s):
  • channels(Option<Vec::<ChannelSummary>>):

    The information about each channel.

  • next_token(Option<String>):

    The token returned from previous API requests until the number of channels is reached.

• On failure, responds with SdkError<ListChannelsError>

impl Client

pub fn list_channels_associated_with_channel_flow( &self, ) -> ListChannelsAssociatedWithChannelFlowFluentBuilder

Constructs a fluent builder for the ListChannelsAssociatedWithChannelFlow operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_flow_arn(impl Into<String>) / set_channel_flow_arn(Option<String>):
    required: true
    

    The ARN of the channel flow.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channels that you want to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested channels are returned.

    
    
• On success, responds with ListChannelsAssociatedWithChannelFlowOutput with field(s):
  • channels(Option<Vec::<ChannelAssociatedWithFlowSummary>>):

    The information about each channel.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested channels are returned.

• On failure, responds with SdkError<ListChannelsAssociatedWithChannelFlowError>

impl Client

pub fn list_channels_moderated_by_app_instance_user( &self, ) -> ListChannelsModeratedByAppInstanceUserFluentBuilder

Constructs a fluent builder for the ListChannelsModeratedByAppInstanceUser operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • app_instance_user_arn(impl Into<String>) / set_app_instance_user_arn(Option<String>):
    required: false
    

    The ARN of the user or bot in the moderated channel.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channels in the request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned from previous API requests until the number of channels moderated by the user is reached.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with ListChannelsModeratedByAppInstanceUserOutput with field(s):
  • channels(Option<Vec::<ChannelModeratedByAppInstanceUserSummary>>):

    The moderated channels in the request.

  • next_token(Option<String>):

    The token returned from previous API requests until the number of channels moderated by the user is reached.

• On failure, responds with SdkError<ListChannelsModeratedByAppInstanceUserError>

impl Client

pub fn list_sub_channels(&self) -> ListSubChannelsFluentBuilder

Constructs a fluent builder for the ListSubChannels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of elastic channel.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The AppInstanceUserArn of the user making the API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of sub-channels that you want to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token passed by previous API calls until all requested sub-channels are returned.

    
    
• On success, responds with ListSubChannelsOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of elastic channel.

  • sub_channels(Option<Vec::<SubChannelSummary>>):

    The information about each sub-channel.

  • next_token(Option<String>):

    The token passed by previous API calls until all requested sub-channels are returned.

• On failure, responds with SdkError<ListSubChannelsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tag key-value pairs.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_channel_expiration_settings( &self, ) -> PutChannelExpirationSettingsFluentBuilder

Constructs a fluent builder for the PutChannelExpirationSettings operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: false
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • expiration_settings(ExpirationSettings) / set_expiration_settings(Option<ExpirationSettings>):
    required: false
    

    Settings that control the interval after which a channel is deleted.

    
    
• On success, responds with PutChannelExpirationSettingsOutput with field(s):
  • channel_arn(Option<String>):

    The channel ARN.

  • expiration_settings(Option<ExpirationSettings>):

    Settings that control the interval after which a channel is deleted.

• On failure, responds with SdkError<PutChannelExpirationSettingsError>

impl Client

pub fn put_channel_membership_preferences( &self, ) -> PutChannelMembershipPreferencesFluentBuilder

Constructs a fluent builder for the PutChannelMembershipPreferences operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • member_arn(impl Into<String>) / set_member_arn(Option<String>):
    required: true
    

    The ARN of the member setting the preferences.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • preferences(ChannelMembershipPreferences) / set_preferences(Option<ChannelMembershipPreferences>):
    required: true
    

    The channel membership preferences of an AppInstanceUser .

    
    
• On success, responds with PutChannelMembershipPreferencesOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • member(Option<Identity>):

    The details of a user.

  • preferences(Option<ChannelMembershipPreferences>):

    The ARN and metadata of the member being added.

• On failure, responds with SdkError<PutChannelMembershipPreferencesError>

impl Client

pub fn put_messaging_streaming_configurations( &self, ) -> PutMessagingStreamingConfigurationsFluentBuilder

Constructs a fluent builder for the PutMessagingStreamingConfigurations operation.

• The fluent builder is configurable:
  • app_instance_arn(impl Into<String>) / set_app_instance_arn(Option<String>):
    required: true
    

    The ARN of the streaming configuration.

    
    
  • streaming_configurations(StreamingConfiguration) / set_streaming_configurations(Option<Vec::<StreamingConfiguration>>):
    required: true
    

    The streaming configurations.

    
    
• On success, responds with PutMessagingStreamingConfigurationsOutput with field(s):
  • streaming_configurations(Option<Vec::<StreamingConfiguration>>):

    The requested streaming configurations.

• On failure, responds with SdkError<PutMessagingStreamingConfigurationsError>

impl Client

pub fn redact_channel_message(&self) -> RedactChannelMessageFluentBuilder

Constructs a fluent builder for the RedactChannelMessage operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel containing the messages that you want to redact.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The ID of the message being redacted.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    
    
• On success, responds with RedactChannelMessageOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel containing the messages that you want to redact.

  • message_id(Option<String>):

    The ID of the message being redacted.

  • sub_channel_id(Option<String>):

    The ID of the SubChannel in the response.

    Only required when redacting messages in a SubChannel that the user belongs to.

• On failure, responds with SdkError<RedactChannelMessageError>

impl Client

pub fn search_channels(&self) -> SearchChannelsFluentBuilder

Constructs a fluent builder for the SearchChannels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: false
    

    The AppInstanceUserArn of the user making the API call.

    
    
  • fields(SearchField) / set_fields(Option<Vec::<SearchField>>):
    required: true
    

    A list of the Field objects in the channel being searched.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of channels that you want returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned from previous API requests until the number of channels is reached.

    
    
• On success, responds with SearchChannelsOutput with field(s):
  • channels(Option<Vec::<ChannelSummary>>):

    A list of the channels in the request.

  • next_token(Option<String>):

    The token returned from previous API responses until the number of channels is reached.

• On failure, responds with SdkError<SearchChannelsError>

impl Client

pub fn send_channel_message(&self) -> SendChannelMessageFluentBuilder

Constructs a fluent builder for the SendChannelMessage operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The content of the channel message.

    
    
  • r#type(ChannelMessageType) / set_type(Option<ChannelMessageType>):
    required: true
    

    The type of message, STANDARD or CONTROL.

    STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

    CONTROL messages are limited to 30 bytes and do not contain metadata.

    
    
  • persistence(ChannelMessagePersistenceType) / set_persistence(Option<ChannelMessagePersistenceType>):
    required: true
    

    Boolean that controls whether the message is persisted on the back end. Required.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: false
    

    The optional metadata for each message.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    The Idempotency token for each client request.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • push_notification(PushNotificationConfiguration) / set_push_notification(Option<PushNotificationConfiguration>):
    required: false
    

    The push notification configuration of the message.

    
    
  • message_attributes(impl Into<String>, MessageAttributeValue) / set_message_attributes(Option<HashMap::<String, MessageAttributeValue>>):
    required: false
    

    The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The content type of the channel message.

    
    
  • target(Target) / set_target(Option<Vec::<Target>>):
    required: false
    

    The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

    
    
• On success, responds with SendChannelMessageOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • message_id(Option<String>):

    The ID string assigned to each message.

  • status(Option<ChannelMessageStatusStructure>):

    The status of the channel message.

  • sub_channel_id(Option<String>):

    The ID of the SubChannel in the response.

• On failure, responds with SdkError<SendChannelMessageError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource ARN.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tag key-value pairs.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource ARN.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_channel(&self) -> UpdateChannelFluentBuilder

Constructs a fluent builder for the UpdateChannel operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the channel.

    
    
  • mode(ChannelMode) / set_mode(Option<ChannelMode>):
    required: false
    

    The mode of the update request.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: false
    

    The metadata for the update request.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with UpdateChannelOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

• On failure, responds with SdkError<UpdateChannelError>

impl Client

pub fn update_channel_flow(&self) -> UpdateChannelFlowFluentBuilder

Constructs a fluent builder for the UpdateChannelFlow operation.

• The fluent builder is configurable:
  • channel_flow_arn(impl Into<String>) / set_channel_flow_arn(Option<String>):
    required: true
    

    The ARN of the channel flow.

    
    
  • processors(Processor) / set_processors(Option<Vec::<Processor>>):
    required: true
    

    Information about the processor Lambda functions

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the channel flow.

    
    
• On success, responds with UpdateChannelFlowOutput with field(s):
  • channel_flow_arn(Option<String>):

    The ARN of the channel flow.

• On failure, responds with SdkError<UpdateChannelFlowError>

impl Client

pub fn update_channel_message(&self) -> UpdateChannelMessageFluentBuilder

Constructs a fluent builder for the UpdateChannelMessage operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The ID string of the message being updated.

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The content of the channel message.

    
    
  • metadata(impl Into<String>) / set_metadata(Option<String>):
    required: false
    

    The metadata of the message being updated.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
  • sub_channel_id(impl Into<String>) / set_sub_channel_id(Option<String>):
    required: false
    

    The ID of the SubChannel in the request.

    Only required when updating messages in a SubChannel that the user belongs to.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The content type of the channel message.

    
    
• On success, responds with UpdateChannelMessageOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

  • message_id(Option<String>):

    The ID string of the message being updated.

  • status(Option<ChannelMessageStatusStructure>):

    The status of the message update.

  • sub_channel_id(Option<String>):

    The ID of the SubChannel in the response.

• On failure, responds with SdkError<UpdateChannelMessageError>

impl Client

pub fn update_channel_read_marker(&self) -> UpdateChannelReadMarkerFluentBuilder

Constructs a fluent builder for the UpdateChannelReadMarker operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The ARN of the channel.

    
    
  • chime_bearer(impl Into<String>) / set_chime_bearer(Option<String>):
    required: true
    

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    
    
• On success, responds with UpdateChannelReadMarkerOutput with field(s):
  • channel_arn(Option<String>):

    The ARN of the channel.

• On failure, responds with SdkError<UpdateChannelReadMarkerError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.