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 and bots to a channel.
-
#channel_flow_callback(params = {}) ⇒ Types::ChannelFlowCallbackResponse
Calls back Amazon 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 member 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 member 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.
-
#delete_messaging_streaming_configurations(params = {}) ⇒ Struct
Deletes the streaming configurations for an
AppInstance
. -
#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
orAppInstanceBot
. -
#describe_channel_moderated_by_app_instance_user(params = {}) ⇒ Types::DescribeChannelModeratedByAppInstanceUserResponse
Returns the full details of a channel moderated by the specified
AppInstanceUser
orAppInstanceBot
. -
#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
orAppInstanceBot
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.
-
#get_messaging_streaming_configurations(params = {}) ⇒ Types::GetMessagingStreamingConfigurationsResponse
Retrieves the data streaming configuration for an
AppInstance
. -
#list_channel_bans(params = {}) ⇒ Types::ListChannelBansResponse
Lists all the users and bots 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 an
AppInstanceUser
orAppInstanceBot
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_sub_channels(params = {}) ⇒ Types::ListSubChannelsResponse
Lists all the SubChannels in an elastic channel when given a channel ID.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK messaging resource.
-
#put_channel_expiration_settings(params = {}) ⇒ Types::PutChannelExpirationSettingsResponse
Sets the number of days before the channel is automatically deleted.
-
#put_channel_membership_preferences(params = {}) ⇒ Types::PutChannelMembershipPreferencesResponse
Sets the membership preferences of an
AppInstanceUser
orAppInstanceBot
for the specified channel. -
#put_messaging_streaming_configurations(params = {}) ⇒ Types::PutMessagingStreamingConfigurationsResponse
Sets the data streaming configuration for an
AppInstance
. -
#redact_channel_message(params = {}) ⇒ Types::RedactChannelMessageResponse
Redacts message content, but not metadata.
-
#search_channels(params = {}) ⇒ Types::SearchChannelsResponse
Allows the
ChimeBearer
to search channels by channel members. -
#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.
473 474 475 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 473 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
ARN of the AppInstanceUser
or AppInstanceBot
that makes the API
call as the value in the header.
513 514 515 516 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 513 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 and bots to a channel.
581 582 583 584 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 581 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 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
654 655 656 657 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 654 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
762 763 764 765 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 762 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
814 815 816 817 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 814 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
900 901 902 903 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 900 def create_channel_flow(params = {}, = {}) req = build_request(:create_channel_flow, params) req.send_request() end |
#create_channel_membership(params = {}) ⇒ Types::CreateChannelMembershipResponse
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.
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.
984 985 986 987 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 984 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 ARN of
the AppInstanceUser
or AppInstanceBot
of the user that makes the
API call as the value in the header.
1040 1041 1042 1043 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1040 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 ARN of
the AppInstanceUserArn
or AppInstanceBot
that makes the API call
as the value in the header.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1074 def delete_channel(params = {}, = {}) req = build_request(:delete_channel, params) req.send_request() end |
#delete_channel_ban(params = {}) ⇒ Struct
Removes a member from a channel's ban list.
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.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1111 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.
1142 1143 1144 1145 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1142 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.
1188 1189 1190 1191 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1188 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1236 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1273 def delete_channel_moderator(params = {}, = {}) req = build_request(:delete_channel_moderator, params) req.send_request() end |
#delete_messaging_streaming_configurations(params = {}) ⇒ Struct
Deletes the streaming configurations for an AppInstance
. For more
information, see Streaming messaging data in the Amazon Chime
SDK Developer Guide.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1301 def delete_messaging_streaming_configurations(params = {}, = {}) req = build_request(:delete_messaging_streaming_configurations, 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
1356 1357 1358 1359 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1356 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1404 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.
1442 1443 1444 1445 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1442 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
1502 1503 1504 1505 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1502 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
or AppInstanceBot
.
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.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1554 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
or AppInstanceBot
.
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.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1603 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.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1651 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.
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.
1692 1693 1694 1695 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1692 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
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.
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.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1747 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.
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.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1819 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
Message denied by the processor
Only the message sender can invoke this API.
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
1898 1899 1900 1901 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1898 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.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1917 def get_messaging_session_endpoint(params = {}, = {}) req = build_request(:get_messaging_session_endpoint, params) req.send_request() end |
#get_messaging_streaming_configurations(params = {}) ⇒ Types::GetMessagingStreamingConfigurationsResponse
Retrieves the data streaming configuration for an AppInstance
. For
more information, see Streaming messaging data in the Amazon
Chime SDK Developer Guide.
1953 1954 1955 1956 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 1953 def get_messaging_streaming_configurations(params = {}, = {}) req = build_request(:get_messaging_streaming_configurations, params) req.send_request() end |
#list_channel_bans(params = {}) ⇒ Types::ListChannelBansResponse
Lists all the users and bots banned from a particular channel.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2009 2010 2011 2012 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2009 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.
2059 2060 2061 2062 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2059 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2138 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 an AppInstanceUser
or AppInstanceBot
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 ARN of
the AppInstanceUser
or AppInstanceBot
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.
2201 2202 2203 2204 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2201 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
ARN of the AppInstanceUser
or AppInstanceBot
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.
2303 2304 2305 2306 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2303 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 ARN of
the AppInstanceUser
or AppInstanceBot
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.
2359 2360 2361 2362 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2359 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 ARN of
the AppInstanceUser
or AppInstanceBot
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.
2432 2433 2434 2435 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2432 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.
2480 2481 2482 2483 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2480 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 ARN of
the AppInstanceUser
or AppInstanceBot
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.
2538 2539 2540 2541 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2538 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_sub_channels(params = {}) ⇒ Types::ListSubChannelsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2589 2590 2591 2592 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2589 def list_sub_channels(params = {}, = {}) req = build_request(:list_sub_channels, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags applied to an Amazon Chime SDK messaging resource.
2619 2620 2621 2622 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2619 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_channel_expiration_settings(params = {}) ⇒ Types::PutChannelExpirationSettingsResponse
Sets the number of days before the channel is automatically deleted.
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 theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
2675 2676 2677 2678 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2675 def put_channel_expiration_settings(params = {}, = {}) req = build_request(:put_channel_expiration_settings, params) req.send_request() end |
#put_channel_membership_preferences(params = {}) ⇒ Types::PutChannelMembershipPreferencesResponse
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.
AppInstanceUser
or AppInstanceBot
that makes the API call as the
value in the header.
2739 2740 2741 2742 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2739 def put_channel_membership_preferences(params = {}, = {}) req = build_request(:put_channel_membership_preferences, params) req.send_request() end |
#put_messaging_streaming_configurations(params = {}) ⇒ Types::PutMessagingStreamingConfigurationsResponse
Sets the data streaming configuration for an AppInstance
. For more
information, see Streaming messaging data in the Amazon Chime
SDK Developer Guide.
2784 2785 2786 2787 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2784 def put_messaging_streaming_configurations(params = {}, = {}) req = build_request(:put_messaging_streaming_configurations, 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2838 def (params = {}, = {}) req = build_request(:redact_channel_message, params) req.send_request() end |
#search_channels(params = {}) ⇒ Types::SearchChannelsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2901 2902 2903 2904 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 2901 def search_channels(params = {}, = {}) req = build_request(:search_channels, 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 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.
3022 3023 3024 3025 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 3022 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.
3054 3055 3056 3057 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 3054 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.
3081 3082 3083 3084 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 3081 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
3134 3135 3136 3137 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 3134 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.
3182 3183 3184 3185 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 3182 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
3253 3254 3255 3256 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 3253 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 ARN of
the AppInstanceUser
or AppInstanceBot
that makes the API call as
the value in the header.
3292 3293 3294 3295 |
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/client.rb', line 3292 def update_channel_read_marker(params = {}, = {}) req = build_request(:update_channel_read_marker, params) req.send_request() end |