# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.ChimeSDKMessaging do
@moduledoc """
The Amazon Chime SDK messaging APIs in this section allow software developers to
send
and receive messages in custom messaging applications.
These APIs depend on the frameworks
provided by the Amazon Chime SDK identity APIs. For more information about the
messaging
APIs, see [Amazon Chime SDK messaging](https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html).
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
get_messaging_streaming_configurations_response() :: %{
"StreamingConfigurations" => list(streaming_configuration())
}
"""
@type get_messaging_streaming_configurations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_flows_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("AppInstanceArn") => String.t() | atom()
}
"""
@type list_channel_flows_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
streaming_configuration() :: %{
"DataType" => list(any()),
"ResourceArn" => String.t() | atom()
}
"""
@type streaming_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_memberships_for_app_instance_user_request() :: %{
optional("AppInstanceUserArn") => String.t() | atom(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_channel_memberships_for_app_instance_user_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
delete_channel_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type delete_channel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sub_channel_summary() :: %{
"MembershipCount" => integer(),
"SubChannelId" => String.t() | atom()
}
"""
@type sub_channel_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_bans_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_channel_bans_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_moderated_by_app_instance_user_request() :: %{
required("AppInstanceUserArn") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type describe_channel_moderated_by_app_instance_user_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
describe_channel_moderator_response() :: %{
"ChannelModerator" => channel_moderator()
}
"""
@type describe_channel_moderator_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("ResourceARN") => String.t() | atom(),
required("Tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
redact_channel_message_response() :: %{
"ChannelArn" => String.t() | atom(),
"MessageId" => String.t() | atom(),
"SubChannelId" => String.t() | atom()
}
"""
@type redact_channel_message_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_moderator_response() :: %{
"ChannelArn" => String.t() | atom(),
"ChannelModerator" => identity()
}
"""
@type create_channel_moderator_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_channel_moderator_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type delete_channel_moderator_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_response() :: %{
"ChannelArn" => String.t() | atom()
}
"""
@type create_channel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_membership_for_app_instance_user_summary() :: %{
"AppInstanceUserMembershipSummary" => app_instance_user_membership_summary(),
"ChannelSummary" => channel_summary()
}
"""
@type channel_membership_for_app_instance_user_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_flows_response() :: %{
"ChannelFlows" => list(channel_flow_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channel_flows_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_flow_response() :: %{
"ChannelFlow" => channel_flow()
}
"""
@type describe_channel_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_messages_response() :: %{
"ChannelArn" => String.t() | atom(),
"ChannelMessages" => list(channel_message_summary()),
"NextToken" => String.t() | atom(),
"SubChannelId" => String.t() | atom()
}
"""
@type list_channel_messages_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_create_channel_membership_response() :: %{
"BatchChannelMemberships" => batch_channel_memberships(),
"Errors" => list(batch_create_channel_membership_error())
}
"""
@type batch_create_channel_membership_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_channel_expiration_settings_response() :: %{
"ChannelArn" => String.t() | atom(),
"ExpirationSettings" => expiration_settings()
}
"""
@type put_channel_expiration_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_failure_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type service_failure_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
identity() :: %{
"Arn" => String.t() | atom(),
"Name" => String.t() | atom()
}
"""
@type identity() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
forbidden_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type forbidden_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_flow_response() :: %{
"ChannelFlowArn" => String.t() | atom()
}
"""
@type update_channel_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_moderated_by_app_instance_user_response() :: %{
"Channel" => channel_moderated_by_app_instance_user_summary()
}
"""
@type describe_channel_moderated_by_app_instance_user_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
channel_membership() :: %{
"ChannelArn" => String.t() | atom(),
"CreatedTimestamp" => non_neg_integer(),
"InvitedBy" => identity(),
"LastUpdatedTimestamp" => non_neg_integer(),
"Member" => identity(),
"SubChannelId" => String.t() | atom(),
"Type" => list(any())
}
"""
@type channel_membership() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
message_attribute_value() :: %{
"StringValues" => list(String.t() | atom())
}
"""
@type message_attribute_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unauthorized_client_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type unauthorized_client_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
redact_channel_message_request() :: %{
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type redact_channel_message_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_channels_request() :: %{
optional("ChimeBearer") => String.t() | atom(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("Fields") => list(search_field())
}
"""
@type search_channels_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_message_request() :: %{
optional("ContentType") => String.t() | atom(),
optional("Metadata") => String.t() | atom(),
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom(),
required("Content") => String.t() | atom()
}
"""
@type update_channel_message_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_moderator_request() :: %{
required("ChannelModeratorArn") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type create_channel_moderator_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttled_client_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type throttled_client_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channels_associated_with_channel_flow_response() :: %{
"Channels" => list(channel_associated_with_flow_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channels_associated_with_channel_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_membership_response() :: %{
"ChannelMembership" => channel_membership()
}
"""
@type describe_channel_membership_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_ban_request() :: %{
required("ChimeBearer") => String.t() | atom(),
required("MemberArn") => String.t() | atom()
}
"""
@type create_channel_ban_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_flow_request() :: %{}
"""
@type describe_channel_flow_request() :: %{}
@typedoc """
## Example:
app_instance_user_membership_summary() :: %{
"ReadMarkerTimestamp" => non_neg_integer(),
"SubChannelId" => String.t() | atom(),
"Type" => list(any())
}
"""
@type app_instance_user_membership_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_channel_message_response() :: %{
"ChannelArn" => String.t() | atom(),
"MessageId" => String.t() | atom(),
"Status" => channel_message_status_structure(),
"SubChannelId" => String.t() | atom()
}
"""
@type send_channel_message_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
processor() :: %{
"Configuration" => processor_configuration(),
"ExecutionOrder" => integer(),
"FallbackAction" => list(any()),
"Name" => String.t() | atom()
}
"""
@type processor() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
expiration_settings() :: %{
"ExpirationCriterion" => list(any()),
"ExpirationDays" => integer()
}
"""
@type expiration_settings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("ResourceARN") => String.t() | atom(),
required("TagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_message_callback() :: %{
"Content" => String.t() | atom(),
"ContentType" => String.t() | atom(),
"MessageAttributes" => map(),
"MessageId" => String.t() | atom(),
"Metadata" => String.t() | atom(),
"PushNotification" => push_notification_configuration(),
"SubChannelId" => String.t() | atom()
}
"""
@type channel_message_callback() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_sub_channels_response() :: %{
"ChannelArn" => String.t() | atom(),
"NextToken" => String.t() | atom(),
"SubChannels" => list(sub_channel_summary())
}
"""
@type list_sub_channels_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_channel_membership_preferences_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type get_channel_membership_preferences_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channels_moderated_by_app_instance_user_response() :: %{
"Channels" => list(channel_moderated_by_app_instance_user_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channels_moderated_by_app_instance_user_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
put_channel_membership_preferences_request() :: %{
required("ChimeBearer") => String.t() | atom(),
required("Preferences") => channel_membership_preferences()
}
"""
@type put_channel_membership_preferences_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channels_moderated_by_app_instance_user_request() :: %{
optional("AppInstanceUserArn") => String.t() | atom(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_channels_moderated_by_app_instance_user_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
target() :: %{
"MemberArn" => String.t() | atom()
}
"""
@type target() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_moderator_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type describe_channel_moderator_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_flow() :: %{
"ChannelFlowArn" => String.t() | atom(),
"CreatedTimestamp" => non_neg_integer(),
"LastUpdatedTimestamp" => non_neg_integer(),
"Name" => String.t() | atom(),
"Processors" => list(processor())
}
"""
@type channel_flow() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_summary() :: %{
"ChannelArn" => String.t() | atom(),
"LastMessageTimestamp" => non_neg_integer(),
"Metadata" => String.t() | atom(),
"Mode" => list(any()),
"Name" => String.t() | atom(),
"Privacy" => list(any())
}
"""
@type channel_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_flow_callback_request() :: %{
optional("DeleteResource") => boolean(),
required("CallbackId") => String.t() | atom(),
required("ChannelMessage") => channel_message_callback()
}
"""
@type channel_flow_callback_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_channel_message_response() :: %{
"ChannelMessage" => channel_message()
}
"""
@type get_channel_message_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_membership_request() :: %{
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type describe_channel_membership_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_messaging_streaming_configurations_response() :: %{
"StreamingConfigurations" => list(streaming_configuration())
}
"""
@type put_messaging_streaming_configurations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_flow_request() :: %{
required("Name") => String.t() | atom(),
required("Processors") => list(processor())
}
"""
@type update_channel_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_channel_flow_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type disassociate_channel_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_membership_preferences() :: %{
"PushNotifications" => push_notification_preferences()
}
"""
@type channel_membership_preferences() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_ban_summary() :: %{
"Member" => identity()
}
"""
@type channel_ban_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_response() :: %{
"Channel" => channel()
}
"""
@type describe_channel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_channel_ban_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type delete_channel_ban_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_limit_exceeded_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type resource_limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_bans_response() :: %{
"ChannelArn" => String.t() | atom(),
"ChannelBans" => list(channel_ban_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channel_bans_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
not_found_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type describe_channel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_memberships_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
optional("SubChannelId") => String.t() | atom(),
optional("Type") => list(any()),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_channel_memberships_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_membership_summary() :: %{
"Member" => identity()
}
"""
@type channel_membership_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_request() :: %{
optional("ChannelId") => String.t() | atom(),
optional("ElasticChannelConfiguration") => elastic_channel_configuration(),
optional("ExpirationSettings") => expiration_settings(),
optional("MemberArns") => list(String.t() | atom()),
optional("Metadata") => String.t() | atom(),
optional("Mode") => list(any()),
optional("ModeratorArns") => list(String.t() | atom()),
optional("Privacy") => list(any()),
optional("Tags") => list(tag()),
required("AppInstanceArn") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom(),
required("ClientRequestToken") => String.t() | atom(),
required("Name") => String.t() | atom()
}
"""
@type create_channel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_messaging_session_endpoint_request() :: %{
optional("NetworkType") => list(any())
}
"""
@type get_messaging_session_endpoint_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"Tags" => list(tag())
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_messaging_streaming_configurations_request() :: %{
required("StreamingConfigurations") => list(streaming_configuration())
}
"""
@type put_messaging_streaming_configurations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_unavailable_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type service_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_memberships_for_app_instance_user_response() :: %{
"ChannelMemberships" => list(channel_membership_for_app_instance_user_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channel_memberships_for_app_instance_user_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_channels_response() :: %{
"Channels" => list(channel_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channels_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_membership_request() :: %{
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom(),
required("MemberArn") => String.t() | atom(),
required("Type") => list(any())
}
"""
@type create_channel_membership_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
push_notification_preferences() :: %{
"AllowNotifications" => list(any()),
"FilterRule" => String.t() | atom()
}
"""
@type push_notification_preferences() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_messaging_session_endpoint_response() :: %{
"Endpoint" => messaging_session_endpoint()
}
"""
@type get_messaging_session_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_request() :: %{
optional("Metadata") => String.t() | atom(),
optional("Mode") => list(any()),
optional("Name") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type update_channel_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_channel_membership_preferences_response() :: %{
"ChannelArn" => String.t() | atom(),
"Member" => identity(),
"Preferences" => channel_membership_preferences()
}
"""
@type put_channel_membership_preferences_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_flow_request() :: %{
optional("Tags") => list(tag()),
required("AppInstanceArn") => String.t() | atom(),
required("ClientRequestToken") => String.t() | atom(),
required("Name") => String.t() | atom(),
required("Processors") => list(processor())
}
"""
@type create_channel_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_read_marker_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type update_channel_read_marker_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_moderated_by_app_instance_user_summary() :: %{
"ChannelSummary" => channel_summary()
}
"""
@type channel_moderated_by_app_instance_user_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_message() :: %{
"ChannelArn" => String.t() | atom(),
"Content" => String.t() | atom(),
"ContentType" => String.t() | atom(),
"CreatedTimestamp" => non_neg_integer(),
"LastEditedTimestamp" => non_neg_integer(),
"LastUpdatedTimestamp" => non_neg_integer(),
"MessageAttributes" => map(),
"MessageId" => String.t() | atom(),
"Metadata" => String.t() | atom(),
"Persistence" => list(any()),
"Redacted" => boolean(),
"Sender" => identity(),
"Status" => channel_message_status_structure(),
"SubChannelId" => String.t() | atom(),
"Target" => list(target()),
"Type" => list(any())
}
"""
@type channel_message() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
messaging_session_endpoint() :: %{
"Url" => String.t() | atom()
}
"""
@type messaging_session_endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_message_response() :: %{
"ChannelArn" => String.t() | atom(),
"MessageId" => String.t() | atom(),
"Status" => channel_message_status_structure(),
"SubChannelId" => String.t() | atom()
}
"""
@type update_channel_message_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_associated_with_flow_summary() :: %{
"ChannelArn" => String.t() | atom(),
"Metadata" => String.t() | atom(),
"Mode" => list(any()),
"Name" => String.t() | atom(),
"Privacy" => list(any())
}
"""
@type channel_associated_with_flow_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_channel_message_request() :: %{
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type delete_channel_message_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
search_field() :: %{
"Key" => list(any()),
"Operator" => list(any()),
"Values" => list(String.t() | atom())
}
"""
@type search_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_channel_flow_request() :: %{}
"""
@type delete_channel_flow_request() :: %{}
@typedoc """
## Example:
list_channel_moderators_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_channel_moderators_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
lambda_configuration() :: %{
"InvocationType" => list(any()),
"ResourceArn" => String.t() | atom()
}
"""
@type lambda_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channels_associated_with_channel_flow_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("ChannelFlowArn") => String.t() | atom()
}
"""
@type list_channels_associated_with_channel_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_create_channel_membership_request() :: %{
optional("SubChannelId") => String.t() | atom(),
optional("Type") => list(any()),
required("ChimeBearer") => String.t() | atom(),
required("MemberArns") => list(String.t() | atom())
}
"""
@type batch_create_channel_membership_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_membership_for_app_instance_user_request() :: %{
required("AppInstanceUserArn") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type describe_channel_membership_for_app_instance_user_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
delete_channel_membership_request() :: %{
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type delete_channel_membership_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_messages_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
optional("NotAfter") => non_neg_integer(),
optional("NotBefore") => non_neg_integer(),
optional("SortOrder") => list(any()),
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_channel_messages_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_channel_message_request() :: %{
optional("ContentType") => String.t() | atom(),
optional("MessageAttributes") => map(),
optional("Metadata") => String.t() | atom(),
optional("PushNotification") => push_notification_configuration(),
optional("SubChannelId") => String.t() | atom(),
optional("Target") => list(target()),
required("ChimeBearer") => String.t() | atom(),
required("ClientRequestToken") => String.t() | atom(),
required("Content") => String.t() | atom(),
required("Persistence") => list(any()),
required("Type") => list(any())
}
"""
@type send_channel_message_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{
required("ResourceARN") => String.t() | atom()
}
"""
@type list_tags_for_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_messaging_streaming_configurations_request() :: %{}
"""
@type delete_messaging_streaming_configurations_request() :: %{}
@typedoc """
## Example:
get_channel_message_status_response() :: %{
"Status" => channel_message_status_structure()
}
"""
@type get_channel_message_status_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
processor_configuration() :: %{
"Lambda" => lambda_configuration()
}
"""
@type processor_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_moderators_response() :: %{
"ChannelArn" => String.t() | atom(),
"ChannelModerators" => list(channel_moderator_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channel_moderators_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_channel_message_request() :: %{
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type get_channel_message_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_ban_response() :: %{
"ChannelBan" => channel_ban()
}
"""
@type describe_channel_ban_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_flow_response() :: %{
"ChannelFlowArn" => String.t() | atom()
}
"""
@type create_channel_flow_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_sub_channels_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_sub_channels_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_ban() :: %{
"ChannelArn" => String.t() | atom(),
"CreatedBy" => identity(),
"CreatedTimestamp" => non_neg_integer(),
"Member" => identity()
}
"""
@type channel_ban() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
push_notification_configuration() :: %{
"Body" => String.t() | atom(),
"Title" => String.t() | atom(),
"Type" => list(any())
}
"""
@type push_notification_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_channel_flow_request() :: %{
required("ChannelFlowArn") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type associate_channel_flow_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel() :: %{
"ChannelArn" => String.t() | atom(),
"ChannelFlowArn" => String.t() | atom(),
"CreatedBy" => identity(),
"CreatedTimestamp" => non_neg_integer(),
"ElasticChannelConfiguration" => elastic_channel_configuration(),
"ExpirationSettings" => expiration_settings(),
"LastMessageTimestamp" => non_neg_integer(),
"LastUpdatedTimestamp" => non_neg_integer(),
"Metadata" => String.t() | atom(),
"Mode" => list(any()),
"Name" => String.t() | atom(),
"Privacy" => list(any())
}
"""
@type channel() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channel_memberships_response() :: %{
"ChannelArn" => String.t() | atom(),
"ChannelMemberships" => list(channel_membership_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_channel_memberships_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_moderator() :: %{
"ChannelArn" => String.t() | atom(),
"CreatedBy" => identity(),
"CreatedTimestamp" => non_neg_integer(),
"Moderator" => identity()
}
"""
@type channel_moderator() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_message_status_structure() :: %{
"Detail" => String.t() | atom(),
"Value" => list(any())
}
"""
@type channel_message_status_structure() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_channel_expiration_settings_request() :: %{
optional("ChimeBearer") => String.t() | atom(),
optional("ExpirationSettings") => expiration_settings()
}
"""
@type put_channel_expiration_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_ban_response() :: %{
"ChannelArn" => String.t() | atom(),
"Member" => identity()
}
"""
@type create_channel_ban_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_create_channel_membership_error() :: %{
"ErrorCode" => list(any()),
"ErrorMessage" => String.t() | atom(),
"MemberArn" => String.t() | atom()
}
"""
@type batch_create_channel_membership_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_flow_summary() :: %{
"ChannelFlowArn" => String.t() | atom(),
"Name" => String.t() | atom(),
"Processors" => list(processor())
}
"""
@type channel_flow_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bad_request_exception() :: %{
"Code" => list(any()),
"Message" => String.t() | atom()
}
"""
@type bad_request_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_read_marker_response() :: %{
"ChannelArn" => String.t() | atom()
}
"""
@type update_channel_read_marker_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_channel_membership_preferences_response() :: %{
"ChannelArn" => String.t() | atom(),
"Member" => identity(),
"Preferences" => channel_membership_preferences()
}
"""
@type get_channel_membership_preferences_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_moderator_summary() :: %{
"Moderator" => identity()
}
"""
@type channel_moderator_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_channel_memberships() :: %{
"ChannelArn" => String.t() | atom(),
"InvitedBy" => identity(),
"Members" => list(identity()),
"SubChannelId" => String.t() | atom(),
"Type" => list(any())
}
"""
@type batch_channel_memberships() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_channel_response() :: %{
"ChannelArn" => String.t() | atom()
}
"""
@type update_channel_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_ban_request() :: %{
required("ChimeBearer") => String.t() | atom()
}
"""
@type describe_channel_ban_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_channel_membership_for_app_instance_user_response() :: %{
"ChannelMembership" => channel_membership_for_app_instance_user_summary()
}
"""
@type describe_channel_membership_for_app_instance_user_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
channel_flow_callback_response() :: %{
"CallbackId" => String.t() | atom(),
"ChannelArn" => String.t() | atom()
}
"""
@type channel_flow_callback_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_channels_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
optional("Privacy") => list(any()),
required("AppInstanceArn") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type list_channels_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
elastic_channel_configuration() :: %{
"MaximumSubChannels" => integer(),
"MinimumMembershipPercentage" => integer(),
"TargetMembershipsPerSubChannel" => integer()
}
"""
@type elastic_channel_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
channel_message_summary() :: %{
"Content" => String.t() | atom(),
"ContentType" => String.t() | atom(),
"CreatedTimestamp" => non_neg_integer(),
"LastEditedTimestamp" => non_neg_integer(),
"LastUpdatedTimestamp" => non_neg_integer(),
"MessageAttributes" => map(),
"MessageId" => String.t() | atom(),
"Metadata" => String.t() | atom(),
"Redacted" => boolean(),
"Sender" => identity(),
"Status" => channel_message_status_structure(),
"Target" => list(target()),
"Type" => list(any())
}
"""
@type channel_message_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_channel_message_status_request() :: %{
optional("SubChannelId") => String.t() | atom(),
required("ChimeBearer") => String.t() | atom()
}
"""
@type get_channel_message_status_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_messaging_streaming_configurations_request() :: %{}
"""
@type get_messaging_streaming_configurations_request() :: %{}
@typedoc """
## Example:
search_channels_response() :: %{
"Channels" => list(channel_summary()),
"NextToken" => String.t() | atom()
}
"""
@type search_channels_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_channel_membership_response() :: %{
"ChannelArn" => String.t() | atom(),
"Member" => identity(),
"SubChannelId" => String.t() | atom()
}
"""
@type create_channel_membership_response() :: %{(String.t() | atom()) => any()}
@type associate_channel_flow_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type batch_create_channel_membership_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| resource_limit_exceeded_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type channel_flow_callback_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type create_channel_errors() ::
bad_request_exception()
| service_unavailable_exception()
| resource_limit_exceeded_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type create_channel_ban_errors() ::
bad_request_exception()
| service_unavailable_exception()
| resource_limit_exceeded_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type create_channel_flow_errors() ::
bad_request_exception()
| service_unavailable_exception()
| resource_limit_exceeded_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type create_channel_membership_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| resource_limit_exceeded_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type create_channel_moderator_errors() ::
bad_request_exception()
| service_unavailable_exception()
| resource_limit_exceeded_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type delete_channel_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type delete_channel_ban_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type delete_channel_flow_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type delete_channel_membership_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type delete_channel_message_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type delete_channel_moderator_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type delete_messaging_streaming_configurations_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type describe_channel_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type describe_channel_ban_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type describe_channel_flow_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type describe_channel_membership_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type describe_channel_membership_for_app_instance_user_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type describe_channel_moderated_by_app_instance_user_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type describe_channel_moderator_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type disassociate_channel_flow_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type get_channel_membership_preferences_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type get_channel_message_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type get_channel_message_status_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type get_messaging_session_endpoint_errors() ::
service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type get_messaging_streaming_configurations_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channel_bans_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channel_flows_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channel_memberships_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channel_memberships_for_app_instance_user_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channel_messages_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channel_moderators_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channels_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channels_associated_with_channel_flow_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_channels_moderated_by_app_instance_user_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_sub_channels_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type list_tags_for_resource_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type put_channel_expiration_settings_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type put_channel_membership_preferences_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type put_messaging_streaming_configurations_errors() ::
bad_request_exception()
| service_unavailable_exception()
| not_found_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type redact_channel_message_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type search_channels_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type send_channel_message_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type tag_resource_errors() ::
bad_request_exception()
| service_unavailable_exception()
| resource_limit_exceeded_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type untag_resource_errors() ::
bad_request_exception()
| service_unavailable_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type update_channel_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type update_channel_flow_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type update_channel_message_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
@type update_channel_read_marker_errors() ::
bad_request_exception()
| service_unavailable_exception()
| conflict_exception()
| throttled_client_exception()
| unauthorized_client_exception()
| forbidden_exception()
| service_failure_exception()
def metadata do
%{
api_version: "2021-05-15",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "messaging-chime",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "Chime SDK Messaging",
signature_version: "v4",
signing_name: "chime",
target_prefix: nil
}
end
@doc """
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.
"""
@spec associate_channel_flow(
map(),
String.t() | atom(),
associate_channel_flow_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_channel_flow_errors()}
def associate_channel_flow(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/channel-flow"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds a specified number of users and bots to a channel.
"""
@spec batch_create_channel_membership(
map(),
String.t() | atom(),
batch_create_channel_membership_request(),
list()
) ::
{:ok, batch_create_channel_membership_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_create_channel_membership_errors()}
def batch_create_channel_membership(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/memberships?operation=batch-create"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Calls back Amazon 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
"""
@spec channel_flow_callback(map(), String.t() | atom(), channel_flow_callback_request(), list()) ::
{:ok, channel_flow_callback_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, channel_flow_callback_errors()}
def channel_flow_callback(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}?operation=channel-flow-callback"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_channel(map(), create_channel_request(), list()) ::
{:ok, create_channel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_channel_errors()}
def create_channel(%Client{} = client, input, options \\ []) do
url_path = "/channels"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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.
"""
@spec create_channel_ban(map(), String.t() | atom(), create_channel_ban_request(), list()) ::
{:ok, create_channel_ban_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_channel_ban_errors()}
def create_channel_ban(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/bans"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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:
1.
New and updated messages
2.
Persistent and non-persistent messages
3.
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](https://docs.aws.amazon.com/chime-sdk/latest/dg/using-the-messaging-sdk.html#msg-types)
in the *Amazon Chime developer guide*.
"""
@spec create_channel_flow(map(), create_channel_flow_request(), list()) ::
{:ok, create_channel_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_channel_flow_errors()}
def create_channel_flow(%Client{} = client, input, options \\ []) do
url_path = "/channel-flows"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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.
"""
@spec create_channel_membership(
map(),
String.t() | atom(),
create_channel_membership_request(),
list()
) ::
{:ok, create_channel_membership_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_channel_membership_errors()}
def create_channel_membership(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/memberships"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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 `AppInstanceBot`of the user that makes the API
call as the value in
the header.
"""
@spec create_channel_moderator(
map(),
String.t() | atom(),
create_channel_moderator_request(),
list()
) ::
{:ok, create_channel_moderator_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_channel_moderator_errors()}
def create_channel_moderator(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/moderators"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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.
"""
@spec delete_channel(map(), String.t() | atom(), delete_channel_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_channel_errors()}
def delete_channel(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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.
"""
@spec delete_channel_ban(
map(),
String.t() | atom(),
String.t() | atom(),
delete_channel_ban_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_channel_ban_errors()}
def delete_channel_ban(%Client{} = client, channel_arn, member_arn, input, options \\ []) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/bans/#{AWS.Util.encode_uri(member_arn)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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.
"""
@spec delete_channel_flow(map(), String.t() | atom(), delete_channel_flow_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_channel_flow_errors()}
def delete_channel_flow(%Client{} = client, channel_flow_arn, input, options \\ []) do
url_path = "/channel-flows/#{AWS.Util.encode_uri(channel_flow_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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.
"""
@spec delete_channel_membership(
map(),
String.t() | atom(),
String.t() | atom(),
delete_channel_membership_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_channel_membership_errors()}
def delete_channel_membership(%Client{} = client, channel_arn, member_arn, input, options \\ []) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/memberships/#{AWS.Util.encode_uri(member_arn)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"SubChannelId", "sub-channel-id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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.
"""
@spec delete_channel_message(
map(),
String.t() | atom(),
String.t() | atom(),
delete_channel_message_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_channel_message_errors()}
def delete_channel_message(%Client{} = client, channel_arn, message_id, input, options \\ []) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/messages/#{AWS.Util.encode_uri(message_id)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"SubChannelId", "sub-channel-id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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.
"""
@spec delete_channel_moderator(
map(),
String.t() | atom(),
String.t() | atom(),
delete_channel_moderator_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_channel_moderator_errors()}
def delete_channel_moderator(
%Client{} = client,
channel_arn,
channel_moderator_arn,
input,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/moderators/#{AWS.Util.encode_uri(channel_moderator_arn)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes the streaming configurations for an `AppInstance`.
For more information, see
[Streaming messaging data](https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in
the *Amazon Chime SDK Developer Guide*.
"""
@spec delete_messaging_streaming_configurations(
map(),
String.t() | atom(),
delete_messaging_streaming_configurations_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_messaging_streaming_configurations_errors()}
def delete_messaging_streaming_configurations(
%Client{} = client,
app_instance_arn,
input,
options \\ []
) do
url_path = "/app-instances/#{AWS.Util.encode_uri(app_instance_arn)}/streaming-configurations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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.
"""
@spec describe_channel(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, describe_channel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_errors()}
def describe_channel(%Client{} = client, channel_arn, chime_bearer, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec describe_channel_ban(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, describe_channel_ban_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_ban_errors()}
def describe_channel_ban(
%Client{} = client,
channel_arn,
member_arn,
chime_bearer,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/bans/#{AWS.Util.encode_uri(member_arn)}"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the full details of a channel flow in an Amazon Chime `AppInstance`.
This is a developer API.
"""
@spec describe_channel_flow(map(), String.t() | atom(), list()) ::
{:ok, describe_channel_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_flow_errors()}
def describe_channel_flow(%Client{} = client, channel_flow_arn, options \\ []) do
url_path = "/channel-flows/#{AWS.Util.encode_uri(channel_flow_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec describe_channel_membership(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, describe_channel_membership_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_membership_errors()}
def describe_channel_membership(
%Client{} = client,
channel_arn,
member_arn,
sub_channel_id \\ nil,
chime_bearer,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/memberships/#{AWS.Util.encode_uri(member_arn)}"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(sub_channel_id) do
[{"sub-channel-id", sub_channel_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec describe_channel_membership_for_app_instance_user(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, describe_channel_membership_for_app_instance_user_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_membership_for_app_instance_user_errors()}
def describe_channel_membership_for_app_instance_user(
%Client{} = client,
channel_arn,
app_instance_user_arn,
chime_bearer,
options \\ []
) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}?scope=app-instance-user-membership"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(app_instance_user_arn) do
[{"app-instance-user-arn", app_instance_user_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec describe_channel_moderated_by_app_instance_user(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, describe_channel_moderated_by_app_instance_user_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_moderated_by_app_instance_user_errors()}
def describe_channel_moderated_by_app_instance_user(
%Client{} = client,
channel_arn,
app_instance_user_arn,
chime_bearer,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}?scope=app-instance-user-moderated-channel"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(app_instance_user_arn) do
[{"app-instance-user-arn", app_instance_user_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec describe_channel_moderator(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, describe_channel_moderator_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_channel_moderator_errors()}
def describe_channel_moderator(
%Client{} = client,
channel_arn,
channel_moderator_arn,
chime_bearer,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/moderators/#{AWS.Util.encode_uri(channel_moderator_arn)}"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec disassociate_channel_flow(
map(),
String.t() | atom(),
String.t() | atom(),
disassociate_channel_flow_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_channel_flow_errors()}
def disassociate_channel_flow(
%Client{} = client,
channel_arn,
channel_flow_arn,
input,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/channel-flow/#{AWS.Util.encode_uri(channel_flow_arn)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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 in order
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.
"""
@spec get_channel_membership_preferences(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_channel_membership_preferences_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_channel_membership_preferences_errors()}
def get_channel_membership_preferences(
%Client{} = client,
channel_arn,
member_arn,
chime_bearer,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/memberships/#{AWS.Util.encode_uri(member_arn)}/preferences"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec get_channel_message(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, get_channel_message_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_channel_message_errors()}
def get_channel_message(
%Client{} = client,
channel_arn,
message_id,
sub_channel_id \\ nil,
chime_bearer,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/messages/#{AWS.Util.encode_uri(message_id)}"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(sub_channel_id) do
[{"sub-channel-id", sub_channel_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
## Definitions
### SENT
Message processed successfully
### PENDING
Ongoing processing
### FAILED
Processing failed
### DENIED
Message 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.
"""
@spec get_channel_message_status(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, get_channel_message_status_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_channel_message_status_errors()}
def get_channel_message_status(
%Client{} = client,
channel_arn,
message_id,
sub_channel_id \\ nil,
chime_bearer,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/messages/#{AWS.Util.encode_uri(message_id)}?scope=message-status"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(sub_channel_id) do
[{"sub-channel-id", sub_channel_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
The details of the endpoint for the messaging session.
"""
@spec get_messaging_session_endpoint(map(), String.t() | atom() | nil, list()) ::
{:ok, get_messaging_session_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_messaging_session_endpoint_errors()}
def get_messaging_session_endpoint(%Client{} = client, network_type \\ nil, options \\ []) do
url_path = "/endpoints/messaging-session"
headers = []
query_params = []
query_params =
if !is_nil(network_type) do
[{"network-type", network_type} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the data streaming configuration for an `AppInstance`.
For more information, see
[Streaming messaging data](https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in
the *Amazon Chime SDK Developer Guide*.
"""
@spec get_messaging_streaming_configurations(map(), String.t() | atom(), list()) ::
{:ok, get_messaging_streaming_configurations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_messaging_streaming_configurations_errors()}
def get_messaging_streaming_configurations(%Client{} = client, app_instance_arn, options \\ []) do
url_path = "/app-instances/#{AWS.Util.encode_uri(app_instance_arn)}/streaming-configurations"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_channel_bans(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_channel_bans_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channel_bans_errors()}
def list_channel_bans(
%Client{} = client,
channel_arn,
max_results \\ nil,
next_token \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/bans"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a paginated lists of all the channel flows created under a single Chime.
This is a developer API.
"""
@spec list_channel_flows(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_channel_flows_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channel_flows_errors()}
def list_channel_flows(
%Client{} = client,
app_instance_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/channel-flows"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(app_instance_arn) do
[{"app-instance-arn", app_instance_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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](https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html)
API.
"""
@spec list_channel_memberships(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_channel_memberships_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channel_memberships_errors()}
def list_channel_memberships(
%Client{} = client,
channel_arn,
max_results \\ nil,
next_token \\ nil,
sub_channel_id \\ nil,
type \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/memberships"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(type) do
[{"type", type} | query_params]
else
query_params
end
query_params =
if !is_nil(sub_channel_id) do
[{"sub-channel-id", sub_channel_id} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all channels that an `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.
"""
@spec list_channel_memberships_for_app_instance_user(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_channel_memberships_for_app_instance_user_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channel_memberships_for_app_instance_user_errors()}
def list_channel_memberships_for_app_instance_user(
%Client{} = client,
app_instance_user_arn \\ nil,
max_results \\ nil,
next_token \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels?scope=app-instance-user-memberships"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(app_instance_user_arn) do
[{"app-instance-user-arn", app_instance_user_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_channel_messages(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_channel_messages_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channel_messages_errors()}
def list_channel_messages(
%Client{} = client,
channel_arn,
max_results \\ nil,
next_token \\ nil,
not_after \\ nil,
not_before \\ nil,
sort_order \\ nil,
sub_channel_id \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/messages"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(sub_channel_id) do
[{"sub-channel-id", sub_channel_id} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sort-order", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(not_before) do
[{"not-before", not_before} | query_params]
else
query_params
end
query_params =
if !is_nil(not_after) do
[{"not-after", not_after} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_channel_moderators(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_channel_moderators_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channel_moderators_errors()}
def list_channel_moderators(
%Client{} = client,
channel_arn,
max_results \\ nil,
next_token \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/moderators"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all Channels created under a single Chime App as a paginated list.
You can specify
filters to narrow results.
## Functionality & 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.
"""
@spec list_channels(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_channels_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channels_errors()}
def list_channels(
%Client{} = client,
app_instance_arn,
max_results \\ nil,
next_token \\ nil,
privacy \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(privacy) do
[{"privacy", privacy} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(app_instance_arn) do
[{"app-instance-arn", app_instance_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_channels_associated_with_channel_flow(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_channels_associated_with_channel_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channels_associated_with_channel_flow_errors()}
def list_channels_associated_with_channel_flow(
%Client{} = client,
channel_flow_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/channels?scope=channel-flow-associations"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(channel_flow_arn) do
[{"channel-flow-arn", channel_flow_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_channels_moderated_by_app_instance_user(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_channels_moderated_by_app_instance_user_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_channels_moderated_by_app_instance_user_errors()}
def list_channels_moderated_by_app_instance_user(
%Client{} = client,
app_instance_user_arn \\ nil,
max_results \\ nil,
next_token \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels?scope=app-instance-user-moderated-channels"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(app_instance_user_arn) do
[{"app-instance-user-arn", app_instance_user_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_sub_channels(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_sub_channels_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_sub_channels_errors()}
def list_sub_channels(
%Client{} = client,
channel_arn,
max_results \\ nil,
next_token \\ nil,
chime_bearer,
options \\ []
) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/subchannels"
headers = []
headers =
if !is_nil(chime_bearer) do
[{"x-amz-chime-bearer", chime_bearer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(next_token) do
[{"next-token", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"max-results", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the tags applied to an Amazon Chime SDK messaging resource.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags"
headers = []
query_params = []
query_params =
if !is_nil(resource_arn) do
[{"arn", resource_arn} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec put_channel_expiration_settings(
map(),
String.t() | atom(),
put_channel_expiration_settings_request(),
list()
) ::
{:ok, put_channel_expiration_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_channel_expiration_settings_errors()}
def put_channel_expiration_settings(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/expiration-settings"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Sets the membership preferences of an `AppInstanceUser` or `AppInstanceBot`
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. 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.
"""
@spec put_channel_membership_preferences(
map(),
String.t() | atom(),
String.t() | atom(),
put_channel_membership_preferences_request(),
list()
) ::
{:ok, put_channel_membership_preferences_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_channel_membership_preferences_errors()}
def put_channel_membership_preferences(
%Client{} = client,
channel_arn,
member_arn,
input,
options \\ []
) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/memberships/#{AWS.Util.encode_uri(member_arn)}/preferences"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Sets the data streaming configuration for an `AppInstance`.
For more information, see
[Streaming messaging data](https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in
the *Amazon Chime SDK Developer Guide*.
"""
@spec put_messaging_streaming_configurations(
map(),
String.t() | atom(),
put_messaging_streaming_configurations_request(),
list()
) ::
{:ok, put_messaging_streaming_configurations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_messaging_streaming_configurations_errors()}
def put_messaging_streaming_configurations(
%Client{} = client,
app_instance_arn,
input,
options \\ []
) do
url_path = "/app-instances/#{AWS.Util.encode_uri(app_instance_arn)}/streaming-configurations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Redacts message content and 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.
"""
@spec redact_channel_message(
map(),
String.t() | atom(),
String.t() | atom(),
redact_channel_message_request(),
list()
) ::
{:ok, redact_channel_message_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, redact_channel_message_errors()}
def redact_channel_message(%Client{} = client, channel_arn, message_id, input, options \\ []) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/messages/#{AWS.Util.encode_uri(message_id)}?operation=redact"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
This operation isn't supported for `AppInstanceUsers` with a large number of
memberships.
"""
@spec search_channels(map(), search_channels_request(), list()) ::
{:ok, search_channels_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, search_channels_errors()}
def search_channels(%Client{} = client, input, options \\ []) do
url_path = "/channels?operation=search"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"MaxResults", "max-results"},
{"NextToken", "next-token"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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 be up to 4KB in size and contain metadata.
Metadata is arbitrary,
and you can use it in a variety of ways, such as containing a link to an
attachment.
`CONTROL` messages are limited to 30 bytes and do not contain metadata.
"""
@spec send_channel_message(map(), String.t() | atom(), send_channel_message_request(), list()) ::
{:ok, send_channel_message_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, send_channel_message_errors()}
def send_channel_message(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/messages"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
url_path = "/tags?operation=tag-resource"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Removes the specified tags from the specified Amazon Chime SDK messaging
resource.
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
url_path = "/tags?operation=untag-resource"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
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.
"""
@spec update_channel(map(), String.t() | atom(), update_channel_request(), list()) ::
{:ok, update_channel_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_channel_errors()}
def update_channel(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates channel flow attributes.
This is a developer API.
"""
@spec update_channel_flow(map(), String.t() | atom(), update_channel_flow_request(), list()) ::
{:ok, update_channel_flow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_channel_flow_errors()}
def update_channel_flow(%Client{} = client, channel_flow_arn, input, options \\ []) do
url_path = "/channel-flows/#{AWS.Util.encode_uri(channel_flow_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec update_channel_message(
map(),
String.t() | atom(),
String.t() | atom(),
update_channel_message_request(),
list()
) ::
{:ok, update_channel_message_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_channel_message_errors()}
def update_channel_message(%Client{} = client, channel_arn, message_id, input, options \\ []) do
url_path =
"/channels/#{AWS.Util.encode_uri(channel_arn)}/messages/#{AWS.Util.encode_uri(message_id)}"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec update_channel_read_marker(
map(),
String.t() | atom(),
update_channel_read_marker_request(),
list()
) ::
{:ok, update_channel_read_marker_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_channel_read_marker_errors()}
def update_channel_read_marker(%Client{} = client, channel_arn, input, options \\ []) do
url_path = "/channels/#{AWS.Util.encode_uri(channel_arn)}/readMarker"
{headers, input} =
[
{"ChimeBearer", "x-amz-chime-bearer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
