Struct aws_sdk_chimesdkmessaging::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_chimesdkmessaging::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_chimesdkmessaging::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_chimesdkmessaging::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn associate_channel_flow(&self) -> AssociateChannelFlow
pub fn associate_channel_flow(&self) -> AssociateChannelFlow
Constructs a fluent builder for the AssociateChannelFlow
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_flow_arn(impl Into<String>)
/set_channel_flow_arn(Option<String>)
:The ARN of the channel flow.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user making the API call.
- On success, responds with
AssociateChannelFlowOutput
- On failure, responds with
SdkError<AssociateChannelFlowError>
sourcepub fn batch_create_channel_membership(&self) -> BatchCreateChannelMembership
pub fn batch_create_channel_membership(&self) -> BatchCreateChannelMembership
Constructs a fluent builder for the BatchCreateChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel to which you’re adding users.
r#type(ChannelMembershipType)
/set_type(Option<ChannelMembershipType>)
:The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.member_arns(Vec<String>)
/set_member_arns(Option<Vec<String>>)
:The
AppInstanceUserArn
s of the members you want to add to the channel.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- 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>
sourcepub fn channel_flow_callback(&self) -> ChannelFlowCallback
pub fn channel_flow_callback(&self) -> ChannelFlowCallback
Constructs a fluent builder for the ChannelFlowCallback
operation.
- The fluent builder is configurable:
callback_id(impl Into<String>)
/set_callback_id(Option<String>)
: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>)
:The ARN of the channel.
delete_resource(bool)
/set_delete_resource(bool)
: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>)
: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>
sourcepub fn create_channel(&self) -> CreateChannel
pub fn create_channel(&self) -> CreateChannel
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>)
:The ARN of the channel request.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the channel.
mode(ChannelMode)
/set_mode(Option<ChannelMode>)
:The channel mode:
UNRESTRICTED
orRESTRICTED
. 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>)
:The channel’s privacy level:
PUBLIC
orPRIVATE
. Private channels aren’t discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance
.metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata of the creation request. Limited to 1KB and UTF-8.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The client token for the request. An
Idempotency
token.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags for the creation request.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:The ID of the channel in the request.
member_arns(Vec<String>)
/set_member_arns(Option<Vec<String>>)
:The ARNs of the channel members in the request.
moderator_arns(Vec<String>)
/set_moderator_arns(Option<Vec<String>>)
:The ARNs of the channel moderators in the request.
- On success, responds with
CreateChannelOutput
with field(s):channel_arn(Option<String>)
:The ARN of the channel.
- On failure, responds with
SdkError<CreateChannelError>
sourcepub fn create_channel_ban(&self) -> CreateChannelBan
pub fn create_channel_ban(&self) -> CreateChannelBan
Constructs a fluent builder for the CreateChannelBan
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the ban request.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The
AppInstanceUserArn
of the member being banned.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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
andBannedIdentity
of the member in the ban response.
- On failure, responds with
SdkError<CreateChannelBanError>
sourcepub fn create_channel_flow(&self) -> CreateChannelFlow
pub fn create_channel_flow(&self) -> CreateChannelFlow
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>)
:The ARN of the channel flow request.
processors(Vec<Processor>)
/set_processors(Option<Vec<Processor>>)
:Information about the processor Lambda functions.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the channel flow.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags for the creation request.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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>
sourcepub fn create_channel_membership(&self) -> CreateChannelMembership
pub fn create_channel_membership(&self) -> CreateChannelMembership
Constructs a fluent builder for the CreateChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel to which you’re adding users.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The
AppInstanceUserArn
of the member you want to add to the channel.r#type(ChannelMembershipType)
/set_type(Option<ChannelMembershipType>)
:The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- 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.
- On failure, responds with
SdkError<CreateChannelMembershipError>
sourcepub fn create_channel_moderator(&self) -> CreateChannelModerator
pub fn create_channel_moderator(&self) -> CreateChannelModerator
Constructs a fluent builder for the CreateChannelModerator
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_moderator_arn(impl Into<String>)
/set_channel_moderator_arn(Option<String>)
:The
AppInstanceUserArn
of the moderator.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn delete_channel(&self) -> DeleteChannel
pub fn delete_channel(&self) -> DeleteChannel
Constructs a fluent builder for the DeleteChannel
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel being deleted.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelOutput
- On failure, responds with
SdkError<DeleteChannelError>
sourcepub fn delete_channel_ban(&self) -> DeleteChannelBan
pub fn delete_channel_ban(&self) -> DeleteChannelBan
Constructs a fluent builder for the DeleteChannelBan
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel from which the
AppInstanceUser
was banned.member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The ARN of the
AppInstanceUser
that you want to reinstate.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelBanOutput
- On failure, responds with
SdkError<DeleteChannelBanError>
sourcepub fn delete_channel_flow(&self) -> DeleteChannelFlow
pub fn delete_channel_flow(&self) -> DeleteChannelFlow
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>)
:The ARN of the channel flow.
- On success, responds with
DeleteChannelFlowOutput
- On failure, responds with
SdkError<DeleteChannelFlowError>
sourcepub fn delete_channel_membership(&self) -> DeleteChannelMembership
pub fn delete_channel_membership(&self) -> DeleteChannelMembership
Constructs a fluent builder for the DeleteChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel from which you want to remove the user.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The
AppInstanceUserArn
of the member that you’re removing from the channel.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelMembershipOutput
- On failure, responds with
SdkError<DeleteChannelMembershipError>
sourcepub fn delete_channel_message(&self) -> DeleteChannelMessage
pub fn delete_channel_message(&self) -> DeleteChannelMessage
Constructs a fluent builder for the DeleteChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID of the message being deleted.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelMessageOutput
- On failure, responds with
SdkError<DeleteChannelMessageError>
sourcepub fn delete_channel_moderator(&self) -> DeleteChannelModerator
pub fn delete_channel_moderator(&self) -> DeleteChannelModerator
Constructs a fluent builder for the DeleteChannelModerator
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_moderator_arn(impl Into<String>)
/set_channel_moderator_arn(Option<String>)
:The
AppInstanceUserArn
of the moderator being deleted.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelModeratorOutput
- On failure, responds with
SdkError<DeleteChannelModeratorError>
sourcepub fn describe_channel(&self) -> DescribeChannel
pub fn describe_channel(&self) -> DescribeChannel
Constructs a fluent builder for the DescribeChannel
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn describe_channel_ban(&self) -> DescribeChannelBan
pub fn describe_channel_ban(&self) -> DescribeChannelBan
Constructs a fluent builder for the DescribeChannelBan
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel from which the user is banned.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The
AppInstanceUserArn
of the member being banned.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn describe_channel_flow(&self) -> DescribeChannelFlow
pub fn describe_channel_flow(&self) -> DescribeChannelFlow
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>)
: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>
sourcepub fn describe_channel_membership(&self) -> DescribeChannelMembership
pub fn describe_channel_membership(&self) -> DescribeChannelMembership
Constructs a fluent builder for the DescribeChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The
AppInstanceUserArn
of the member.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DescribeChannelMembershipOutput
with field(s):channel_membership(Option<ChannelMembership>)
:The details of the membership.
- On failure, responds with
SdkError<DescribeChannelMembershipError>
sourcepub fn describe_channel_membership_for_app_instance_user(
&self
) -> DescribeChannelMembershipForAppInstanceUser
pub fn describe_channel_membership_for_app_instance_user(
&self
) -> DescribeChannelMembershipForAppInstanceUser
Constructs a fluent builder for the DescribeChannelMembershipForAppInstanceUser
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel to which the user belongs.
app_instance_user_arn(impl Into<String>)
/set_app_instance_user_arn(Option<String>)
:The ARN of the user in a channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn describe_channel_moderated_by_app_instance_user(
&self
) -> DescribeChannelModeratedByAppInstanceUser
pub fn describe_channel_moderated_by_app_instance_user(
&self
) -> DescribeChannelModeratedByAppInstanceUser
Constructs a fluent builder for the DescribeChannelModeratedByAppInstanceUser
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the moderated channel.
app_instance_user_arn(impl Into<String>)
/set_app_instance_user_arn(Option<String>)
:The ARN of the
AppInstanceUser
in the moderated channel.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn describe_channel_moderator(&self) -> DescribeChannelModerator
pub fn describe_channel_moderator(&self) -> DescribeChannelModerator
Constructs a fluent builder for the DescribeChannelModerator
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_moderator_arn(impl Into<String>)
/set_channel_moderator_arn(Option<String>)
:The
AppInstanceUserArn
of the channel moderator.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn disassociate_channel_flow(&self) -> DisassociateChannelFlow
pub fn disassociate_channel_flow(&self) -> DisassociateChannelFlow
Constructs a fluent builder for the DisassociateChannelFlow
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_flow_arn(impl Into<String>)
/set_channel_flow_arn(Option<String>)
:The ARN of the channel flow.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user making the API call.
- On success, responds with
DisassociateChannelFlowOutput
- On failure, responds with
SdkError<DisassociateChannelFlowError>
sourcepub fn get_channel_membership_preferences(
&self
) -> GetChannelMembershipPreferences
pub fn get_channel_membership_preferences(
&self
) -> GetChannelMembershipPreferences
Constructs a fluent builder for the GetChannelMembershipPreferences
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The
AppInstanceUserArn
of the member retrieving the preferences.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserARN
of the user making 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>
sourcepub fn get_channel_message(&self) -> GetChannelMessage
pub fn get_channel_message(&self) -> GetChannelMessage
Constructs a fluent builder for the GetChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID of the message.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- 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>
sourcepub fn get_channel_message_status(&self) -> GetChannelMessageStatus
pub fn get_channel_message_status(&self) -> GetChannelMessageStatus
Constructs a fluent builder for the GetChannelMessageStatus
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID of the message.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user making the API call.
- On success, responds with
GetChannelMessageStatusOutput
with field(s):status(Option<ChannelMessageStatusStructure>)
:The message status and details.
- On failure, responds with
SdkError<GetChannelMessageStatusError>
sourcepub fn get_messaging_session_endpoint(&self) -> GetMessagingSessionEndpoint
pub fn get_messaging_session_endpoint(&self) -> GetMessagingSessionEndpoint
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>
sourcepub fn list_channel_bans(&self) -> ListChannelBans
pub fn list_channel_bans(&self) -> ListChannelBans
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>)
:The ARN of the channel.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of bans that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested bans are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn list_channel_flows(&self) -> ListChannelFlows
pub fn list_channel_flows(&self) -> ListChannelFlows
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>)
:The ARN of the app instance.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channel flows that you want to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_channel_memberships(&self) -> ListChannelMemberships
pub fn list_channel_memberships(&self) -> ListChannelMemberships
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>)
:The maximum number of channel memberships that you want returned.
r#type(ChannelMembershipType)
/set_type(Option<ChannelMembershipType>)
:The membership type of a user,
DEFAULT
orHIDDEN
. Default members are returned as part ofListChannelMemberships
if no type is specified. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channel memberships that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested channel memberships are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- 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>
sourcepub fn list_channel_memberships_for_app_instance_user(
&self
) -> ListChannelMembershipsForAppInstanceUser
pub fn list_channel_memberships_for_app_instance_user(
&self
) -> ListChannelMembershipsForAppInstanceUser
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>)
:The ARN of the
AppInstanceUser
smax_results(i32)
/set_max_results(Option<i32>)
:The maximum number of users that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn list_channel_messages(&self) -> ListChannelMessages
pub fn list_channel_messages(&self) -> ListChannelMessages
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>)
:The ARN of the channel.
sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:The order in which you want messages sorted. Default is Descending, based on time created.
not_before(DateTime)
/set_not_before(Option<DateTime>)
:The initial or starting time stamp for your requested messages.
not_after(DateTime)
/set_not_after(Option<DateTime>)
:The final or ending time stamp for your requested messages.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of messages that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested messages are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- 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.
- On failure, responds with
SdkError<ListChannelMessagesError>
sourcepub fn list_channel_moderators(&self) -> ListChannelModerators
pub fn list_channel_moderators(&self) -> ListChannelModerators
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>)
:The ARN of the channel.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of moderators that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested moderators are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn list_channels(&self) -> ListChannels
pub fn list_channels(&self) -> ListChannels
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>)
:The ARN of the
AppInstance
.privacy(ChannelPrivacy)
/set_privacy(Option<ChannelPrivacy>)
:The privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channels that you want to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested channels are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn list_channels_associated_with_channel_flow(
&self
) -> ListChannelsAssociatedWithChannelFlow
pub fn list_channels_associated_with_channel_flow(
&self
) -> ListChannelsAssociatedWithChannelFlow
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>)
:The ARN of the channel flow.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channels that you want to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_channels_moderated_by_app_instance_user(
&self
) -> ListChannelsModeratedByAppInstanceUser
pub fn list_channels_moderated_by_app_instance_user(
&self
) -> ListChannelsModeratedByAppInstanceUser
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>)
:The ARN of the user in the moderated channel.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channels in the request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
:The
AppInstanceUserArn
of the user 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>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
: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>
sourcepub fn put_channel_membership_preferences(
&self
) -> PutChannelMembershipPreferences
pub fn put_channel_membership_preferences(
&self
) -> PutChannelMembershipPreferences
Constructs a fluent builder for the PutChannelMembershipPreferences
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The
AppInstanceUserArn
of the member setting the preferences.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserARN
of the user making the API call.preferences(ChannelMembershipPreferences)
/set_preferences(Option<ChannelMembershipPreferences>)
: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>
sourcepub fn redact_channel_message(&self) -> RedactChannelMessage
pub fn redact_channel_message(&self) -> RedactChannelMessage
Constructs a fluent builder for the RedactChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel containing the messages that you want to redact.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID of the message being redacted.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- 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.
- On failure, responds with
SdkError<RedactChannelMessageError>
sourcepub fn search_channels(&self) -> SearchChannels
pub fn search_channels(&self) -> SearchChannels
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>)
:The
AppInstanceUserArn
of the user making the API call.fields(Vec<SearchField>)
/set_fields(Option<Vec<SearchField>>)
:A list of the
Field
objects in the channel being searched.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channels that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn send_channel_message(&self) -> SendChannelMessage
pub fn send_channel_message(&self) -> SendChannelMessage
Constructs a fluent builder for the SendChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the message.
r#type(ChannelMessageType)
/set_type(Option<ChannelMessageType>)
:The type of message,
STANDARD
orCONTROL
.persistence(ChannelMessagePersistenceType)
/set_persistence(Option<ChannelMessagePersistenceType>)
:Boolean that controls whether the message is persisted on the back end. Required.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The optional metadata for each message.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The
Idempotency
token for each client request.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.push_notification(PushNotificationConfiguration)
/set_push_notification(Option<PushNotificationConfiguration>)
:The push notification configuration of the message.
message_attributes(HashMap<String, MessageAttributeValue>)
/set_message_attributes(Option<HashMap<String, MessageAttributeValue>>)
:The attributes for the message, used for message filtering along with a
FilterRule
defined in thePushNotificationPreferences
.
- 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.
- On failure, responds with
SdkError<SendChannelMessageError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_channel(&self) -> UpdateChannel
pub fn update_channel(&self) -> UpdateChannel
Constructs a fluent builder for the UpdateChannel
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the channel.
mode(ChannelMode)
/set_mode(Option<ChannelMode>)
:The mode of the update request.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata for the update request.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourcepub fn update_channel_flow(&self) -> UpdateChannelFlow
pub fn update_channel_flow(&self) -> UpdateChannelFlow
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>)
:The ARN of the channel flow.
processors(Vec<Processor>)
/set_processors(Option<Vec<Processor>>)
:Information about the processor Lambda functions
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn update_channel_message(&self) -> UpdateChannelMessage
pub fn update_channel_message(&self) -> UpdateChannelMessage
Constructs a fluent builder for the UpdateChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID string of the message being updated.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the message being updated.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata of the message being updated.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- 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.
- On failure, responds with
SdkError<UpdateChannelMessageError>
sourcepub fn update_channel_read_marker(&self) -> UpdateChannelReadMarker
pub fn update_channel_read_marker(&self) -> UpdateChannelReadMarker
Constructs a fluent builder for the UpdateChannelReadMarker
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user 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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more