Class: Aws::ChimeSDKMessaging::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ChimeSDKMessaging::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb
Overview
An API client for ChimeSDKMessaging. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ChimeSDKMessaging::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_channel_flow(params = {}) ⇒ Struct
Associates a channel flow with a channel.
-
#batch_create_channel_membership(params = {}) ⇒ Types::BatchCreateChannelMembershipResponse
Adds a specified number of users to a channel.
-
#channel_flow_callback(params = {}) ⇒ Types::ChannelFlowCallbackResponse
Calls back Chime SDK Messaging with a processing response message.
-
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a channel to which you can add users and send messages.
-
#create_channel_ban(params = {}) ⇒ Types::CreateChannelBanResponse
Permanently bans a member from a channel.
-
#create_channel_flow(params = {}) ⇒ Types::CreateChannelFlowResponse
Creates a channel flow, a container for processors.
-
#create_channel_membership(params = {}) ⇒ Types::CreateChannelMembershipResponse
Adds a user to a channel.
-
#create_channel_moderator(params = {}) ⇒ Types::CreateChannelModeratorResponse
Creates a new
ChannelModerator
. -
#delete_channel(params = {}) ⇒ Struct
Immediately makes a channel and its memberships inaccessible and marks them for deletion.
-
#delete_channel_ban(params = {}) ⇒ Struct
Removes a user from a channel's ban list.
-
#delete_channel_flow(params = {}) ⇒ Struct
Deletes a channel flow, an irreversible process.
-
#delete_channel_membership(params = {}) ⇒ Struct
Removes a member from a channel.
-
#delete_channel_message(params = {}) ⇒ Struct
Deletes a channel message.
-
#delete_channel_moderator(params = {}) ⇒ Struct
Deletes a channel moderator.
-
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Returns the full details of a channel in an Amazon Chime
AppInstance
. -
#describe_channel_ban(params = {}) ⇒ Types::DescribeChannelBanResponse
Returns the full details of a channel ban.
-
#describe_channel_flow(params = {}) ⇒ Types::DescribeChannelFlowResponse
Returns the full details of a channel flow in an Amazon Chime
AppInstance
. -
#describe_channel_membership(params = {}) ⇒ Types::DescribeChannelMembershipResponse
Returns the full details of a user's channel membership.
-
#describe_channel_membership_for_app_instance_user(params = {}) ⇒ Types::DescribeChannelMembershipForAppInstanceUserResponse
Returns the details of a channel based on the membership of the specified
AppInstanceUser
. -
#describe_channel_moderated_by_app_instance_user(params = {}) ⇒ Types::DescribeChannelModeratedByAppInstanceUserResponse
Returns the full details of a channel moderated by the specified
AppInstanceUser
. -
#describe_channel_moderator(params = {}) ⇒ Types::DescribeChannelModeratorResponse
Returns the full details of a single ChannelModerator.
-
#disassociate_channel_flow(params = {}) ⇒ Struct
Disassociates a channel flow from all its channels.
-
#get_channel_membership_preferences(params = {}) ⇒ Types::GetChannelMembershipPreferencesResponse
Gets the membership preferences of an
AppInstanceUser
for the specified channel. -
#get_channel_message(params = {}) ⇒ Types::GetChannelMessageResponse
Gets the full details of a channel message.
-
#get_channel_message_status(params = {}) ⇒ Types::GetChannelMessageStatusResponse
Gets message status for a specified
messageId
. -
#get_messaging_session_endpoint(params = {}) ⇒ Types::GetMessagingSessionEndpointResponse
The details of the endpoint for the messaging session.
-
#list_channel_bans(params = {}) ⇒ Types::ListChannelBansResponse
Lists all the users banned from a particular channel.
-
#list_channel_flows(params = {}) ⇒ Types::ListChannelFlowsResponse
Returns a paginated lists of all the channel flows created under a single Chime.
-
#list_channel_memberships(params = {}) ⇒ Types::ListChannelMembershipsResponse
Lists all channel memberships in a channel.
-
#list_channel_memberships_for_app_instance_user(params = {}) ⇒ Types::ListChannelMembershipsForAppInstanceUserResponse
Lists all channels that a particular
AppInstanceUser
is a part of. -
#list_channel_messages(params = {}) ⇒ Types::ListChannelMessagesResponse
List all the messages in a channel.
-
#list_channel_moderators(params = {}) ⇒ Types::ListChannelModeratorsResponse
Lists all the moderators for a channel.
-
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Lists all Channels created under a single Chime App as a paginated list.
-
#list_channels_associated_with_channel_flow(params = {}) ⇒ Types::ListChannelsAssociatedWithChannelFlowResponse
Lists all channels associated with a specified channel flow.
-
#list_channels_moderated_by_app_instance_user(params = {}) ⇒ Types::ListChannelsModeratedByAppInstanceUserResponse
A list of the channels moderated by an
AppInstanceUser
. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK messaging resource.
-
#put_channel_membership_preferences(params = {}) ⇒ Types::PutChannelMembershipPreferencesResponse
Sets the membership preferences of an
AppInstanceUser
for the specified channel. -
#redact_channel_message(params = {}) ⇒ Types::RedactChannelMessageResponse
Redacts message content, but not metadata.
-
#send_channel_message(params = {}) ⇒ Types::SendChannelMessageResponse
Sends a message to a particular channel that the member is a part of.
-
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Chime SDK messaging resource.
-
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Update a channel's attributes.
-
#update_channel_flow(params = {}) ⇒ Types::UpdateChannelFlowResponse
Updates channel flow attributes.
-
#update_channel_message(params = {}) ⇒ Types::UpdateChannelMessageResponse
Updates the content of a message.
-
#update_channel_read_marker(params = {}) ⇒ Types::UpdateChannelReadMarkerResponse
The details of the time when a user last read messages in a channel.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
348 349 350 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#associate_channel_flow(params = {}) ⇒ Struct
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.
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.
388 389 390 391 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 388 def associate_channel_flow(params = {}, = {}) req = build_request(:associate_channel_flow, params) req.send_request() end |
#batch_create_channel_membership(params = {}) ⇒ Types::BatchCreateChannelMembershipResponse
Adds a specified number of users to a channel.
444 445 446 447 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 444 def batch_create_channel_membership(params = {}, = {}) req = build_request(:batch_create_channel_membership, params) req.send_request() end |
#channel_flow_callback(params = {}) ⇒ Types::ChannelFlowCallbackResponse
Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
Update message content or metadata
Deny a message
Make no changes to the message
515 516 517 518 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 515 def channel_flow_callback(params = {}, = {}) req = build_request(:channel_flow_callback, params) req.send_request() end |
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
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.
592 593 594 595 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 592 def create_channel(params = {}, = {}) req = build_request(:create_channel, params) req.send_request() end |
#create_channel_ban(params = {}) ⇒ Types::CreateChannelBanResponse
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.
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.
643 644 645 646 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 643 def create_channel_ban(params = {}, = {}) req = build_request(:create_channel_ban, params) req.send_request() end |
#create_channel_flow(params = {}) ⇒ Types::CreateChannelFlowResponse
Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
New and updated messages
Persistent and non-persistent messages
The Standard message type
726 727 728 729 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 726 def create_channel_flow(params = {}, = {}) req = build_request(:create_channel_flow, params) req.send_request() end |
#create_channel_membership(params = {}) ⇒ Types::CreateChannelMembershipResponse
Adds a user 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.
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.
797 798 799 800 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 797 def create_channel_membership(params = {}, = {}) req = build_request(:create_channel_membership, params) req.send_request() end |
#create_channel_moderator(params = {}) ⇒ Types::CreateChannelModeratorResponse
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.
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.
852 853 854 855 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 852 def create_channel_moderator(params = {}, = {}) req = build_request(:create_channel_moderator, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
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.
885 886 887 888 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 885 def delete_channel(params = {}, = {}) req = build_request(:delete_channel, params) req.send_request() end |
#delete_channel_ban(params = {}) ⇒ Struct
Removes a user from a channel's ban list.
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.
921 922 923 924 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 921 def delete_channel_ban(params = {}, = {}) req = build_request(:delete_channel_ban, params) req.send_request() end |
#delete_channel_flow(params = {}) ⇒ Struct
Deletes a channel flow, an irreversible process. This is a developer API.
ListChannelsAssociatedWithChannelFlow
API.
Use the DisassociateChannelFlow
API to disassociate a channel flow
from all channels.
952 953 954 955 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 952 def delete_channel_flow(params = {}, = {}) req = build_request(:delete_channel_flow, params) req.send_request() end |
#delete_channel_membership(params = {}) ⇒ Struct
Removes a member from a channel.
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.
989 990 991 992 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 989 def delete_channel_membership(params = {}, = {}) req = build_request(:delete_channel_membership, params) req.send_request() end |
#delete_channel_message(params = {}) ⇒ Struct
Deletes a channel message. Only admins can perform this action.
Deletion makes messages inaccessible immediately. A background process
deletes any revisions created by UpdateChannelMessage
.
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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1027 def (params = {}, = {}) req = build_request(:delete_channel_message, params) req.send_request() end |
#delete_channel_moderator(params = {}) ⇒ Struct
Deletes a channel moderator.
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.
1063 1064 1065 1066 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1063 def delete_channel_moderator(params = {}, = {}) req = build_request(:delete_channel_moderator, params) req.send_request() end |
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Returns the full details of a channel in an Amazon Chime
AppInstance
.
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.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1112 def describe_channel(params = {}, = {}) req = build_request(:describe_channel, params) req.send_request() end |
#describe_channel_ban(params = {}) ⇒ Types::DescribeChannelBanResponse
Returns the full details of a channel ban.
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.
1159 1160 1161 1162 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1159 def describe_channel_ban(params = {}, = {}) req = build_request(:describe_channel_ban, params) req.send_request() end |
#describe_channel_flow(params = {}) ⇒ Types::DescribeChannelFlowResponse
Returns the full details of a channel flow in an Amazon Chime
AppInstance
. This is a developer API.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1197 def describe_channel_flow(params = {}, = {}) req = build_request(:describe_channel_flow, params) req.send_request() end |
#describe_channel_membership(params = {}) ⇒ Types::DescribeChannelMembershipResponse
Returns the full details of a user's channel membership.
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.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1246 def describe_channel_membership(params = {}, = {}) req = build_request(:describe_channel_membership, params) req.send_request() end |
#describe_channel_membership_for_app_instance_user(params = {}) ⇒ Types::DescribeChannelMembershipForAppInstanceUserResponse
Returns the details of a channel based on the membership of the
specified AppInstanceUser
.
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.
1296 1297 1298 1299 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1296 def describe_channel_membership_for_app_instance_user(params = {}, = {}) req = build_request(:describe_channel_membership_for_app_instance_user, params) req.send_request() end |
#describe_channel_moderated_by_app_instance_user(params = {}) ⇒ Types::DescribeChannelModeratedByAppInstanceUserResponse
Returns the full details of a channel moderated by the specified
AppInstanceUser
.
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.
1344 1345 1346 1347 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1344 def describe_channel_moderated_by_app_instance_user(params = {}, = {}) req = build_request(:describe_channel_moderated_by_app_instance_user, params) req.send_request() end |
#describe_channel_moderator(params = {}) ⇒ Types::DescribeChannelModeratorResponse
Returns the full details of a single ChannelModerator.
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.
1391 1392 1393 1394 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1391 def describe_channel_moderator(params = {}, = {}) req = build_request(:describe_channel_moderator, params) req.send_request() end |
#disassociate_channel_flow(params = {}) ⇒ Struct
Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.
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.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1430 def disassociate_channel_flow(params = {}, = {}) req = build_request(:disassociate_channel_flow, params) req.send_request() end |
#get_channel_membership_preferences(params = {}) ⇒ Types::GetChannelMembershipPreferencesResponse
Gets the membership preferences of an AppInstanceUser
for the
specified channel. The AppInstanceUser
must be a member of the
channel. Only the AppInstanceUser
who owns the membership can
retrieve preferences. Users in the AppInstanceAdmin
and channel
moderator roles can't retrieve preferences for other users. Banned
users can't retrieve membership preferences for the channel from
which they are banned.
1478 1479 1480 1481 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1478 def get_channel_membership_preferences(params = {}, = {}) req = build_request(:get_channel_membership_preferences, params) req.send_request() end |
#get_channel_message(params = {}) ⇒ Types::GetChannelMessageResponse
Gets the full details of a channel message.
AppInstanceUserArn
of the user that makes the API call as the value
in the header.
1536 1537 1538 1539 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1536 def (params = {}, = {}) req = build_request(:get_channel_message, params) req.send_request() end |
#get_channel_message_status(params = {}) ⇒ Types::GetChannelMessageStatusResponse
Gets message status for a specified messageId
. Use this API to
determine the intermediate status of messages going through channel
flow processing. The API provides an alternative to retrieving message
status if the event was not received because a client wasn't
connected to a websocket.
Messages can have any one of these statuses.
- SENT
Message processed successfully
- PENDING
Ongoing processing
- FAILED
Processing failed
- DENIED
Messasge denied by the processor
Only the message sender can invoke this API.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
of the user that makes the API call as the value in the header
1606 1607 1608 1609 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1606 def (params = {}, = {}) req = build_request(:get_channel_message_status, params) req.send_request() end |
#get_messaging_session_endpoint(params = {}) ⇒ Types::GetMessagingSessionEndpointResponse
The details of the endpoint for the messaging session.
1625 1626 1627 1628 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1625 def get_messaging_session_endpoint(params = {}, = {}) req = build_request(:get_messaging_session_endpoint, params) req.send_request() end |
#list_channel_bans(params = {}) ⇒ Types::ListChannelBansResponse
Lists all the users banned from a particular channel.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1680 def list_channel_bans(params = {}, = {}) req = build_request(:list_channel_bans, params) req.send_request() end |
#list_channel_flows(params = {}) ⇒ Types::ListChannelFlowsResponse
Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1730 def list_channel_flows(params = {}, = {}) req = build_request(:list_channel_flows, params) req.send_request() end |
#list_channel_memberships(params = {}) ⇒ Types::ListChannelMembershipsResponse
Lists all channel memberships in a channel.
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.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1799 1800 1801 1802 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1799 def list_channel_memberships(params = {}, = {}) req = build_request(:list_channel_memberships, params) req.send_request() end |
#list_channel_memberships_for_app_instance_user(params = {}) ⇒ Types::ListChannelMembershipsForAppInstanceUserResponse
Lists all channels that a particular AppInstanceUser
is a part of.
Only an AppInstanceAdmin
can call the API with a user ARN that is
not their own.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1860 1861 1862 1863 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1860 def list_channel_memberships_for_app_instance_user(params = {}, = {}) req = build_request(:list_channel_memberships_for_app_instance_user, params) req.send_request() end |
#list_channel_messages(params = {}) ⇒ Types::ListChannelMessagesResponse
List all the messages in a channel. Returns a paginated list of
ChannelMessages
. By default, sorted by creation timestamp in
descending order.
Also, 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1947 def (params = {}, = {}) req = build_request(:list_channel_messages, params) req.send_request() end |
#list_channel_moderators(params = {}) ⇒ Types::ListChannelModeratorsResponse
Lists all the moderators for a channel.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2002 def list_channel_moderators(params = {}, = {}) req = build_request(:list_channel_moderators, params) req.send_request() end |
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2074 def list_channels(params = {}, = {}) req = build_request(:list_channels, params) req.send_request() end |
#list_channels_associated_with_channel_flow(params = {}) ⇒ Types::ListChannelsAssociatedWithChannelFlowResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2122 2123 2124 2125 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2122 def list_channels_associated_with_channel_flow(params = {}, = {}) req = build_request(:list_channels_associated_with_channel_flow, params) req.send_request() end |
#list_channels_moderated_by_app_instance_user(params = {}) ⇒ Types::ListChannelsModeratedByAppInstanceUserResponse
A list of the channels moderated by an AppInstanceUser
.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2179 2180 2181 2182 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2179 def list_channels_moderated_by_app_instance_user(params = {}, = {}) req = build_request(:list_channels_moderated_by_app_instance_user, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK messaging resource.
2209 2210 2211 2212 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2209 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_channel_membership_preferences(params = {}) ⇒ Types::PutChannelMembershipPreferencesResponse
Sets the membership preferences of an AppInstanceUser
for the
specified channel. The AppInstanceUser
must be a member of the
channel. Only the AppInstanceUser
who owns the membership can set
preferences. Users in the AppInstanceAdmin
and channel moderator
roles can't set preferences for other users. Banned users can't set
membership preferences for the channel from which they are banned.
2265 2266 2267 2268 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2265 def put_channel_membership_preferences(params = {}, = {}) req = build_request(:put_channel_membership_preferences, params) req.send_request() end |
#redact_channel_message(params = {}) ⇒ Types::RedactChannelMessageResponse
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
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.
2312 2313 2314 2315 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2312 def (params = {}, = {}) req = build_request(:redact_channel_message, params) req.send_request() end |
#send_channel_message(params = {}) ⇒ Types::SendChannelMessageResponse
Sends a message to a particular channel that the member is a part of.
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.
Also, STANDARD
messages can contain 4KB of data and the 1KB of
metadata. CONTROL
messages can contain 30 bytes of data and no
metadata.
2400 2401 2402 2403 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2400 def (params = {}, = {}) req = build_request(:send_channel_message, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified Amazon Chime SDK messaging resource.
2432 2433 2434 2435 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2432 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Chime SDK messaging resource.
2459 2460 2461 2462 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2459 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
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.
2511 2512 2513 2514 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2511 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_channel_flow(params = {}) ⇒ Types::UpdateChannelFlowResponse
Updates channel flow attributes. This is a developer API.
2559 2560 2561 2562 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2559 def update_channel_flow(params = {}, = {}) req = build_request(:update_channel_flow, params) req.send_request() end |
#update_channel_message(params = {}) ⇒ Types::UpdateChannelMessageResponse
Updates the content of a message.
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.
2614 2615 2616 2617 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2614 def (params = {}, = {}) req = build_request(:update_channel_message, params) req.send_request() end |
#update_channel_read_marker(params = {}) ⇒ Types::UpdateChannelReadMarkerResponse
The details of the time when a user last read messages in a channel.
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.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2652 def update_channel_read_marker(params = {}, = {}) req = build_request(:update_channel_read_marker, params) req.send_request() end |