Chime Sdk Messaging

This page documents function available when using the Chime_Sdk_Messaging module, created with @service Chime_Sdk_Messaging.

Index

Documentation

Main.Chime_Sdk_Messaging.associate_channel_flowMethod
associate_channel_flow(channel_flow_arn, channel_arn, x-amz-chime-bearer)
associate_channel_flow(channel_flow_arn, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API. Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_flow_arn: The ARN of the channel flow.
  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The AppInstanceUserArn of the user making the API call.
Main.Chime_Sdk_Messaging.batch_create_channel_membershipMethod
batch_create_channel_membership(member_arns, channel_arn, x-amz-chime-bearer)
batch_create_channel_membership(member_arns, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Adds a specified number of users and bots to a channel.

Arguments

  • member_arns: The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.
  • channel_arn: The ARN of the channel to which you're adding users or bots.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SubChannelId": The ID of the SubChannel in the request. Only required when creating membership in a SubChannel for a moderator in an elastic channel.
  • "Type": 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.
Main.Chime_Sdk_Messaging.channel_flow_callbackMethod
channel_flow_callback(callback_id, channel_message, channel_arn)
channel_flow_callback(callback_id, channel_message, channel_arn, params::Dict{String,<:Any})

Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. You can return one of the following processing responses: Update message content or metadata Deny a message Make no changes to the message

Arguments

  • callback_id: The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.
  • channel_message: Stores information about the processed message.
  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeleteResource": When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.
Main.Chime_Sdk_Messaging.create_channelMethod
create_channel(app_instance_arn, client_request_token, name, x-amz-chime-bearer)
create_channel(app_instance_arn, client_request_token, name, x-amz-chime-bearer, params::Dict{String,<:Any})

Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • app_instance_arn: The ARN of the channel request.
  • client_request_token: The client token for the request. An Idempotency token.
  • name: The name of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ChannelId": The ID of the channel in the request.
  • "ElasticChannelConfiguration": The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
  • "ExpirationSettings": Settings that control the interval after which the channel is automatically deleted.
  • "MemberArns": The ARNs of the channel members in the request.
  • "Metadata": The metadata of the creation request. Limited to 1KB and UTF-8.
  • "Mode": 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.
  • "ModeratorArns": The ARNs of the channel moderators in the request.
  • "Privacy": 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.
  • "Tags": The tags for the creation request.
Main.Chime_Sdk_Messaging.create_channel_banMethod
create_channel_ban(member_arn, channel_arn, x-amz-chime-bearer)
create_channel_ban(member_arn, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • member_arn: The AppInstanceUserArn of the member being banned.
  • channel_arn: The ARN of the ban request.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.create_channel_flowMethod
create_channel_flow(app_instance_arn, client_request_token, name, processors)
create_channel_flow(app_instance_arn, client_request_token, name, processors, params::Dict{String,<:Any})

Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API. Channel flows process the following items: New and updated messages Persistent and non-persistent messages The Standard message type Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide.

Arguments

  • app_instance_arn: The ARN of the channel flow request.
  • client_request_token: The client token for the request. An Idempotency token.
  • name: The name of the channel flow.
  • processors: Information about the processor Lambda functions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": The tags for the creation request.
Main.Chime_Sdk_Messaging.create_channel_membershipMethod
create_channel_membership(member_arn, type, channel_arn, x-amz-chime-bearer)
create_channel_membership(member_arn, type, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • member_arn: The AppInstanceUserArn of the member you want to add to the channel.
  • type: 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.
  • channel_arn: The ARN of the channel to which you're adding users.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SubChannelId": The ID of the SubChannel in the request. Only required when creating membership in a SubChannel for a moderator in an elastic channel.
Main.Chime_Sdk_Messaging.create_channel_moderatorMethod
create_channel_moderator(channel_moderator_arn, channel_arn, x-amz-chime-bearer)
create_channel_moderator(channel_moderator_arn, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in the header.

Arguments

  • channel_moderator_arn: The AppInstanceUserArn of the moderator.
  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.delete_channelMethod
delete_channel(channel_arn, x-amz-chime-bearer)
delete_channel(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel being deleted.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.delete_channel_banMethod
delete_channel_ban(channel_arn, member_arn, x-amz-chime-bearer)
delete_channel_ban(channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Removes a member from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel from which the AppInstanceUser was banned.
  • member_arn: The ARN of the AppInstanceUser that you want to reinstate.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.delete_channel_flowMethod
delete_channel_flow(channel_flow_arn)
delete_channel_flow(channel_flow_arn, params::Dict{String,<:Any})

Deletes a channel flow, an irreversible process. This is a developer API. This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

Arguments

  • channel_flow_arn: The ARN of the channel flow.
Main.Chime_Sdk_Messaging.delete_channel_membershipMethod
delete_channel_membership(channel_arn, member_arn, x-amz-chime-bearer)
delete_channel_membership(channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

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

Arguments

  • channel_arn: The ARN of the channel from which you want to remove the user.
  • member_arn: The AppInstanceUserArn of the member that you're removing from the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sub-channel-id": The ID of the SubChannel in the request. Only for use by moderators.
Main.Chime_Sdk_Messaging.delete_channel_messageMethod
delete_channel_message(channel_arn, message_id, x-amz-chime-bearer)
delete_channel_message(channel_arn, message_id, x-amz-chime-bearer, params::Dict{String,<:Any})

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • message_id: The ID of the message being deleted.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sub-channel-id": The ID of the SubChannel in the request. Only required when deleting messages in a SubChannel that the user belongs to.
Main.Chime_Sdk_Messaging.delete_channel_moderatorMethod
delete_channel_moderator(channel_arn, channel_moderator_arn, x-amz-chime-bearer)
delete_channel_moderator(channel_arn, channel_moderator_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • channel_moderator_arn: The AppInstanceUserArn of the moderator being deleted.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.delete_messaging_streaming_configurationsMethod
delete_messaging_streaming_configurations(app_instance_arn)
delete_messaging_streaming_configurations(app_instance_arn, params::Dict{String,<:Any})

Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Arguments

  • app_instance_arn: The ARN of the streaming configurations being deleted.
Main.Chime_Sdk_Messaging.describe_channelMethod
describe_channel(channel_arn, x-amz-chime-bearer)
describe_channel(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.describe_channel_banMethod
describe_channel_ban(channel_arn, member_arn, x-amz-chime-bearer)
describe_channel_ban(channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel from which the user is banned.
  • member_arn: The AppInstanceUserArn of the member being banned.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.describe_channel_flowMethod
describe_channel_flow(channel_flow_arn)
describe_channel_flow(channel_flow_arn, params::Dict{String,<:Any})

Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

Arguments

  • channel_flow_arn: The ARN of the channel flow.
Main.Chime_Sdk_Messaging.describe_channel_membershipMethod
describe_channel_membership(channel_arn, member_arn, x-amz-chime-bearer)
describe_channel_membership(channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • member_arn: The AppInstanceUserArn of the member.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sub-channel-id": The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object. Only required to get a user’s SubChannel membership details.
Main.Chime_Sdk_Messaging.describe_channel_membership_for_app_instance_userMethod
describe_channel_membership_for_app_instance_user(app-instance-user-arn, channel_arn, x-amz-chime-bearer)
describe_channel_membership_for_app_instance_user(app-instance-user-arn, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • app-instance-user-arn: The ARN of the user or bot in a channel.
  • channel_arn: The ARN of the channel to which the user belongs.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.describe_channel_moderated_by_app_instance_userMethod
describe_channel_moderated_by_app_instance_user(app-instance-user-arn, channel_arn, x-amz-chime-bearer)
describe_channel_moderated_by_app_instance_user(app-instance-user-arn, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • app-instance-user-arn: The ARN of the user or bot in the moderated channel.
  • channel_arn: The ARN of the moderated channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.describe_channel_moderatorMethod
describe_channel_moderator(channel_arn, channel_moderator_arn, x-amz-chime-bearer)
describe_channel_moderator(channel_arn, channel_moderator_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • channel_moderator_arn: The AppInstanceUserArn of the channel moderator.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.disassociate_channel_flowMethod
disassociate_channel_flow(channel_arn, channel_flow_arn, x-amz-chime-bearer)
disassociate_channel_flow(channel_arn, channel_flow_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. Only administrators or channel moderators can disassociate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • channel_flow_arn: The ARN of the channel flow.
  • x-amz-chime-bearer: The AppInstanceUserArn of the user making the API call.
Main.Chime_Sdk_Messaging.get_channel_membership_preferencesMethod
get_channel_membership_preferences(channel_arn, member_arn, x-amz-chime-bearer)
get_channel_membership_preferences(channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership to be able to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • member_arn: The AppInstanceUserArn of the member retrieving the preferences.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.get_channel_messageMethod
get_channel_message(channel_arn, message_id, x-amz-chime-bearer)
get_channel_message(channel_arn, message_id, x-amz-chime-bearer, params::Dict{String,<:Any})

Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • message_id: The ID of the message.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sub-channel-id": The ID of the SubChannel in the request. Only required when getting messages in a SubChannel that the user belongs to.
Main.Chime_Sdk_Messaging.get_channel_message_statusMethod
get_channel_message_status(channel_arn, message_id, x-amz-chime-bearer)
get_channel_message_status(channel_arn, message_id, x-amz-chime-bearer, params::Dict{String,<:Any})

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message processed successfully PENDING Ongoing processing FAILED Processing failed DENIED Messasge denied by the processor This API does not return statuses for denied messages, because we don't store them once the processor denies them. Only the message sender can invoke this API. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel
  • message_id: The ID of the message.
  • x-amz-chime-bearer: The AppInstanceUserArn of the user making the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sub-channel-id": The ID of the SubChannel in the request. Only required when getting message status in a SubChannel that the user belongs to.
Main.Chime_Sdk_Messaging.get_messaging_streaming_configurationsMethod
get_messaging_streaming_configurations(app_instance_arn)
get_messaging_streaming_configurations(app_instance_arn, params::Dict{String,<:Any})

Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Arguments

  • app_instance_arn: The ARN of the streaming configurations.
Main.Chime_Sdk_Messaging.list_channel_bansMethod
list_channel_bans(channel_arn, x-amz-chime-bearer)
list_channel_bans(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Lists all the users and bots banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of bans that you want returned.
  • "next-token": The token passed by previous API calls until all requested bans are returned.
Main.Chime_Sdk_Messaging.list_channel_flowsMethod
list_channel_flows(app-instance-arn)
list_channel_flows(app-instance-arn, params::Dict{String,<:Any})

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

Arguments

  • app-instance-arn: The ARN of the app instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of channel flows that you want to return.
  • "next-token": The token passed by previous API calls until all requested channel flows are returned.
Main.Chime_Sdk_Messaging.list_channel_membershipsMethod
list_channel_memberships(channel_arn, x-amz-chime-bearer)
list_channel_memberships(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

Arguments

  • channel_arn: The maximum number of channel memberships that you want returned.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of channel memberships that you want returned.
  • "next-token": The token passed by previous API calls until all requested channel memberships are returned.
  • "sub-channel-id": 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.
  • "type": 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.
Main.Chime_Sdk_Messaging.list_channel_memberships_for_app_instance_userMethod
list_channel_memberships_for_app_instance_user(x-amz-chime-bearer)
list_channel_memberships_for_app_instance_user(x-amz-chime-bearer, params::Dict{String,<:Any})

Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "app-instance-user-arn": The ARN of the user or bot.
  • "max-results": The maximum number of users that you want returned.
  • "next-token": The token returned from previous API requests until the number of channel memberships is reached.
Main.Chime_Sdk_Messaging.list_channel_messagesMethod
list_channel_messages(channel_arn, x-amz-chime-bearer)
list_channel_messages(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of messages that you want returned.
  • "next-token": The token passed by previous API calls until all requested messages are returned.
  • "not-after": The final or ending time stamp for your requested messages.
  • "not-before": The initial or starting time stamp for your requested messages.
  • "sort-order": The order in which you want messages sorted. Default is Descending, based on time created.
  • "sub-channel-id": The ID of the SubChannel in the request. Only required when listing the messages in a SubChannel that the user belongs to.
Main.Chime_Sdk_Messaging.list_channel_moderatorsMethod
list_channel_moderators(channel_arn, x-amz-chime-bearer)
list_channel_moderators(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of moderators that you want returned.
  • "next-token": The token passed by previous API calls until all requested moderators are returned.
Main.Chime_Sdk_Messaging.list_channelsMethod
list_channels(app-instance-arn, x-amz-chime-bearer)
list_channels(app-instance-arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality &amp; restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • app-instance-arn: The ARN of the AppInstance.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of channels that you want to return.
  • "next-token": The token passed by previous API calls until all requested channels are returned.
  • "privacy": The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
Main.Chime_Sdk_Messaging.list_channels_associated_with_channel_flowMethod
list_channels_associated_with_channel_flow(channel-flow-arn)
list_channels_associated_with_channel_flow(channel-flow-arn, params::Dict{String,<:Any})

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

Arguments

  • channel-flow-arn: The ARN of the channel flow.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of channels that you want to return.
  • "next-token": The token passed by previous API calls until all requested channels are returned.
Main.Chime_Sdk_Messaging.list_channels_moderated_by_app_instance_userMethod
list_channels_moderated_by_app_instance_user(x-amz-chime-bearer)
list_channels_moderated_by_app_instance_user(x-amz-chime-bearer, params::Dict{String,<:Any})

A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "app-instance-user-arn": The ARN of the user or bot in the moderated channel.
  • "max-results": The maximum number of channels in the request.
  • "next-token": The token returned from previous API requests until the number of channels moderated by the user is reached.
Main.Chime_Sdk_Messaging.list_sub_channelsMethod
list_sub_channels(channel_arn, x-amz-chime-bearer)
list_sub_channels(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

Arguments

  • channel_arn: The ARN of elastic channel.
  • x-amz-chime-bearer: The AppInstanceUserArn of the user making the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of sub-channels that you want to return.
  • "next-token": The token passed by previous API calls until all requested sub-channels are returned.
Main.Chime_Sdk_Messaging.list_tags_for_resourceMethod
list_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})

Lists the tags applied to an Amazon Chime SDK messaging resource.

Arguments

  • arn: The ARN of the resource.
Main.Chime_Sdk_Messaging.put_channel_expiration_settingsMethod
put_channel_expiration_settings(channel_arn)
put_channel_expiration_settings(channel_arn, params::Dict{String,<:Any})

Sets the number of days before the channel is automatically deleted. A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary. Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExpirationSettings": Settings that control the interval after which a channel is deleted.
  • "x-amz-chime-bearer": The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.put_channel_membership_preferencesMethod
put_channel_membership_preferences(preferences, channel_arn, member_arn, x-amz-chime-bearer)
put_channel_membership_preferences(preferences, channel_arn, member_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Sets the membership preferences of an AppInstanceUser or AppIntanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users or users. Banned users or bots can't set membership preferences for the channel from which they are banned. The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • preferences: The channel membership preferences of an AppInstanceUser .
  • channel_arn: The ARN of the channel.
  • member_arn: The ARN of the member setting the preferences.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Main.Chime_Sdk_Messaging.put_messaging_streaming_configurationsMethod
put_messaging_streaming_configurations(streaming_configurations, app_instance_arn)
put_messaging_streaming_configurations(streaming_configurations, app_instance_arn, params::Dict{String,<:Any})

Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Arguments

  • streaming_configurations: The streaming configurations.
  • app_instance_arn: The ARN of the streaming configuration.
Main.Chime_Sdk_Messaging.redact_channel_messageMethod
redact_channel_message(channel_arn, message_id, x-amz-chime-bearer)
redact_channel_message(channel_arn, message_id, x-amz-chime-bearer, params::Dict{String,<:Any})

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel containing the messages that you want to redact.
  • message_id: The ID of the message being redacted.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SubChannelId": The ID of the SubChannel in the request.
Main.Chime_Sdk_Messaging.search_channelsMethod
search_channels(fields)
search_channels(fields, params::Dict{String,<:Any})

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • fields: A list of the Field objects in the channel being searched.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of channels that you want returned.
  • "next-token": The token returned from previous API requests until the number of channels is reached.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user making the API call.
Main.Chime_Sdk_Messaging.send_channel_messageMethod
send_channel_message(client_request_token, content, persistence, type, channel_arn, x-amz-chime-bearer)
send_channel_message(client_request_token, content, persistence, type, channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

Arguments

  • client_request_token: The Idempotency token for each client request.
  • content: The content of the message.
  • persistence: Boolean that controls whether the message is persisted on the back end. Required.
  • type: The type of message, STANDARD or CONTROL.
  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ContentType": The content type of the channel message.
  • "MessageAttributes": The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
  • "Metadata": The optional metadata for each message.
  • "PushNotification": The push notification configuration of the message.
  • "SubChannelId": The ID of the SubChannel in the request.
Main.Chime_Sdk_Messaging.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Applies the specified tags to the specified Amazon Chime SDK messaging resource.

Arguments

  • resource_arn: The resource ARN.
  • tags: The tag key-value pairs.
Main.Chime_Sdk_Messaging.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes the specified tags from the specified Amazon Chime SDK messaging resource.

Arguments

  • resource_arn: The resource ARN.
  • tag_keys: The tag keys.
Main.Chime_Sdk_Messaging.update_channelMethod
update_channel(channel_arn, x-amz-chime-bearer)
update_channel(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The metadata for the update request.
  • "Mode": The mode of the update request.
  • "Name": The name of the channel.
Main.Chime_Sdk_Messaging.update_channel_flowMethod
update_channel_flow(name, processors, channel_flow_arn)
update_channel_flow(name, processors, channel_flow_arn, params::Dict{String,<:Any})

Updates channel flow attributes. This is a developer API.

Arguments

  • name: The name of the channel flow.
  • processors: Information about the processor Lambda functions
  • channel_flow_arn: The ARN of the channel flow.
Main.Chime_Sdk_Messaging.update_channel_messageMethod
update_channel_message(content, channel_arn, message_id, x-amz-chime-bearer)
update_channel_message(content, channel_arn, message_id, x-amz-chime-bearer, params::Dict{String,<:Any})

Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • content: The content of the message being updated.
  • channel_arn: The ARN of the channel.
  • message_id: The ID string of the message being updated.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ContentType": The content type of the channel message.
  • "Metadata": The metadata of the message being updated.
  • "SubChannelId": The ID of the SubChannel in the request. Only required when updating messages in a SubChannel that the user belongs to.
Main.Chime_Sdk_Messaging.update_channel_read_markerMethod
update_channel_read_marker(channel_arn, x-amz-chime-bearer)
update_channel_read_marker(channel_arn, x-amz-chime-bearer, params::Dict{String,<:Any})

The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • x-amz-chime-bearer: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.