Struct aws_sdk_chimesdkmessaging::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
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>
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>
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>
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.
- On success, responds with
CreateChannelOutput
with field(s):channel_arn(Option<String>)
:The ARN of the channel.
- On failure, responds with
SdkError<CreateChannelError>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
pub fn describe_channel_membership_for_app_instance_user(
&self
) -> DescribeChannelMembershipForAppInstanceUser<C, M, R>
pub fn describe_channel_membership_for_app_instance_user(
&self
) -> DescribeChannelMembershipForAppInstanceUser<C, M, R>
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>
pub fn describe_channel_moderated_by_app_instance_user(
&self
) -> DescribeChannelModeratedByAppInstanceUser<C, M, R>
pub fn describe_channel_moderated_by_app_instance_user(
&self
) -> DescribeChannelModeratedByAppInstanceUser<C, M, R>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
pub fn list_channel_memberships_for_app_instance_user(
&self
) -> ListChannelMembershipsForAppInstanceUser<C, M, R>
pub fn list_channel_memberships_for_app_instance_user(
&self
) -> ListChannelMembershipsForAppInstanceUser<C, M, R>
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 token passed by previous API calls until all requested users are returned.
next_token(Option<String>)
:The token passed by previous API calls until all requested users are returned.
- On failure, responds with
SdkError<ListChannelMembershipsForAppInstanceUserError>
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>
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>
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>
pub fn list_channels_associated_with_channel_flow(
&self
) -> ListChannelsAssociatedWithChannelFlow<C, M, R>
pub fn list_channels_associated_with_channel_flow(
&self
) -> ListChannelsAssociatedWithChannelFlow<C, M, R>
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>
pub fn list_channels_moderated_by_app_instance_user(
&self
) -> ListChannelsModeratedByAppInstanceUser<C, M, R>
pub fn list_channels_moderated_by_app_instance_user(
&self
) -> ListChannelsModeratedByAppInstanceUser<C, M, R>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more