aws-sdk-chime 1.35.0 → 1.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-chime.rb +2 -1
- data/lib/aws-sdk-chime/client.rb +3008 -234
- data/lib/aws-sdk-chime/client_api.rb +2062 -71
- data/lib/aws-sdk-chime/types.rb +4999 -1384
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c963ae7fbfc6691c04788eec29967c2fa8a201157f17eb2761f97bb418bd5b71
|
4
|
+
data.tar.gz: 78daf053a5f9c68054b49bf3465a8285f31faf5e86277312ed32b9290d0d421a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 40b707bbff49ae8354b76dd03b8a43b42767e9456a0279ce29fb80dfa23af8ef3641a83af9d4ce687aa3bdb5bdfc993e27c4ed1a6fdfffff27e8490aed28f1e2
|
7
|
+
data.tar.gz: bd6b58c21f94422ee0b2ab619511236d452ba6b5c9d2ddac165b041e5015290f4851e1c6b55031370ea673dd88270421f2819a454c86999f6ddb6bb52f98f69e
|
data/lib/aws-sdk-chime.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-chime/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::Chime
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.40.0'
|
51
52
|
|
52
53
|
end
|
data/lib/aws-sdk-chime/client.rb
CHANGED
@@ -531,9 +531,9 @@ module Aws::Chime
|
|
531
531
|
end
|
532
532
|
|
533
533
|
# Adds up to 50 members to a chat room in an Amazon Chime Enterprise
|
534
|
-
# account. Members can be
|
535
|
-
#
|
536
|
-
#
|
534
|
+
# account. Members can be users or bots. The member role designates
|
535
|
+
# whether the member is a chat room administrator or a general chat room
|
536
|
+
# member.
|
537
537
|
#
|
538
538
|
# @option params [required, String] :account_id
|
539
539
|
# The Amazon Chime account ID.
|
@@ -619,7 +619,7 @@ module Aws::Chime
|
|
619
619
|
# Administration Guide*.
|
620
620
|
#
|
621
621
|
# Users suspended from a `Team` account are disassociated from the
|
622
|
-
# account,
|
622
|
+
# account,but they can continue to use Amazon Chime as free users. To
|
623
623
|
# remove the suspension from suspended `Team` account users, invite them
|
624
624
|
# to the `Team` account again. You can use the InviteUsers action to do
|
625
625
|
# so.
|
@@ -716,7 +716,7 @@ module Aws::Chime
|
|
716
716
|
end
|
717
717
|
|
718
718
|
# Updates phone number product types or calling names. You can update
|
719
|
-
# one attribute at a time for each `UpdatePhoneNumberRequestItem
|
719
|
+
# one attribute at a time for each `UpdatePhoneNumberRequestItem` . For
|
720
720
|
# example, you can update either the product type or the calling name.
|
721
721
|
#
|
722
722
|
# For product types, choose from Amazon Chime Business Calling and
|
@@ -855,6 +855,157 @@ module Aws::Chime
|
|
855
855
|
req.send_request(options)
|
856
856
|
end
|
857
857
|
|
858
|
+
# Creates an Amazon Chime SDK messaging `AppInstance` under an AWS
|
859
|
+
# account. Only SDK messaging customers use this API.
|
860
|
+
# `CreateAppInstance` supports idempotency behavior as described in the
|
861
|
+
# AWS API Standard.
|
862
|
+
#
|
863
|
+
# @option params [required, String] :name
|
864
|
+
# The name of the `AppInstance`.
|
865
|
+
#
|
866
|
+
# @option params [String] :metadata
|
867
|
+
# The metadata of the `AppInstance`. Limited to a 1KB string in UTF-8.
|
868
|
+
#
|
869
|
+
# @option params [required, String] :client_request_token
|
870
|
+
# The `ClientRequestToken` of the `AppInstance`.
|
871
|
+
#
|
872
|
+
# **A suitable default value is auto-generated.** You should normally
|
873
|
+
# not need to pass this option.**
|
874
|
+
#
|
875
|
+
# @option params [Array<Types::Tag>] :tags
|
876
|
+
# Tags assigned to the `AppInstanceUser`.
|
877
|
+
#
|
878
|
+
# @return [Types::CreateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
879
|
+
#
|
880
|
+
# * {Types::CreateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
|
881
|
+
#
|
882
|
+
# @example Request syntax with placeholder values
|
883
|
+
#
|
884
|
+
# resp = client.create_app_instance({
|
885
|
+
# name: "NonEmptyResourceName", # required
|
886
|
+
# metadata: "Metadata",
|
887
|
+
# client_request_token: "ClientRequestToken", # required
|
888
|
+
# tags: [
|
889
|
+
# {
|
890
|
+
# key: "TagKey", # required
|
891
|
+
# value: "TagValue", # required
|
892
|
+
# },
|
893
|
+
# ],
|
894
|
+
# })
|
895
|
+
#
|
896
|
+
# @example Response structure
|
897
|
+
#
|
898
|
+
# resp.app_instance_arn #=> String
|
899
|
+
#
|
900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstance AWS API Documentation
|
901
|
+
#
|
902
|
+
# @overload create_app_instance(params = {})
|
903
|
+
# @param [Hash] params ({})
|
904
|
+
def create_app_instance(params = {}, options = {})
|
905
|
+
req = build_request(:create_app_instance, params)
|
906
|
+
req.send_request(options)
|
907
|
+
end
|
908
|
+
|
909
|
+
# Promotes an `AppInstanceUser` to an `AppInstanceAdmin`. The promoted
|
910
|
+
# user can perform the following actions.
|
911
|
+
#
|
912
|
+
# * `ChannelModerator` actions across all channels in the `AppInstance`.
|
913
|
+
#
|
914
|
+
# * `DeleteChannelMessage` actions.
|
915
|
+
#
|
916
|
+
# Only an `AppInstanceUser` can be promoted to an `AppInstanceAdmin`
|
917
|
+
# role.
|
918
|
+
#
|
919
|
+
# @option params [required, String] :app_instance_admin_arn
|
920
|
+
# The ARN of the administrator of the current `AppInstance`.
|
921
|
+
#
|
922
|
+
# @option params [required, String] :app_instance_arn
|
923
|
+
# The ARN of the `AppInstance`.
|
924
|
+
#
|
925
|
+
# @return [Types::CreateAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
926
|
+
#
|
927
|
+
# * {Types::CreateAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::Identity
|
928
|
+
# * {Types::CreateAppInstanceAdminResponse#app_instance_arn #app_instance_arn} => String
|
929
|
+
#
|
930
|
+
# @example Request syntax with placeholder values
|
931
|
+
#
|
932
|
+
# resp = client.create_app_instance_admin({
|
933
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
934
|
+
# app_instance_arn: "ChimeArn", # required
|
935
|
+
# })
|
936
|
+
#
|
937
|
+
# @example Response structure
|
938
|
+
#
|
939
|
+
# resp.app_instance_admin.arn #=> String
|
940
|
+
# resp.app_instance_admin.name #=> String
|
941
|
+
# resp.app_instance_arn #=> String
|
942
|
+
#
|
943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstanceAdmin AWS API Documentation
|
944
|
+
#
|
945
|
+
# @overload create_app_instance_admin(params = {})
|
946
|
+
# @param [Hash] params ({})
|
947
|
+
def create_app_instance_admin(params = {}, options = {})
|
948
|
+
req = build_request(:create_app_instance_admin, params)
|
949
|
+
req.send_request(options)
|
950
|
+
end
|
951
|
+
|
952
|
+
# Creates a user under an Amazon Chime `AppInstance`. The request
|
953
|
+
# consists of a unique `appInstanceUserId` and `Name` for that user.
|
954
|
+
#
|
955
|
+
# @option params [required, String] :app_instance_arn
|
956
|
+
# The ARN of the `AppInstance` request.
|
957
|
+
#
|
958
|
+
# @option params [required, String] :app_instance_user_id
|
959
|
+
# The user ID of the `AppInstance`.
|
960
|
+
#
|
961
|
+
# @option params [required, String] :name
|
962
|
+
# The user's name.
|
963
|
+
#
|
964
|
+
# @option params [String] :metadata
|
965
|
+
# The request's metadata. Limited to a 1KB string in UTF-8.
|
966
|
+
#
|
967
|
+
# @option params [required, String] :client_request_token
|
968
|
+
# The token assigned to the user requesting an `AppInstance`.
|
969
|
+
#
|
970
|
+
# **A suitable default value is auto-generated.** You should normally
|
971
|
+
# not need to pass this option.**
|
972
|
+
#
|
973
|
+
# @option params [Array<Types::Tag>] :tags
|
974
|
+
# Tags assigned to the `AppInstanceUser`.
|
975
|
+
#
|
976
|
+
# @return [Types::CreateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
977
|
+
#
|
978
|
+
# * {Types::CreateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
|
979
|
+
#
|
980
|
+
# @example Request syntax with placeholder values
|
981
|
+
#
|
982
|
+
# resp = client.create_app_instance_user({
|
983
|
+
# app_instance_arn: "ChimeArn", # required
|
984
|
+
# app_instance_user_id: "UserId", # required
|
985
|
+
# name: "UserName", # required
|
986
|
+
# metadata: "Metadata",
|
987
|
+
# client_request_token: "ClientRequestToken", # required
|
988
|
+
# tags: [
|
989
|
+
# {
|
990
|
+
# key: "TagKey", # required
|
991
|
+
# value: "TagValue", # required
|
992
|
+
# },
|
993
|
+
# ],
|
994
|
+
# })
|
995
|
+
#
|
996
|
+
# @example Response structure
|
997
|
+
#
|
998
|
+
# resp.app_instance_user_arn #=> String
|
999
|
+
#
|
1000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstanceUser AWS API Documentation
|
1001
|
+
#
|
1002
|
+
# @overload create_app_instance_user(params = {})
|
1003
|
+
# @param [Hash] params ({})
|
1004
|
+
def create_app_instance_user(params = {}, options = {})
|
1005
|
+
req = build_request(:create_app_instance_user, params)
|
1006
|
+
req.send_request(options)
|
1007
|
+
end
|
1008
|
+
|
858
1009
|
# Creates a new attendee for an active Amazon Chime SDK meeting. For
|
859
1010
|
# more information about the Amazon Chime SDK, see [Using the Amazon
|
860
1011
|
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
@@ -867,8 +1018,8 @@ module Aws::Chime
|
|
867
1018
|
# The Amazon Chime SDK meeting ID.
|
868
1019
|
#
|
869
1020
|
# @option params [required, String] :external_user_id
|
870
|
-
# The Amazon Chime SDK external user ID.
|
871
|
-
# identity managed by a builder application.
|
1021
|
+
# The Amazon Chime SDK external user ID. An idempotency token. Links the
|
1022
|
+
# attendee to an identity managed by a builder application.
|
872
1023
|
#
|
873
1024
|
# @option params [Array<Types::Tag>] :tags
|
874
1025
|
# The tag key-value pairs.
|
@@ -949,11 +1100,266 @@ module Aws::Chime
|
|
949
1100
|
req.send_request(options)
|
950
1101
|
end
|
951
1102
|
|
1103
|
+
# Creates a channel to which you can add users and send messages.
|
1104
|
+
#
|
1105
|
+
# **Restriction**\: You can't change a channel's privacy.
|
1106
|
+
#
|
1107
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1108
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1109
|
+
# in the header.
|
1110
|
+
#
|
1111
|
+
# </note>
|
1112
|
+
#
|
1113
|
+
# @option params [required, String] :app_instance_arn
|
1114
|
+
# The ARN of the channel request.
|
1115
|
+
#
|
1116
|
+
# @option params [required, String] :name
|
1117
|
+
# The name of the channel.
|
1118
|
+
#
|
1119
|
+
# @option params [String] :mode
|
1120
|
+
# The channel mode: `UNRESTRICTED` or `RESTRICTED`. Administrators,
|
1121
|
+
# moderators, and channel members can add themselves and other members
|
1122
|
+
# to unrestricted channels. Only administrators and moderators can add
|
1123
|
+
# members to restricted channels.
|
1124
|
+
#
|
1125
|
+
# @option params [String] :privacy
|
1126
|
+
# The channel's privacy level: `PUBLIC` or `PRIVATE`. Private channels
|
1127
|
+
# aren't discoverable by users outside the channel. Public channels are
|
1128
|
+
# discoverable by anyone in the `AppInstance`.
|
1129
|
+
#
|
1130
|
+
# @option params [String] :metadata
|
1131
|
+
# The metadata of the creation request. Limited to 1KB and UTF-8.
|
1132
|
+
#
|
1133
|
+
# @option params [required, String] :client_request_token
|
1134
|
+
# The client token for the request. An `Idempotency` token.
|
1135
|
+
#
|
1136
|
+
# **A suitable default value is auto-generated.** You should normally
|
1137
|
+
# not need to pass this option.**
|
1138
|
+
#
|
1139
|
+
# @option params [Array<Types::Tag>] :tags
|
1140
|
+
# The tags for the creation request.
|
1141
|
+
#
|
1142
|
+
# @option params [String] :chime_bearer
|
1143
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1144
|
+
#
|
1145
|
+
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1146
|
+
#
|
1147
|
+
# * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
|
1148
|
+
#
|
1149
|
+
# @example Request syntax with placeholder values
|
1150
|
+
#
|
1151
|
+
# resp = client.create_channel({
|
1152
|
+
# app_instance_arn: "ChimeArn", # required
|
1153
|
+
# name: "NonEmptyResourceName", # required
|
1154
|
+
# mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
|
1155
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
1156
|
+
# metadata: "Metadata",
|
1157
|
+
# client_request_token: "ClientRequestToken", # required
|
1158
|
+
# tags: [
|
1159
|
+
# {
|
1160
|
+
# key: "TagKey", # required
|
1161
|
+
# value: "TagValue", # required
|
1162
|
+
# },
|
1163
|
+
# ],
|
1164
|
+
# chime_bearer: "ChimeArn",
|
1165
|
+
# })
|
1166
|
+
#
|
1167
|
+
# @example Response structure
|
1168
|
+
#
|
1169
|
+
# resp.channel_arn #=> String
|
1170
|
+
#
|
1171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannel AWS API Documentation
|
1172
|
+
#
|
1173
|
+
# @overload create_channel(params = {})
|
1174
|
+
# @param [Hash] params ({})
|
1175
|
+
def create_channel(params = {}, options = {})
|
1176
|
+
req = build_request(:create_channel, params)
|
1177
|
+
req.send_request(options)
|
1178
|
+
end
|
1179
|
+
|
1180
|
+
# Permanently bans a member from a channel. Moderators can't add banned
|
1181
|
+
# members to a channel. To undo a ban, you first have to
|
1182
|
+
# `DeleteChannelBan`, and then `CreateChannelMembership`. Bans are
|
1183
|
+
# cleaned up when you delete users or channels.
|
1184
|
+
#
|
1185
|
+
# If you ban a user who is already part of a channel, that user is
|
1186
|
+
# automatically kicked from the channel.
|
1187
|
+
#
|
1188
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1189
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1190
|
+
# in the header.
|
1191
|
+
#
|
1192
|
+
# </note>
|
1193
|
+
#
|
1194
|
+
# @option params [required, String] :channel_arn
|
1195
|
+
# The ARN of the ban request.
|
1196
|
+
#
|
1197
|
+
# @option params [required, String] :member_arn
|
1198
|
+
# The ARN of the member being banned.
|
1199
|
+
#
|
1200
|
+
# @option params [String] :chime_bearer
|
1201
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1202
|
+
#
|
1203
|
+
# @return [Types::CreateChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1204
|
+
#
|
1205
|
+
# * {Types::CreateChannelBanResponse#channel_arn #channel_arn} => String
|
1206
|
+
# * {Types::CreateChannelBanResponse#member #member} => Types::Identity
|
1207
|
+
#
|
1208
|
+
# @example Request syntax with placeholder values
|
1209
|
+
#
|
1210
|
+
# resp = client.create_channel_ban({
|
1211
|
+
# channel_arn: "ChimeArn", # required
|
1212
|
+
# member_arn: "ChimeArn", # required
|
1213
|
+
# chime_bearer: "ChimeArn",
|
1214
|
+
# })
|
1215
|
+
#
|
1216
|
+
# @example Response structure
|
1217
|
+
#
|
1218
|
+
# resp.channel_arn #=> String
|
1219
|
+
# resp.member.arn #=> String
|
1220
|
+
# resp.member.name #=> String
|
1221
|
+
#
|
1222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelBan AWS API Documentation
|
1223
|
+
#
|
1224
|
+
# @overload create_channel_ban(params = {})
|
1225
|
+
# @param [Hash] params ({})
|
1226
|
+
def create_channel_ban(params = {}, options = {})
|
1227
|
+
req = build_request(:create_channel_ban, params)
|
1228
|
+
req.send_request(options)
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# Adds a user to a channel. The `InvitedBy` response field is derived
|
1232
|
+
# from the request header. A channel member can:
|
1233
|
+
#
|
1234
|
+
# * List messages
|
1235
|
+
#
|
1236
|
+
# * Send messages
|
1237
|
+
#
|
1238
|
+
# * Receive messages
|
1239
|
+
#
|
1240
|
+
# * Edit their own messages
|
1241
|
+
#
|
1242
|
+
# * Leave the channel
|
1243
|
+
#
|
1244
|
+
# Privacy settings impact this action as follows:
|
1245
|
+
#
|
1246
|
+
# * Public Channels: You do not need to be a member to list messages,
|
1247
|
+
# but you must be a member to send messages.
|
1248
|
+
#
|
1249
|
+
# * Private Channels: You must be a member to list or send messages.
|
1250
|
+
#
|
1251
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1252
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1253
|
+
# in the header.
|
1254
|
+
#
|
1255
|
+
# </note>
|
1256
|
+
#
|
1257
|
+
# @option params [required, String] :channel_arn
|
1258
|
+
# The ARN of the channel to which you're adding users.
|
1259
|
+
#
|
1260
|
+
# @option params [required, String] :member_arn
|
1261
|
+
# The ARN of the member you want to add to the channel.
|
1262
|
+
#
|
1263
|
+
# @option params [required, String] :type
|
1264
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
1265
|
+
# are always returned as part of `ListChannelMemberships`. Hidden
|
1266
|
+
# members are only returned if the type filter in
|
1267
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
|
1268
|
+
# not returned. This is only supported by moderators.
|
1269
|
+
#
|
1270
|
+
# @option params [String] :chime_bearer
|
1271
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1272
|
+
#
|
1273
|
+
# @return [Types::CreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1274
|
+
#
|
1275
|
+
# * {Types::CreateChannelMembershipResponse#channel_arn #channel_arn} => String
|
1276
|
+
# * {Types::CreateChannelMembershipResponse#member #member} => Types::Identity
|
1277
|
+
#
|
1278
|
+
# @example Request syntax with placeholder values
|
1279
|
+
#
|
1280
|
+
# resp = client.create_channel_membership({
|
1281
|
+
# channel_arn: "ChimeArn", # required
|
1282
|
+
# member_arn: "ChimeArn", # required
|
1283
|
+
# type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
|
1284
|
+
# chime_bearer: "ChimeArn",
|
1285
|
+
# })
|
1286
|
+
#
|
1287
|
+
# @example Response structure
|
1288
|
+
#
|
1289
|
+
# resp.channel_arn #=> String
|
1290
|
+
# resp.member.arn #=> String
|
1291
|
+
# resp.member.name #=> String
|
1292
|
+
#
|
1293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelMembership AWS API Documentation
|
1294
|
+
#
|
1295
|
+
# @overload create_channel_membership(params = {})
|
1296
|
+
# @param [Hash] params ({})
|
1297
|
+
def create_channel_membership(params = {}, options = {})
|
1298
|
+
req = build_request(:create_channel_membership, params)
|
1299
|
+
req.send_request(options)
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
# Creates a new `ChannelModerator`. A channel moderator can:
|
1303
|
+
#
|
1304
|
+
# * Add and remove other members of the channel.
|
1305
|
+
#
|
1306
|
+
# * Add and remove other moderators of the channel.
|
1307
|
+
#
|
1308
|
+
# * Add and remove user bans for the channel.
|
1309
|
+
#
|
1310
|
+
# * Redact messages in the channel.
|
1311
|
+
#
|
1312
|
+
# * List messages in the channel.
|
1313
|
+
#
|
1314
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1315
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1316
|
+
# in the header.
|
1317
|
+
#
|
1318
|
+
# </note>
|
1319
|
+
#
|
1320
|
+
# @option params [required, String] :channel_arn
|
1321
|
+
# The ARN of the channel.
|
1322
|
+
#
|
1323
|
+
# @option params [required, String] :channel_moderator_arn
|
1324
|
+
# The ARN of the moderator.
|
1325
|
+
#
|
1326
|
+
# @option params [String] :chime_bearer
|
1327
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1328
|
+
#
|
1329
|
+
# @return [Types::CreateChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1330
|
+
#
|
1331
|
+
# * {Types::CreateChannelModeratorResponse#channel_arn #channel_arn} => String
|
1332
|
+
# * {Types::CreateChannelModeratorResponse#channel_moderator #channel_moderator} => Types::Identity
|
1333
|
+
#
|
1334
|
+
# @example Request syntax with placeholder values
|
1335
|
+
#
|
1336
|
+
# resp = client.create_channel_moderator({
|
1337
|
+
# channel_arn: "ChimeArn", # required
|
1338
|
+
# channel_moderator_arn: "ChimeArn", # required
|
1339
|
+
# chime_bearer: "ChimeArn",
|
1340
|
+
# })
|
1341
|
+
#
|
1342
|
+
# @example Response structure
|
1343
|
+
#
|
1344
|
+
# resp.channel_arn #=> String
|
1345
|
+
# resp.channel_moderator.arn #=> String
|
1346
|
+
# resp.channel_moderator.name #=> String
|
1347
|
+
#
|
1348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelModerator AWS API Documentation
|
1349
|
+
#
|
1350
|
+
# @overload create_channel_moderator(params = {})
|
1351
|
+
# @param [Hash] params ({})
|
1352
|
+
def create_channel_moderator(params = {}, options = {})
|
1353
|
+
req = build_request(:create_channel_moderator, params)
|
1354
|
+
req.send_request(options)
|
1355
|
+
end
|
1356
|
+
|
952
1357
|
# Creates a new Amazon Chime SDK meeting in the specified media Region
|
953
1358
|
# with no initial attendees. For more information about specifying media
|
954
1359
|
# Regions, see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime
|
955
|
-
# Developer Guide
|
956
|
-
# [Using the Amazon Chime SDK][2] in the *Amazon Chime Developer
|
1360
|
+
# Developer Guide* . For more information about the Amazon Chime SDK,
|
1361
|
+
# see [Using the Amazon Chime SDK][2] in the *Amazon Chime Developer
|
1362
|
+
# Guide* .
|
957
1363
|
#
|
958
1364
|
#
|
959
1365
|
#
|
@@ -976,11 +1382,11 @@ module Aws::Chime
|
|
976
1382
|
# @option params [String] :media_region
|
977
1383
|
# The Region in which to create the meeting. Default: `us-east-1`.
|
978
1384
|
#
|
979
|
-
# Available values: `af-south-1
|
980
|
-
# `ap-south-1
|
981
|
-
# `eu-central-1
|
982
|
-
# `eu-west-3
|
983
|
-
# `us-west-2
|
1385
|
+
# Available values: `af-south-1` , `ap-northeast-1` , `ap-northeast-2` ,
|
1386
|
+
# `ap-south-1` , `ap-southeast-1` , `ap-southeast-2` , `ca-central-1` ,
|
1387
|
+
# `eu-central-1` , `eu-north-1` , `eu-south-1` , `eu-west-1` ,
|
1388
|
+
# `eu-west-2` , `eu-west-3` , `sa-east-1` , `us-east-1` , `us-east-2` ,
|
1389
|
+
# `us-west-1` , `us-west-2` .
|
984
1390
|
#
|
985
1391
|
# @option params [Array<Types::Tag>] :tags
|
986
1392
|
# The tag key-value pairs.
|
@@ -1034,11 +1440,64 @@ module Aws::Chime
|
|
1034
1440
|
req.send_request(options)
|
1035
1441
|
end
|
1036
1442
|
|
1443
|
+
# Uses the join token and call metadata in a meeting request (From
|
1444
|
+
# number, To number, and so forth) to initiate an outbound call to a
|
1445
|
+
# public switched telephone network (PSTN) and join them into a Chime
|
1446
|
+
# meeting. Also ensures that the From number belongs to the customer.
|
1447
|
+
#
|
1448
|
+
# To play welcome audio or implement an interactive voice response
|
1449
|
+
# (IVR), use the `CreateSipMediaApplicationCall` action with the
|
1450
|
+
# corresponding SIP media application ID.
|
1451
|
+
#
|
1452
|
+
# @option params [required, String] :meeting_id
|
1453
|
+
# The Amazon Chime SDK meeting ID.
|
1454
|
+
#
|
1455
|
+
# @option params [required, String] :from_phone_number
|
1456
|
+
# Phone number used as the caller ID when the remote party receives a
|
1457
|
+
# call.
|
1458
|
+
#
|
1459
|
+
# @option params [required, String] :to_phone_number
|
1460
|
+
# Phone number called when inviting someone to a meeting.
|
1461
|
+
#
|
1462
|
+
# @option params [required, String] :join_token
|
1463
|
+
# Token used by the Amazon Chime SDK attendee. Call the
|
1464
|
+
# [CreateAttendee][1] action to get a join token.
|
1465
|
+
#
|
1466
|
+
#
|
1467
|
+
#
|
1468
|
+
# [1]: https://docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.htmlCreateAttendee
|
1469
|
+
#
|
1470
|
+
# @return [Types::CreateMeetingDialOutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1471
|
+
#
|
1472
|
+
# * {Types::CreateMeetingDialOutResponse#transaction_id #transaction_id} => String
|
1473
|
+
#
|
1474
|
+
# @example Request syntax with placeholder values
|
1475
|
+
#
|
1476
|
+
# resp = client.create_meeting_dial_out({
|
1477
|
+
# meeting_id: "GuidString", # required
|
1478
|
+
# from_phone_number: "E164PhoneNumber", # required
|
1479
|
+
# to_phone_number: "E164PhoneNumber", # required
|
1480
|
+
# join_token: "JoinTokenString", # required
|
1481
|
+
# })
|
1482
|
+
#
|
1483
|
+
# @example Response structure
|
1484
|
+
#
|
1485
|
+
# resp.transaction_id #=> String
|
1486
|
+
#
|
1487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateMeetingDialOut AWS API Documentation
|
1488
|
+
#
|
1489
|
+
# @overload create_meeting_dial_out(params = {})
|
1490
|
+
# @param [Hash] params ({})
|
1491
|
+
def create_meeting_dial_out(params = {}, options = {})
|
1492
|
+
req = build_request(:create_meeting_dial_out, params)
|
1493
|
+
req.send_request(options)
|
1494
|
+
end
|
1495
|
+
|
1037
1496
|
# Creates a new Amazon Chime SDK meeting in the specified media Region,
|
1038
1497
|
# with attendees. For more information about specifying media Regions,
|
1039
1498
|
# see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime Developer
|
1040
|
-
# Guide
|
1041
|
-
# the Amazon Chime SDK][2] in the *Amazon Chime Developer Guide
|
1499
|
+
# Guide* . For more information about the Amazon Chime SDK, see [Using
|
1500
|
+
# the Amazon Chime SDK][2] in the *Amazon Chime Developer Guide* .
|
1042
1501
|
#
|
1043
1502
|
#
|
1044
1503
|
#
|
@@ -1059,21 +1518,21 @@ module Aws::Chime
|
|
1059
1518
|
# Reserved.
|
1060
1519
|
#
|
1061
1520
|
# @option params [String] :media_region
|
1062
|
-
# The Region in which to create the meeting. Default: `us-east-1
|
1521
|
+
# The Region in which to create the meeting. Default: `us-east-1` .
|
1063
1522
|
#
|
1064
|
-
# Available values: `af-south-1
|
1065
|
-
# `ap-south-1
|
1066
|
-
# `eu-central-1
|
1067
|
-
# `eu-west-3
|
1068
|
-
# `us-west-2
|
1523
|
+
# Available values: `af-south-1` , `ap-northeast-1` , `ap-northeast-2` ,
|
1524
|
+
# `ap-south-1` , `ap-southeast-1` , `ap-southeast-2` , `ca-central-1` ,
|
1525
|
+
# `eu-central-1` , `eu-north-1` , `eu-south-1` , `eu-west-1` ,
|
1526
|
+
# `eu-west-2` , `eu-west-3` , `sa-east-1` , `us-east-1` , `us-east-2` ,
|
1527
|
+
# `us-west-1` , `us-west-2` .
|
1069
1528
|
#
|
1070
1529
|
# @option params [Array<Types::Tag>] :tags
|
1071
1530
|
# The tag key-value pairs.
|
1072
1531
|
#
|
1073
1532
|
# @option params [Types::MeetingNotificationConfiguration] :notifications_configuration
|
1074
|
-
# The
|
1075
|
-
#
|
1076
|
-
#
|
1533
|
+
# The resource target configurations for receiving Amazon Chime SDK
|
1534
|
+
# meeting and attendee event notifications. The Amazon Chime SDK
|
1535
|
+
# supports resource targets located in the US East (N. Virginia) AWS
|
1077
1536
|
# Region (`us-east-1`).
|
1078
1537
|
#
|
1079
1538
|
# @option params [Array<Types::CreateAttendeeRequestItem>] :attendees
|
@@ -1360,36 +1819,191 @@ module Aws::Chime
|
|
1360
1819
|
req.send_request(options)
|
1361
1820
|
end
|
1362
1821
|
|
1363
|
-
# Creates a
|
1364
|
-
#
|
1365
|
-
# @option params [required, String] :account_id
|
1366
|
-
# The Amazon Chime account ID.
|
1822
|
+
# Creates a SIP media application.
|
1367
1823
|
#
|
1368
|
-
# @option params [String] :
|
1369
|
-
# The
|
1824
|
+
# @option params [required, String] :aws_region
|
1825
|
+
# The AWS Region assigned to the SIP media application.
|
1370
1826
|
#
|
1371
|
-
# @option params [String] :
|
1372
|
-
# The
|
1827
|
+
# @option params [required, String] :name
|
1828
|
+
# The SIP media application name.
|
1373
1829
|
#
|
1374
|
-
# @option params [
|
1375
|
-
#
|
1830
|
+
# @option params [required, Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
1831
|
+
# List of endpoints (Lambda Amazon Resource Names) specified for the SIP
|
1832
|
+
# media application. Currently, only one endpoint is supported.
|
1376
1833
|
#
|
1377
|
-
# @return [Types::
|
1834
|
+
# @return [Types::CreateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1378
1835
|
#
|
1379
|
-
# * {Types::
|
1836
|
+
# * {Types::CreateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
1380
1837
|
#
|
1381
1838
|
# @example Request syntax with placeholder values
|
1382
1839
|
#
|
1383
|
-
# resp = client.
|
1384
|
-
#
|
1385
|
-
#
|
1386
|
-
#
|
1387
|
-
#
|
1840
|
+
# resp = client.create_sip_media_application({
|
1841
|
+
# aws_region: "String", # required
|
1842
|
+
# name: "SipMediaApplicationName", # required
|
1843
|
+
# endpoints: [ # required
|
1844
|
+
# {
|
1845
|
+
# lambda_arn: "FunctionArn",
|
1846
|
+
# },
|
1847
|
+
# ],
|
1388
1848
|
# })
|
1389
1849
|
#
|
1390
1850
|
# @example Response structure
|
1391
1851
|
#
|
1392
|
-
# resp.
|
1852
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
1853
|
+
# resp.sip_media_application.aws_region #=> String
|
1854
|
+
# resp.sip_media_application.name #=> String
|
1855
|
+
# resp.sip_media_application.endpoints #=> Array
|
1856
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
1857
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
1858
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
1859
|
+
#
|
1860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplication AWS API Documentation
|
1861
|
+
#
|
1862
|
+
# @overload create_sip_media_application(params = {})
|
1863
|
+
# @param [Hash] params ({})
|
1864
|
+
def create_sip_media_application(params = {}, options = {})
|
1865
|
+
req = build_request(:create_sip_media_application, params)
|
1866
|
+
req.send_request(options)
|
1867
|
+
end
|
1868
|
+
|
1869
|
+
# Creates an outbound call to a phone number from the phone number
|
1870
|
+
# specified in the request, and it invokes the endpoint of the specified
|
1871
|
+
# `sipMediaApplicationId`.
|
1872
|
+
#
|
1873
|
+
# @option params [required, String] :from_phone_number
|
1874
|
+
# The phone number that a user calls from.
|
1875
|
+
#
|
1876
|
+
# @option params [required, String] :to_phone_number
|
1877
|
+
# The phone number that the user dials in order to connect to a meeting.
|
1878
|
+
#
|
1879
|
+
# @option params [required, String] :sip_media_application_id
|
1880
|
+
# The ID of the SIP media application.
|
1881
|
+
#
|
1882
|
+
# @return [Types::CreateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1883
|
+
#
|
1884
|
+
# * {Types::CreateSipMediaApplicationCallResponse#sip_media_application_call #sip_media_application_call} => Types::SipMediaApplicationCall
|
1885
|
+
#
|
1886
|
+
# @example Request syntax with placeholder values
|
1887
|
+
#
|
1888
|
+
# resp = client.create_sip_media_application_call({
|
1889
|
+
# from_phone_number: "E164PhoneNumber", # required
|
1890
|
+
# to_phone_number: "E164PhoneNumber", # required
|
1891
|
+
# sip_media_application_id: "NonEmptyString", # required
|
1892
|
+
# })
|
1893
|
+
#
|
1894
|
+
# @example Response structure
|
1895
|
+
#
|
1896
|
+
# resp.sip_media_application_call.transaction_id #=> String
|
1897
|
+
#
|
1898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplicationCall AWS API Documentation
|
1899
|
+
#
|
1900
|
+
# @overload create_sip_media_application_call(params = {})
|
1901
|
+
# @param [Hash] params ({})
|
1902
|
+
def create_sip_media_application_call(params = {}, options = {})
|
1903
|
+
req = build_request(:create_sip_media_application_call, params)
|
1904
|
+
req.send_request(options)
|
1905
|
+
end
|
1906
|
+
|
1907
|
+
# Creates a SIP rule which can be used to run a SIP media application as
|
1908
|
+
# a target for a specific trigger type.
|
1909
|
+
#
|
1910
|
+
# @option params [required, String] :name
|
1911
|
+
# The name of the SIP rule.
|
1912
|
+
#
|
1913
|
+
# @option params [required, String] :trigger_type
|
1914
|
+
# The type of trigger assigned to the SIP rule in `TriggerValue`,
|
1915
|
+
# currently `RequestUriHostname` or `ToPhoneNumber`.
|
1916
|
+
#
|
1917
|
+
# @option params [required, String] :trigger_value
|
1918
|
+
# If `TriggerType` is `RequestUriHostname`, the value can be the
|
1919
|
+
# outbound host name of an Amazon Chime Voice Connector. If
|
1920
|
+
# `TriggerType` is `ToPhoneNumber`, the value can be a customer-owned
|
1921
|
+
# phone number in the E164 format. The `SipMediaApplication` specified
|
1922
|
+
# in the `SipRule` is triggered if the request URI in an incoming SIP
|
1923
|
+
# request matches the `RequestUriHostname`, or if the `To` header in the
|
1924
|
+
# incoming SIP request matches the `ToPhoneNumber` value.
|
1925
|
+
#
|
1926
|
+
# @option params [Boolean] :disabled
|
1927
|
+
# Enables or disables a rule. You must disable rules before you can
|
1928
|
+
# delete them.
|
1929
|
+
#
|
1930
|
+
# @option params [required, Array<Types::SipRuleTargetApplication>] :target_applications
|
1931
|
+
# List of SIP media applications with priority and AWS Region. Only one
|
1932
|
+
# SIP application per AWS Region can be used.
|
1933
|
+
#
|
1934
|
+
# @return [Types::CreateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1935
|
+
#
|
1936
|
+
# * {Types::CreateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
1937
|
+
#
|
1938
|
+
# @example Request syntax with placeholder values
|
1939
|
+
#
|
1940
|
+
# resp = client.create_sip_rule({
|
1941
|
+
# name: "SipRuleName", # required
|
1942
|
+
# trigger_type: "ToPhoneNumber", # required, accepts ToPhoneNumber, RequestUriHostname
|
1943
|
+
# trigger_value: "NonEmptyString", # required
|
1944
|
+
# disabled: false,
|
1945
|
+
# target_applications: [ # required
|
1946
|
+
# {
|
1947
|
+
# sip_media_application_id: "NonEmptyString",
|
1948
|
+
# priority: 1,
|
1949
|
+
# aws_region: "String",
|
1950
|
+
# },
|
1951
|
+
# ],
|
1952
|
+
# })
|
1953
|
+
#
|
1954
|
+
# @example Response structure
|
1955
|
+
#
|
1956
|
+
# resp.sip_rule.sip_rule_id #=> String
|
1957
|
+
# resp.sip_rule.name #=> String
|
1958
|
+
# resp.sip_rule.disabled #=> Boolean
|
1959
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
1960
|
+
# resp.sip_rule.trigger_value #=> String
|
1961
|
+
# resp.sip_rule.target_applications #=> Array
|
1962
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
1963
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
1964
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
1965
|
+
# resp.sip_rule.created_timestamp #=> Time
|
1966
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
1967
|
+
#
|
1968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipRule AWS API Documentation
|
1969
|
+
#
|
1970
|
+
# @overload create_sip_rule(params = {})
|
1971
|
+
# @param [Hash] params ({})
|
1972
|
+
def create_sip_rule(params = {}, options = {})
|
1973
|
+
req = build_request(:create_sip_rule, params)
|
1974
|
+
req.send_request(options)
|
1975
|
+
end
|
1976
|
+
|
1977
|
+
# Creates a user under the specified Amazon Chime account.
|
1978
|
+
#
|
1979
|
+
# @option params [required, String] :account_id
|
1980
|
+
# The Amazon Chime account ID.
|
1981
|
+
#
|
1982
|
+
# @option params [String] :username
|
1983
|
+
# The user name.
|
1984
|
+
#
|
1985
|
+
# @option params [String] :email
|
1986
|
+
# The user's email address.
|
1987
|
+
#
|
1988
|
+
# @option params [String] :user_type
|
1989
|
+
# The user type.
|
1990
|
+
#
|
1991
|
+
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1992
|
+
#
|
1993
|
+
# * {Types::CreateUserResponse#user #user} => Types::User
|
1994
|
+
#
|
1995
|
+
# @example Request syntax with placeholder values
|
1996
|
+
#
|
1997
|
+
# resp = client.create_user({
|
1998
|
+
# account_id: "NonEmptyString", # required
|
1999
|
+
# username: "String",
|
2000
|
+
# email: "EmailAddress",
|
2001
|
+
# user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
|
2002
|
+
# })
|
2003
|
+
#
|
2004
|
+
# @example Response structure
|
2005
|
+
#
|
2006
|
+
# resp.user.user_id #=> String
|
1393
2007
|
# resp.user.account_id #=> String
|
1394
2008
|
# resp.user.primary_email #=> String
|
1395
2009
|
# resp.user.primary_provisioned_number #=> String
|
@@ -1427,7 +2041,7 @@ module Aws::Chime
|
|
1427
2041
|
#
|
1428
2042
|
# @option params [String] :aws_region
|
1429
2043
|
# The AWS Region in which the Amazon Chime Voice Connector is created.
|
1430
|
-
# Default value: `us-east-1
|
2044
|
+
# Default value: `us-east-1` .
|
1431
2045
|
#
|
1432
2046
|
# @option params [required, Boolean] :require_encryption
|
1433
2047
|
# When enabled, requires encryption for the Amazon Chime Voice
|
@@ -1515,15 +2129,15 @@ module Aws::Chime
|
|
1515
2129
|
end
|
1516
2130
|
|
1517
2131
|
# Deletes the specified Amazon Chime account. You must suspend all users
|
1518
|
-
# before deleting
|
1519
|
-
# action to
|
2132
|
+
# before deleting `Team` account. You can use the BatchSuspendUser
|
2133
|
+
# action to dodo.
|
1520
2134
|
#
|
1521
2135
|
# For `EnterpriseLWA` and `EnterpriseAD` accounts, you must release the
|
1522
2136
|
# claimed domains for your Amazon Chime account before deletion. As soon
|
1523
2137
|
# as you release the domain, all users under that account are suspended.
|
1524
2138
|
#
|
1525
2139
|
# Deleted accounts appear in your `Disabled` accounts list for 90 days.
|
1526
|
-
# To restore
|
2140
|
+
# To restore deleted account from your `Disabled` accounts list, you
|
1527
2141
|
# must contact AWS Support.
|
1528
2142
|
#
|
1529
2143
|
# After 90 days, deleted accounts are permanently removed from your
|
@@ -1549,11 +2163,104 @@ module Aws::Chime
|
|
1549
2163
|
req.send_request(options)
|
1550
2164
|
end
|
1551
2165
|
|
2166
|
+
# Deletes an `AppInstance` and all associated data asynchronously.
|
2167
|
+
#
|
2168
|
+
# @option params [required, String] :app_instance_arn
|
2169
|
+
# The ARN of the `AppInstance`.
|
2170
|
+
#
|
2171
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2172
|
+
#
|
2173
|
+
# @example Request syntax with placeholder values
|
2174
|
+
#
|
2175
|
+
# resp = client.delete_app_instance({
|
2176
|
+
# app_instance_arn: "ChimeArn", # required
|
2177
|
+
# })
|
2178
|
+
#
|
2179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstance AWS API Documentation
|
2180
|
+
#
|
2181
|
+
# @overload delete_app_instance(params = {})
|
2182
|
+
# @param [Hash] params ({})
|
2183
|
+
def delete_app_instance(params = {}, options = {})
|
2184
|
+
req = build_request(:delete_app_instance, params)
|
2185
|
+
req.send_request(options)
|
2186
|
+
end
|
2187
|
+
|
2188
|
+
# Demotes an `AppInstanceAdmin` to an `AppInstanceUser`. This action
|
2189
|
+
# does not delete the user.
|
2190
|
+
#
|
2191
|
+
# @option params [required, String] :app_instance_admin_arn
|
2192
|
+
# The ARN of the `AppInstance`'s administrator.
|
2193
|
+
#
|
2194
|
+
# @option params [required, String] :app_instance_arn
|
2195
|
+
# The ARN of the `AppInstance`.
|
2196
|
+
#
|
2197
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2198
|
+
#
|
2199
|
+
# @example Request syntax with placeholder values
|
2200
|
+
#
|
2201
|
+
# resp = client.delete_app_instance_admin({
|
2202
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
2203
|
+
# app_instance_arn: "ChimeArn", # required
|
2204
|
+
# })
|
2205
|
+
#
|
2206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceAdmin AWS API Documentation
|
2207
|
+
#
|
2208
|
+
# @overload delete_app_instance_admin(params = {})
|
2209
|
+
# @param [Hash] params ({})
|
2210
|
+
def delete_app_instance_admin(params = {}, options = {})
|
2211
|
+
req = build_request(:delete_app_instance_admin, params)
|
2212
|
+
req.send_request(options)
|
2213
|
+
end
|
2214
|
+
|
2215
|
+
# Deletes the streaming configurations of an `AppInstance`.
|
2216
|
+
#
|
2217
|
+
# @option params [required, String] :app_instance_arn
|
2218
|
+
# The ARN of the streaming configurations being deleted.
|
2219
|
+
#
|
2220
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2221
|
+
#
|
2222
|
+
# @example Request syntax with placeholder values
|
2223
|
+
#
|
2224
|
+
# resp = client.delete_app_instance_streaming_configurations({
|
2225
|
+
# app_instance_arn: "ChimeArn", # required
|
2226
|
+
# })
|
2227
|
+
#
|
2228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceStreamingConfigurations AWS API Documentation
|
2229
|
+
#
|
2230
|
+
# @overload delete_app_instance_streaming_configurations(params = {})
|
2231
|
+
# @param [Hash] params ({})
|
2232
|
+
def delete_app_instance_streaming_configurations(params = {}, options = {})
|
2233
|
+
req = build_request(:delete_app_instance_streaming_configurations, params)
|
2234
|
+
req.send_request(options)
|
2235
|
+
end
|
2236
|
+
|
2237
|
+
# Deletes an `AppInstanceUser`.
|
2238
|
+
#
|
2239
|
+
# @option params [required, String] :app_instance_user_arn
|
2240
|
+
# The ARN of the user request being deleted.
|
2241
|
+
#
|
2242
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2243
|
+
#
|
2244
|
+
# @example Request syntax with placeholder values
|
2245
|
+
#
|
2246
|
+
# resp = client.delete_app_instance_user({
|
2247
|
+
# app_instance_user_arn: "ChimeArn", # required
|
2248
|
+
# })
|
2249
|
+
#
|
2250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceUser AWS API Documentation
|
2251
|
+
#
|
2252
|
+
# @overload delete_app_instance_user(params = {})
|
2253
|
+
# @param [Hash] params ({})
|
2254
|
+
def delete_app_instance_user(params = {}, options = {})
|
2255
|
+
req = build_request(:delete_app_instance_user, params)
|
2256
|
+
req.send_request(options)
|
2257
|
+
end
|
2258
|
+
|
1552
2259
|
# Deletes an attendee from the specified Amazon Chime SDK meeting and
|
1553
|
-
# deletes their `JoinToken
|
2260
|
+
# deletes their `JoinToken` . Attendees are automatically deleted when a
|
1554
2261
|
# Amazon Chime SDK meeting is deleted. For more information about the
|
1555
2262
|
# Amazon Chime SDK, see [Using the Amazon Chime SDK][1] in the *Amazon
|
1556
|
-
# Chime Developer Guide
|
2263
|
+
# Chime Developer Guide* .
|
1557
2264
|
#
|
1558
2265
|
#
|
1559
2266
|
#
|
@@ -1583,6 +2290,185 @@ module Aws::Chime
|
|
1583
2290
|
req.send_request(options)
|
1584
2291
|
end
|
1585
2292
|
|
2293
|
+
# Immediately makes a channel and its memberships inaccessible and marks
|
2294
|
+
# them for deletion. This is an irreversible process.
|
2295
|
+
#
|
2296
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2297
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2298
|
+
# in the header.
|
2299
|
+
#
|
2300
|
+
# </note>
|
2301
|
+
#
|
2302
|
+
# @option params [required, String] :channel_arn
|
2303
|
+
# The ARN of the channel being deleted.
|
2304
|
+
#
|
2305
|
+
# @option params [String] :chime_bearer
|
2306
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2307
|
+
#
|
2308
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2309
|
+
#
|
2310
|
+
# @example Request syntax with placeholder values
|
2311
|
+
#
|
2312
|
+
# resp = client.delete_channel({
|
2313
|
+
# channel_arn: "ChimeArn", # required
|
2314
|
+
# chime_bearer: "ChimeArn",
|
2315
|
+
# })
|
2316
|
+
#
|
2317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannel AWS API Documentation
|
2318
|
+
#
|
2319
|
+
# @overload delete_channel(params = {})
|
2320
|
+
# @param [Hash] params ({})
|
2321
|
+
def delete_channel(params = {}, options = {})
|
2322
|
+
req = build_request(:delete_channel, params)
|
2323
|
+
req.send_request(options)
|
2324
|
+
end
|
2325
|
+
|
2326
|
+
# Removes a user from a channel's ban list.
|
2327
|
+
#
|
2328
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2329
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2330
|
+
# in the header.
|
2331
|
+
#
|
2332
|
+
# </note>
|
2333
|
+
#
|
2334
|
+
# @option params [required, String] :channel_arn
|
2335
|
+
# The ARN of the channel from which the `AppInstanceUser` was banned.
|
2336
|
+
#
|
2337
|
+
# @option params [required, String] :member_arn
|
2338
|
+
# The ARN of the `AppInstanceUser` that you want to reinstate.
|
2339
|
+
#
|
2340
|
+
# @option params [String] :chime_bearer
|
2341
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2342
|
+
#
|
2343
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2344
|
+
#
|
2345
|
+
# @example Request syntax with placeholder values
|
2346
|
+
#
|
2347
|
+
# resp = client.delete_channel_ban({
|
2348
|
+
# channel_arn: "ChimeArn", # required
|
2349
|
+
# member_arn: "ChimeArn", # required
|
2350
|
+
# chime_bearer: "ChimeArn",
|
2351
|
+
# })
|
2352
|
+
#
|
2353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelBan AWS API Documentation
|
2354
|
+
#
|
2355
|
+
# @overload delete_channel_ban(params = {})
|
2356
|
+
# @param [Hash] params ({})
|
2357
|
+
def delete_channel_ban(params = {}, options = {})
|
2358
|
+
req = build_request(:delete_channel_ban, params)
|
2359
|
+
req.send_request(options)
|
2360
|
+
end
|
2361
|
+
|
2362
|
+
# Removes a member from a channel.
|
2363
|
+
#
|
2364
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2365
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2366
|
+
# in the header.
|
2367
|
+
#
|
2368
|
+
# </note>
|
2369
|
+
#
|
2370
|
+
# @option params [required, String] :channel_arn
|
2371
|
+
# The ARN of the channel from which you want to remove the user.
|
2372
|
+
#
|
2373
|
+
# @option params [required, String] :member_arn
|
2374
|
+
# The ARN of the member that you're removing from the channel.
|
2375
|
+
#
|
2376
|
+
# @option params [String] :chime_bearer
|
2377
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2378
|
+
#
|
2379
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2380
|
+
#
|
2381
|
+
# @example Request syntax with placeholder values
|
2382
|
+
#
|
2383
|
+
# resp = client.delete_channel_membership({
|
2384
|
+
# channel_arn: "ChimeArn", # required
|
2385
|
+
# member_arn: "ChimeArn", # required
|
2386
|
+
# chime_bearer: "ChimeArn",
|
2387
|
+
# })
|
2388
|
+
#
|
2389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMembership AWS API Documentation
|
2390
|
+
#
|
2391
|
+
# @overload delete_channel_membership(params = {})
|
2392
|
+
# @param [Hash] params ({})
|
2393
|
+
def delete_channel_membership(params = {}, options = {})
|
2394
|
+
req = build_request(:delete_channel_membership, params)
|
2395
|
+
req.send_request(options)
|
2396
|
+
end
|
2397
|
+
|
2398
|
+
# Deletes a channel message. Only admins can perform this action.
|
2399
|
+
# Deletion makes messages inaccessible immediately. A background process
|
2400
|
+
# deletes any revisions created by `UpdateChannelMessage`.
|
2401
|
+
#
|
2402
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2403
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2404
|
+
# in the header.
|
2405
|
+
#
|
2406
|
+
# </note>
|
2407
|
+
#
|
2408
|
+
# @option params [required, String] :channel_arn
|
2409
|
+
# The ARN of the channel.
|
2410
|
+
#
|
2411
|
+
# @option params [required, String] :message_id
|
2412
|
+
# The ID of the message being deleted.
|
2413
|
+
#
|
2414
|
+
# @option params [String] :chime_bearer
|
2415
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2416
|
+
#
|
2417
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2418
|
+
#
|
2419
|
+
# @example Request syntax with placeholder values
|
2420
|
+
#
|
2421
|
+
# resp = client.delete_channel_message({
|
2422
|
+
# channel_arn: "ChimeArn", # required
|
2423
|
+
# message_id: "MessageId", # required
|
2424
|
+
# chime_bearer: "ChimeArn",
|
2425
|
+
# })
|
2426
|
+
#
|
2427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMessage AWS API Documentation
|
2428
|
+
#
|
2429
|
+
# @overload delete_channel_message(params = {})
|
2430
|
+
# @param [Hash] params ({})
|
2431
|
+
def delete_channel_message(params = {}, options = {})
|
2432
|
+
req = build_request(:delete_channel_message, params)
|
2433
|
+
req.send_request(options)
|
2434
|
+
end
|
2435
|
+
|
2436
|
+
# Deletes a channel moderator.
|
2437
|
+
#
|
2438
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2439
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2440
|
+
# in the header.
|
2441
|
+
#
|
2442
|
+
# </note>
|
2443
|
+
#
|
2444
|
+
# @option params [required, String] :channel_arn
|
2445
|
+
# The ARN of the channel.
|
2446
|
+
#
|
2447
|
+
# @option params [required, String] :channel_moderator_arn
|
2448
|
+
# The ARN of the moderator being deleted.
|
2449
|
+
#
|
2450
|
+
# @option params [String] :chime_bearer
|
2451
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2452
|
+
#
|
2453
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2454
|
+
#
|
2455
|
+
# @example Request syntax with placeholder values
|
2456
|
+
#
|
2457
|
+
# resp = client.delete_channel_moderator({
|
2458
|
+
# channel_arn: "ChimeArn", # required
|
2459
|
+
# channel_moderator_arn: "ChimeArn", # required
|
2460
|
+
# chime_bearer: "ChimeArn",
|
2461
|
+
# })
|
2462
|
+
#
|
2463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelModerator AWS API Documentation
|
2464
|
+
#
|
2465
|
+
# @overload delete_channel_moderator(params = {})
|
2466
|
+
# @param [Hash] params ({})
|
2467
|
+
def delete_channel_moderator(params = {}, options = {})
|
2468
|
+
req = build_request(:delete_channel_moderator, params)
|
2469
|
+
req.send_request(options)
|
2470
|
+
end
|
2471
|
+
|
1586
2472
|
# Deletes the events configuration that allows a bot to receive outgoing
|
1587
2473
|
# events.
|
1588
2474
|
#
|
@@ -1611,9 +2497,10 @@ module Aws::Chime
|
|
1611
2497
|
end
|
1612
2498
|
|
1613
2499
|
# Deletes the specified Amazon Chime SDK meeting. When a meeting is
|
1614
|
-
# deleted, its attendees are also deleted
|
1615
|
-
#
|
1616
|
-
#
|
2500
|
+
# deleted, its attendees are also deleted, clients connected to the
|
2501
|
+
# meeting are disconnected, and clients can no longer join the meeting.
|
2502
|
+
# For more information about the Amazon Chime SDK, see [Using the Amazon
|
2503
|
+
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
1617
2504
|
#
|
1618
2505
|
#
|
1619
2506
|
#
|
@@ -1639,7 +2526,7 @@ module Aws::Chime
|
|
1639
2526
|
req.send_request(options)
|
1640
2527
|
end
|
1641
2528
|
|
1642
|
-
# Moves the specified phone number into the **
|
2529
|
+
# Moves the specified phone number into the **Deletionqueue**. A phone
|
1643
2530
|
# number must be disassociated from any users or Amazon Chime Voice
|
1644
2531
|
# Connectors before it can be deleted.
|
1645
2532
|
#
|
@@ -1750,6 +2637,51 @@ module Aws::Chime
|
|
1750
2637
|
req.send_request(options)
|
1751
2638
|
end
|
1752
2639
|
|
2640
|
+
# Deletes a SIP media application.
|
2641
|
+
#
|
2642
|
+
# @option params [required, String] :sip_media_application_id
|
2643
|
+
# The SIP media application ID.
|
2644
|
+
#
|
2645
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2646
|
+
#
|
2647
|
+
# @example Request syntax with placeholder values
|
2648
|
+
#
|
2649
|
+
# resp = client.delete_sip_media_application({
|
2650
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2651
|
+
# })
|
2652
|
+
#
|
2653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipMediaApplication AWS API Documentation
|
2654
|
+
#
|
2655
|
+
# @overload delete_sip_media_application(params = {})
|
2656
|
+
# @param [Hash] params ({})
|
2657
|
+
def delete_sip_media_application(params = {}, options = {})
|
2658
|
+
req = build_request(:delete_sip_media_application, params)
|
2659
|
+
req.send_request(options)
|
2660
|
+
end
|
2661
|
+
|
2662
|
+
# Deletes a SIP rule. You must disable a SIP rule before you can delete
|
2663
|
+
# it.
|
2664
|
+
#
|
2665
|
+
# @option params [required, String] :sip_rule_id
|
2666
|
+
# The SIP rule ID.
|
2667
|
+
#
|
2668
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2669
|
+
#
|
2670
|
+
# @example Request syntax with placeholder values
|
2671
|
+
#
|
2672
|
+
# resp = client.delete_sip_rule({
|
2673
|
+
# sip_rule_id: "NonEmptyString", # required
|
2674
|
+
# })
|
2675
|
+
#
|
2676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipRule AWS API Documentation
|
2677
|
+
#
|
2678
|
+
# @overload delete_sip_rule(params = {})
|
2679
|
+
# @param [Hash] params ({})
|
2680
|
+
def delete_sip_rule(params = {}, options = {})
|
2681
|
+
req = build_request(:delete_sip_rule, params)
|
2682
|
+
req.send_request(options)
|
2683
|
+
end
|
2684
|
+
|
1753
2685
|
# Deletes the specified Amazon Chime Voice Connector. Any phone numbers
|
1754
2686
|
# associated with the Amazon Chime Voice Connector must be disassociated
|
1755
2687
|
# from it before it can be deleted.
|
@@ -1953,20 +2885,408 @@ module Aws::Chime
|
|
1953
2885
|
req.send_request(options)
|
1954
2886
|
end
|
1955
2887
|
|
1956
|
-
#
|
1957
|
-
# Amazon Chime user.
|
2888
|
+
# Returns the full details of an `AppInstance`.
|
1958
2889
|
#
|
1959
|
-
# @option params [required, String] :
|
1960
|
-
# The
|
2890
|
+
# @option params [required, String] :app_instance_arn
|
2891
|
+
# The ARN of the `AppInstance`.
|
1961
2892
|
#
|
1962
|
-
# @
|
1963
|
-
# The user ID.
|
2893
|
+
# @return [Types::DescribeAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1964
2894
|
#
|
1965
|
-
#
|
2895
|
+
# * {Types::DescribeAppInstanceResponse#app_instance #app_instance} => Types::AppInstance
|
1966
2896
|
#
|
1967
2897
|
# @example Request syntax with placeholder values
|
1968
2898
|
#
|
1969
|
-
# resp = client.
|
2899
|
+
# resp = client.describe_app_instance({
|
2900
|
+
# app_instance_arn: "ChimeArn", # required
|
2901
|
+
# })
|
2902
|
+
#
|
2903
|
+
# @example Response structure
|
2904
|
+
#
|
2905
|
+
# resp.app_instance.app_instance_arn #=> String
|
2906
|
+
# resp.app_instance.name #=> String
|
2907
|
+
# resp.app_instance.metadata #=> String
|
2908
|
+
# resp.app_instance.created_timestamp #=> Time
|
2909
|
+
# resp.app_instance.last_updated_timestamp #=> Time
|
2910
|
+
#
|
2911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstance AWS API Documentation
|
2912
|
+
#
|
2913
|
+
# @overload describe_app_instance(params = {})
|
2914
|
+
# @param [Hash] params ({})
|
2915
|
+
def describe_app_instance(params = {}, options = {})
|
2916
|
+
req = build_request(:describe_app_instance, params)
|
2917
|
+
req.send_request(options)
|
2918
|
+
end
|
2919
|
+
|
2920
|
+
# Returns the full details of an `AppInstanceAdmin`.
|
2921
|
+
#
|
2922
|
+
# @option params [required, String] :app_instance_admin_arn
|
2923
|
+
# The ARN of the `AppInstanceAdmin`.
|
2924
|
+
#
|
2925
|
+
# @option params [required, String] :app_instance_arn
|
2926
|
+
# The ARN of the `AppInstance`.
|
2927
|
+
#
|
2928
|
+
# @return [Types::DescribeAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2929
|
+
#
|
2930
|
+
# * {Types::DescribeAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::AppInstanceAdmin
|
2931
|
+
#
|
2932
|
+
# @example Request syntax with placeholder values
|
2933
|
+
#
|
2934
|
+
# resp = client.describe_app_instance_admin({
|
2935
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
2936
|
+
# app_instance_arn: "ChimeArn", # required
|
2937
|
+
# })
|
2938
|
+
#
|
2939
|
+
# @example Response structure
|
2940
|
+
#
|
2941
|
+
# resp.app_instance_admin.admin.arn #=> String
|
2942
|
+
# resp.app_instance_admin.admin.name #=> String
|
2943
|
+
# resp.app_instance_admin.app_instance_arn #=> String
|
2944
|
+
# resp.app_instance_admin.created_timestamp #=> Time
|
2945
|
+
#
|
2946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstanceAdmin AWS API Documentation
|
2947
|
+
#
|
2948
|
+
# @overload describe_app_instance_admin(params = {})
|
2949
|
+
# @param [Hash] params ({})
|
2950
|
+
def describe_app_instance_admin(params = {}, options = {})
|
2951
|
+
req = build_request(:describe_app_instance_admin, params)
|
2952
|
+
req.send_request(options)
|
2953
|
+
end
|
2954
|
+
|
2955
|
+
# Returns the full details of an `AppInstanceUser` .
|
2956
|
+
#
|
2957
|
+
# @option params [required, String] :app_instance_user_arn
|
2958
|
+
# The ARN of the `AppInstanceUser`.
|
2959
|
+
#
|
2960
|
+
# @return [Types::DescribeAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2961
|
+
#
|
2962
|
+
# * {Types::DescribeAppInstanceUserResponse#app_instance_user #app_instance_user} => Types::AppInstanceUser
|
2963
|
+
#
|
2964
|
+
# @example Request syntax with placeholder values
|
2965
|
+
#
|
2966
|
+
# resp = client.describe_app_instance_user({
|
2967
|
+
# app_instance_user_arn: "ChimeArn", # required
|
2968
|
+
# })
|
2969
|
+
#
|
2970
|
+
# @example Response structure
|
2971
|
+
#
|
2972
|
+
# resp.app_instance_user.app_instance_user_arn #=> String
|
2973
|
+
# resp.app_instance_user.name #=> String
|
2974
|
+
# resp.app_instance_user.created_timestamp #=> Time
|
2975
|
+
# resp.app_instance_user.metadata #=> String
|
2976
|
+
# resp.app_instance_user.last_updated_timestamp #=> Time
|
2977
|
+
#
|
2978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstanceUser AWS API Documentation
|
2979
|
+
#
|
2980
|
+
# @overload describe_app_instance_user(params = {})
|
2981
|
+
# @param [Hash] params ({})
|
2982
|
+
def describe_app_instance_user(params = {}, options = {})
|
2983
|
+
req = build_request(:describe_app_instance_user, params)
|
2984
|
+
req.send_request(options)
|
2985
|
+
end
|
2986
|
+
|
2987
|
+
# Returns the full details of a channel in an Amazon Chime
|
2988
|
+
# `AppInstance`.
|
2989
|
+
#
|
2990
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2991
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2992
|
+
# in the header.
|
2993
|
+
#
|
2994
|
+
# </note>
|
2995
|
+
#
|
2996
|
+
# @option params [required, String] :channel_arn
|
2997
|
+
# The ARN of the channel.
|
2998
|
+
#
|
2999
|
+
# @option params [String] :chime_bearer
|
3000
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3001
|
+
#
|
3002
|
+
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3003
|
+
#
|
3004
|
+
# * {Types::DescribeChannelResponse#channel #channel} => Types::Channel
|
3005
|
+
#
|
3006
|
+
# @example Request syntax with placeholder values
|
3007
|
+
#
|
3008
|
+
# resp = client.describe_channel({
|
3009
|
+
# channel_arn: "ChimeArn", # required
|
3010
|
+
# chime_bearer: "ChimeArn",
|
3011
|
+
# })
|
3012
|
+
#
|
3013
|
+
# @example Response structure
|
3014
|
+
#
|
3015
|
+
# resp.channel.name #=> String
|
3016
|
+
# resp.channel.channel_arn #=> String
|
3017
|
+
# resp.channel.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
3018
|
+
# resp.channel.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
3019
|
+
# resp.channel.metadata #=> String
|
3020
|
+
# resp.channel.created_by.arn #=> String
|
3021
|
+
# resp.channel.created_by.name #=> String
|
3022
|
+
# resp.channel.created_timestamp #=> Time
|
3023
|
+
# resp.channel.last_message_timestamp #=> Time
|
3024
|
+
# resp.channel.last_updated_timestamp #=> Time
|
3025
|
+
#
|
3026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannel AWS API Documentation
|
3027
|
+
#
|
3028
|
+
# @overload describe_channel(params = {})
|
3029
|
+
# @param [Hash] params ({})
|
3030
|
+
def describe_channel(params = {}, options = {})
|
3031
|
+
req = build_request(:describe_channel, params)
|
3032
|
+
req.send_request(options)
|
3033
|
+
end
|
3034
|
+
|
3035
|
+
# Returns the full details of a channel ban.
|
3036
|
+
#
|
3037
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3038
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3039
|
+
# in the header.
|
3040
|
+
#
|
3041
|
+
# </note>
|
3042
|
+
#
|
3043
|
+
# @option params [required, String] :channel_arn
|
3044
|
+
# The ARN of the channel from which the user is banned.
|
3045
|
+
#
|
3046
|
+
# @option params [required, String] :member_arn
|
3047
|
+
# The ARN of the member being banned.
|
3048
|
+
#
|
3049
|
+
# @option params [String] :chime_bearer
|
3050
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3051
|
+
#
|
3052
|
+
# @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3053
|
+
#
|
3054
|
+
# * {Types::DescribeChannelBanResponse#channel_ban #channel_ban} => Types::ChannelBan
|
3055
|
+
#
|
3056
|
+
# @example Request syntax with placeholder values
|
3057
|
+
#
|
3058
|
+
# resp = client.describe_channel_ban({
|
3059
|
+
# channel_arn: "ChimeArn", # required
|
3060
|
+
# member_arn: "ChimeArn", # required
|
3061
|
+
# chime_bearer: "ChimeArn",
|
3062
|
+
# })
|
3063
|
+
#
|
3064
|
+
# @example Response structure
|
3065
|
+
#
|
3066
|
+
# resp.channel_ban.member.arn #=> String
|
3067
|
+
# resp.channel_ban.member.name #=> String
|
3068
|
+
# resp.channel_ban.channel_arn #=> String
|
3069
|
+
# resp.channel_ban.created_timestamp #=> Time
|
3070
|
+
# resp.channel_ban.created_by.arn #=> String
|
3071
|
+
# resp.channel_ban.created_by.name #=> String
|
3072
|
+
#
|
3073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelBan AWS API Documentation
|
3074
|
+
#
|
3075
|
+
# @overload describe_channel_ban(params = {})
|
3076
|
+
# @param [Hash] params ({})
|
3077
|
+
def describe_channel_ban(params = {}, options = {})
|
3078
|
+
req = build_request(:describe_channel_ban, params)
|
3079
|
+
req.send_request(options)
|
3080
|
+
end
|
3081
|
+
|
3082
|
+
# Returns the full details of a user's channel membership.
|
3083
|
+
#
|
3084
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3085
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3086
|
+
# in the header.
|
3087
|
+
#
|
3088
|
+
# </note>
|
3089
|
+
#
|
3090
|
+
# @option params [required, String] :channel_arn
|
3091
|
+
# The ARN of the channel.
|
3092
|
+
#
|
3093
|
+
# @option params [required, String] :member_arn
|
3094
|
+
# The ARN of the member.
|
3095
|
+
#
|
3096
|
+
# @option params [String] :chime_bearer
|
3097
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3098
|
+
#
|
3099
|
+
# @return [Types::DescribeChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3100
|
+
#
|
3101
|
+
# * {Types::DescribeChannelMembershipResponse#channel_membership #channel_membership} => Types::ChannelMembership
|
3102
|
+
#
|
3103
|
+
# @example Request syntax with placeholder values
|
3104
|
+
#
|
3105
|
+
# resp = client.describe_channel_membership({
|
3106
|
+
# channel_arn: "ChimeArn", # required
|
3107
|
+
# member_arn: "ChimeArn", # required
|
3108
|
+
# chime_bearer: "ChimeArn",
|
3109
|
+
# })
|
3110
|
+
#
|
3111
|
+
# @example Response structure
|
3112
|
+
#
|
3113
|
+
# resp.channel_membership.invited_by.arn #=> String
|
3114
|
+
# resp.channel_membership.invited_by.name #=> String
|
3115
|
+
# resp.channel_membership.type #=> String, one of "DEFAULT", "HIDDEN"
|
3116
|
+
# resp.channel_membership.member.arn #=> String
|
3117
|
+
# resp.channel_membership.member.name #=> String
|
3118
|
+
# resp.channel_membership.channel_arn #=> String
|
3119
|
+
# resp.channel_membership.created_timestamp #=> Time
|
3120
|
+
# resp.channel_membership.last_updated_timestamp #=> Time
|
3121
|
+
#
|
3122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelMembership AWS API Documentation
|
3123
|
+
#
|
3124
|
+
# @overload describe_channel_membership(params = {})
|
3125
|
+
# @param [Hash] params ({})
|
3126
|
+
def describe_channel_membership(params = {}, options = {})
|
3127
|
+
req = build_request(:describe_channel_membership, params)
|
3128
|
+
req.send_request(options)
|
3129
|
+
end
|
3130
|
+
|
3131
|
+
# Returns the details of a channel based on the membership of the
|
3132
|
+
# specified `AppInstanceUser`.
|
3133
|
+
#
|
3134
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3135
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3136
|
+
# in the header.
|
3137
|
+
#
|
3138
|
+
# </note>
|
3139
|
+
#
|
3140
|
+
# @option params [required, String] :channel_arn
|
3141
|
+
# The ARN of the channel to which the user belongs.
|
3142
|
+
#
|
3143
|
+
# @option params [required, String] :app_instance_user_arn
|
3144
|
+
# The ARN of the user in a channel.
|
3145
|
+
#
|
3146
|
+
# @option params [String] :chime_bearer
|
3147
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3148
|
+
#
|
3149
|
+
# @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3150
|
+
#
|
3151
|
+
# * {Types::DescribeChannelMembershipForAppInstanceUserResponse#channel_membership #channel_membership} => Types::ChannelMembershipForAppInstanceUserSummary
|
3152
|
+
#
|
3153
|
+
# @example Request syntax with placeholder values
|
3154
|
+
#
|
3155
|
+
# resp = client.describe_channel_membership_for_app_instance_user({
|
3156
|
+
# channel_arn: "ChimeArn", # required
|
3157
|
+
# app_instance_user_arn: "ChimeArn", # required
|
3158
|
+
# chime_bearer: "ChimeArn",
|
3159
|
+
# })
|
3160
|
+
#
|
3161
|
+
# @example Response structure
|
3162
|
+
#
|
3163
|
+
# resp.channel_membership.channel_summary.name #=> String
|
3164
|
+
# resp.channel_membership.channel_summary.channel_arn #=> String
|
3165
|
+
# resp.channel_membership.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
3166
|
+
# resp.channel_membership.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
3167
|
+
# resp.channel_membership.channel_summary.metadata #=> String
|
3168
|
+
# resp.channel_membership.channel_summary.last_message_timestamp #=> Time
|
3169
|
+
# resp.channel_membership.app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
3170
|
+
# resp.channel_membership.app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
3171
|
+
#
|
3172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelMembershipForAppInstanceUser AWS API Documentation
|
3173
|
+
#
|
3174
|
+
# @overload describe_channel_membership_for_app_instance_user(params = {})
|
3175
|
+
# @param [Hash] params ({})
|
3176
|
+
def describe_channel_membership_for_app_instance_user(params = {}, options = {})
|
3177
|
+
req = build_request(:describe_channel_membership_for_app_instance_user, params)
|
3178
|
+
req.send_request(options)
|
3179
|
+
end
|
3180
|
+
|
3181
|
+
# Returns the full details of a channel moderated by the specified
|
3182
|
+
# `AppInstanceUser`.
|
3183
|
+
#
|
3184
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3185
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3186
|
+
# in the header.
|
3187
|
+
#
|
3188
|
+
# </note>
|
3189
|
+
#
|
3190
|
+
# @option params [required, String] :channel_arn
|
3191
|
+
# The ARN of the moderated channel.
|
3192
|
+
#
|
3193
|
+
# @option params [required, String] :app_instance_user_arn
|
3194
|
+
# The ARN of the `AppInstanceUser` in the moderated channel.
|
3195
|
+
#
|
3196
|
+
# @option params [String] :chime_bearer
|
3197
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3198
|
+
#
|
3199
|
+
# @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3200
|
+
#
|
3201
|
+
# * {Types::DescribeChannelModeratedByAppInstanceUserResponse#channel #channel} => Types::ChannelModeratedByAppInstanceUserSummary
|
3202
|
+
#
|
3203
|
+
# @example Request syntax with placeholder values
|
3204
|
+
#
|
3205
|
+
# resp = client.describe_channel_moderated_by_app_instance_user({
|
3206
|
+
# channel_arn: "ChimeArn", # required
|
3207
|
+
# app_instance_user_arn: "ChimeArn", # required
|
3208
|
+
# chime_bearer: "ChimeArn",
|
3209
|
+
# })
|
3210
|
+
#
|
3211
|
+
# @example Response structure
|
3212
|
+
#
|
3213
|
+
# resp.channel.channel_summary.name #=> String
|
3214
|
+
# resp.channel.channel_summary.channel_arn #=> String
|
3215
|
+
# resp.channel.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
3216
|
+
# resp.channel.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
3217
|
+
# resp.channel.channel_summary.metadata #=> String
|
3218
|
+
# resp.channel.channel_summary.last_message_timestamp #=> Time
|
3219
|
+
#
|
3220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelModeratedByAppInstanceUser AWS API Documentation
|
3221
|
+
#
|
3222
|
+
# @overload describe_channel_moderated_by_app_instance_user(params = {})
|
3223
|
+
# @param [Hash] params ({})
|
3224
|
+
def describe_channel_moderated_by_app_instance_user(params = {}, options = {})
|
3225
|
+
req = build_request(:describe_channel_moderated_by_app_instance_user, params)
|
3226
|
+
req.send_request(options)
|
3227
|
+
end
|
3228
|
+
|
3229
|
+
# Returns the full details of a single ChannelModerator.
|
3230
|
+
#
|
3231
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3232
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3233
|
+
# in the header.
|
3234
|
+
#
|
3235
|
+
# </note>
|
3236
|
+
#
|
3237
|
+
# @option params [required, String] :channel_arn
|
3238
|
+
# The ARN of the channel.
|
3239
|
+
#
|
3240
|
+
# @option params [required, String] :channel_moderator_arn
|
3241
|
+
# The ARN of the channel moderator.
|
3242
|
+
#
|
3243
|
+
# @option params [String] :chime_bearer
|
3244
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3245
|
+
#
|
3246
|
+
# @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3247
|
+
#
|
3248
|
+
# * {Types::DescribeChannelModeratorResponse#channel_moderator #channel_moderator} => Types::ChannelModerator
|
3249
|
+
#
|
3250
|
+
# @example Request syntax with placeholder values
|
3251
|
+
#
|
3252
|
+
# resp = client.describe_channel_moderator({
|
3253
|
+
# channel_arn: "ChimeArn", # required
|
3254
|
+
# channel_moderator_arn: "ChimeArn", # required
|
3255
|
+
# chime_bearer: "ChimeArn",
|
3256
|
+
# })
|
3257
|
+
#
|
3258
|
+
# @example Response structure
|
3259
|
+
#
|
3260
|
+
# resp.channel_moderator.moderator.arn #=> String
|
3261
|
+
# resp.channel_moderator.moderator.name #=> String
|
3262
|
+
# resp.channel_moderator.channel_arn #=> String
|
3263
|
+
# resp.channel_moderator.created_timestamp #=> Time
|
3264
|
+
# resp.channel_moderator.created_by.arn #=> String
|
3265
|
+
# resp.channel_moderator.created_by.name #=> String
|
3266
|
+
#
|
3267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelModerator AWS API Documentation
|
3268
|
+
#
|
3269
|
+
# @overload describe_channel_moderator(params = {})
|
3270
|
+
# @param [Hash] params ({})
|
3271
|
+
def describe_channel_moderator(params = {}, options = {})
|
3272
|
+
req = build_request(:describe_channel_moderator, params)
|
3273
|
+
req.send_request(options)
|
3274
|
+
end
|
3275
|
+
|
3276
|
+
# Disassociates the primary provisioned phone number from the specified
|
3277
|
+
# Amazon Chime user.
|
3278
|
+
#
|
3279
|
+
# @option params [required, String] :account_id
|
3280
|
+
# The Amazon Chime account ID.
|
3281
|
+
#
|
3282
|
+
# @option params [required, String] :user_id
|
3283
|
+
# The user ID.
|
3284
|
+
#
|
3285
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3286
|
+
#
|
3287
|
+
# @example Request syntax with placeholder values
|
3288
|
+
#
|
3289
|
+
# resp = client.disassociate_phone_number_from_user({
|
1970
3290
|
# account_id: "String", # required
|
1971
3291
|
# user_id: "String", # required
|
1972
3292
|
# })
|
@@ -2118,7 +3438,7 @@ module Aws::Chime
|
|
2118
3438
|
end
|
2119
3439
|
|
2120
3440
|
# Retrieves account settings for the specified Amazon Chime account ID,
|
2121
|
-
# such as remote control and
|
3441
|
+
# such as remote control and dialout settings. For more information
|
2122
3442
|
# about these settings, see [Use the Policies Page][1] in the *Amazon
|
2123
3443
|
# Chime Administration Guide*.
|
2124
3444
|
#
|
@@ -2153,9 +3473,70 @@ module Aws::Chime
|
|
2153
3473
|
req.send_request(options)
|
2154
3474
|
end
|
2155
3475
|
|
3476
|
+
# Gets the retention settings for an `AppInstance`.
|
3477
|
+
#
|
3478
|
+
# @option params [required, String] :app_instance_arn
|
3479
|
+
# The ARN of the `AppInstance`.
|
3480
|
+
#
|
3481
|
+
# @return [Types::GetAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3482
|
+
#
|
3483
|
+
# * {Types::GetAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
|
3484
|
+
# * {Types::GetAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
|
3485
|
+
#
|
3486
|
+
# @example Request syntax with placeholder values
|
3487
|
+
#
|
3488
|
+
# resp = client.get_app_instance_retention_settings({
|
3489
|
+
# app_instance_arn: "ChimeArn", # required
|
3490
|
+
# })
|
3491
|
+
#
|
3492
|
+
# @example Response structure
|
3493
|
+
#
|
3494
|
+
# resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
|
3495
|
+
# resp.initiate_deletion_timestamp #=> Time
|
3496
|
+
#
|
3497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAppInstanceRetentionSettings AWS API Documentation
|
3498
|
+
#
|
3499
|
+
# @overload get_app_instance_retention_settings(params = {})
|
3500
|
+
# @param [Hash] params ({})
|
3501
|
+
def get_app_instance_retention_settings(params = {}, options = {})
|
3502
|
+
req = build_request(:get_app_instance_retention_settings, params)
|
3503
|
+
req.send_request(options)
|
3504
|
+
end
|
3505
|
+
|
3506
|
+
# Gets the streaming settings for an `AppInstance`.
|
3507
|
+
#
|
3508
|
+
# @option params [required, String] :app_instance_arn
|
3509
|
+
# The ARN of the `AppInstance`.
|
3510
|
+
#
|
3511
|
+
# @return [Types::GetAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3512
|
+
#
|
3513
|
+
# * {Types::GetAppInstanceStreamingConfigurationsResponse#app_instance_streaming_configurations #app_instance_streaming_configurations} => Array<Types::AppInstanceStreamingConfiguration>
|
3514
|
+
#
|
3515
|
+
# @example Request syntax with placeholder values
|
3516
|
+
#
|
3517
|
+
# resp = client.get_app_instance_streaming_configurations({
|
3518
|
+
# app_instance_arn: "ChimeArn", # required
|
3519
|
+
# })
|
3520
|
+
#
|
3521
|
+
# @example Response structure
|
3522
|
+
#
|
3523
|
+
# resp.app_instance_streaming_configurations #=> Array
|
3524
|
+
# resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
|
3525
|
+
# resp.app_instance_streaming_configurations[0].resource_arn #=> String
|
3526
|
+
#
|
3527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAppInstanceStreamingConfigurations AWS API Documentation
|
3528
|
+
#
|
3529
|
+
# @overload get_app_instance_streaming_configurations(params = {})
|
3530
|
+
# @param [Hash] params ({})
|
3531
|
+
def get_app_instance_streaming_configurations(params = {}, options = {})
|
3532
|
+
req = build_request(:get_app_instance_streaming_configurations, params)
|
3533
|
+
req.send_request(options)
|
3534
|
+
end
|
3535
|
+
|
2156
3536
|
# Gets the Amazon Chime SDK attendee details for a specified meeting ID
|
2157
3537
|
# and attendee ID. For more information about the Amazon Chime SDK, see
|
2158
|
-
# [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer Guide
|
3538
|
+
# [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*
|
3539
|
+
# .
|
2159
3540
|
#
|
2160
3541
|
#
|
2161
3542
|
#
|
@@ -2234,6 +3615,59 @@ module Aws::Chime
|
|
2234
3615
|
req.send_request(options)
|
2235
3616
|
end
|
2236
3617
|
|
3618
|
+
# Gets the full details of a channel message.
|
3619
|
+
#
|
3620
|
+
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
|
3621
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3622
|
+
# in the header.
|
3623
|
+
#
|
3624
|
+
# </note>
|
3625
|
+
#
|
3626
|
+
# @option params [required, String] :channel_arn
|
3627
|
+
# The ARN of the channel.
|
3628
|
+
#
|
3629
|
+
# @option params [required, String] :message_id
|
3630
|
+
# The ID of the message.
|
3631
|
+
#
|
3632
|
+
# @option params [String] :chime_bearer
|
3633
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3634
|
+
#
|
3635
|
+
# @return [Types::GetChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3636
|
+
#
|
3637
|
+
# * {Types::GetChannelMessageResponse#channel_message #channel_message} => Types::ChannelMessage
|
3638
|
+
#
|
3639
|
+
# @example Request syntax with placeholder values
|
3640
|
+
#
|
3641
|
+
# resp = client.get_channel_message({
|
3642
|
+
# channel_arn: "ChimeArn", # required
|
3643
|
+
# message_id: "MessageId", # required
|
3644
|
+
# chime_bearer: "ChimeArn",
|
3645
|
+
# })
|
3646
|
+
#
|
3647
|
+
# @example Response structure
|
3648
|
+
#
|
3649
|
+
# resp.channel_message.channel_arn #=> String
|
3650
|
+
# resp.channel_message.message_id #=> String
|
3651
|
+
# resp.channel_message.content #=> String
|
3652
|
+
# resp.channel_message.metadata #=> String
|
3653
|
+
# resp.channel_message.type #=> String, one of "STANDARD", "CONTROL"
|
3654
|
+
# resp.channel_message.created_timestamp #=> Time
|
3655
|
+
# resp.channel_message.last_edited_timestamp #=> Time
|
3656
|
+
# resp.channel_message.last_updated_timestamp #=> Time
|
3657
|
+
# resp.channel_message.sender.arn #=> String
|
3658
|
+
# resp.channel_message.sender.name #=> String
|
3659
|
+
# resp.channel_message.redacted #=> Boolean
|
3660
|
+
# resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"
|
3661
|
+
#
|
3662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetChannelMessage AWS API Documentation
|
3663
|
+
#
|
3664
|
+
# @overload get_channel_message(params = {})
|
3665
|
+
# @param [Hash] params ({})
|
3666
|
+
def get_channel_message(params = {}, options = {})
|
3667
|
+
req = build_request(:get_channel_message, params)
|
3668
|
+
req.send_request(options)
|
3669
|
+
end
|
3670
|
+
|
2237
3671
|
# Gets details for an events configuration that allows a bot to receive
|
2238
3672
|
# outgoing events, such as an HTTPS endpoint or Lambda function ARN.
|
2239
3673
|
#
|
@@ -2294,7 +3728,7 @@ module Aws::Chime
|
|
2294
3728
|
|
2295
3729
|
# Gets the Amazon Chime SDK meeting details for the specified meeting
|
2296
3730
|
# ID. For more information about the Amazon Chime SDK, see [Using the
|
2297
|
-
# Amazon Chime SDK][1] in the *Amazon Chime Developer Guide
|
3731
|
+
# Amazon Chime SDK][1] in the *Amazon Chime Developer Guide* .
|
2298
3732
|
#
|
2299
3733
|
#
|
2300
3734
|
#
|
@@ -2335,6 +3769,25 @@ module Aws::Chime
|
|
2335
3769
|
req.send_request(options)
|
2336
3770
|
end
|
2337
3771
|
|
3772
|
+
# The details of the endpoint for the messaging session.
|
3773
|
+
#
|
3774
|
+
# @return [Types::GetMessagingSessionEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3775
|
+
#
|
3776
|
+
# * {Types::GetMessagingSessionEndpointResponse#endpoint #endpoint} => Types::MessagingSessionEndpoint
|
3777
|
+
#
|
3778
|
+
# @example Response structure
|
3779
|
+
#
|
3780
|
+
# resp.endpoint.url #=> String
|
3781
|
+
#
|
3782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetMessagingSessionEndpoint AWS API Documentation
|
3783
|
+
#
|
3784
|
+
# @overload get_messaging_session_endpoint(params = {})
|
3785
|
+
# @param [Hash] params ({})
|
3786
|
+
def get_messaging_session_endpoint(params = {}, options = {})
|
3787
|
+
req = build_request(:get_messaging_session_endpoint, params)
|
3788
|
+
req.send_request(options)
|
3789
|
+
end
|
3790
|
+
|
2338
3791
|
# Retrieves details for the specified phone number ID, such as
|
2339
3792
|
# associations, capabilities, and product type.
|
2340
3793
|
#
|
@@ -2366,7 +3819,7 @@ module Aws::Chime
|
|
2366
3819
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
2367
3820
|
# resp.phone_number.associations #=> Array
|
2368
3821
|
# resp.phone_number.associations[0].value #=> String
|
2369
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
3822
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
2370
3823
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
2371
3824
|
# resp.phone_number.calling_name #=> String
|
2372
3825
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -2383,9 +3836,9 @@ module Aws::Chime
|
|
2383
3836
|
req.send_request(options)
|
2384
3837
|
end
|
2385
3838
|
|
2386
|
-
# Retrieves details for the specified phone number order, such as
|
2387
|
-
# creation timestamp, phone numbers in E.164 format, product type,
|
2388
|
-
# order status.
|
3839
|
+
# Retrieves details for the specified phone number order, such as the
|
3840
|
+
# order creation timestamp, phone numbers in E.164 format, product type,
|
3841
|
+
# and order status.
|
2389
3842
|
#
|
2390
3843
|
# @option params [required, String] :phone_number_order_id
|
2391
3844
|
# The ID for the phone number order.
|
@@ -2493,8 +3946,8 @@ module Aws::Chime
|
|
2493
3946
|
|
2494
3947
|
# Gets the retention settings for the specified Amazon Chime Enterprise
|
2495
3948
|
# account. For more information about retention settings, see [Managing
|
2496
|
-
# Chat Retention Policies][1] in the *Amazon Chime Administration
|
2497
|
-
#
|
3949
|
+
# Chat Retention Policies][1] in the *Amazon Chime Administration Guide*
|
3950
|
+
# .
|
2498
3951
|
#
|
2499
3952
|
#
|
2500
3953
|
#
|
@@ -2567,21 +4020,124 @@ module Aws::Chime
|
|
2567
4020
|
req.send_request(options)
|
2568
4021
|
end
|
2569
4022
|
|
2570
|
-
# Retrieves
|
2571
|
-
#
|
4023
|
+
# Retrieves the information for a SIP media application, including name,
|
4024
|
+
# AWS Region, and endpoints.
|
2572
4025
|
#
|
2573
|
-
#
|
2574
|
-
#
|
4026
|
+
# @option params [required, String] :sip_media_application_id
|
4027
|
+
# The SIP media application ID.
|
2575
4028
|
#
|
2576
|
-
# @
|
2577
|
-
# The Amazon Chime account ID.
|
4029
|
+
# @return [Types::GetSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2578
4030
|
#
|
2579
|
-
#
|
2580
|
-
# The user ID.
|
4031
|
+
# * {Types::GetSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
2581
4032
|
#
|
2582
|
-
# @
|
4033
|
+
# @example Request syntax with placeholder values
|
2583
4034
|
#
|
2584
|
-
#
|
4035
|
+
# resp = client.get_sip_media_application({
|
4036
|
+
# sip_media_application_id: "NonEmptyString", # required
|
4037
|
+
# })
|
4038
|
+
#
|
4039
|
+
# @example Response structure
|
4040
|
+
#
|
4041
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
4042
|
+
# resp.sip_media_application.aws_region #=> String
|
4043
|
+
# resp.sip_media_application.name #=> String
|
4044
|
+
# resp.sip_media_application.endpoints #=> Array
|
4045
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
4046
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
4047
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
4048
|
+
#
|
4049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplication AWS API Documentation
|
4050
|
+
#
|
4051
|
+
# @overload get_sip_media_application(params = {})
|
4052
|
+
# @param [Hash] params ({})
|
4053
|
+
def get_sip_media_application(params = {}, options = {})
|
4054
|
+
req = build_request(:get_sip_media_application, params)
|
4055
|
+
req.send_request(options)
|
4056
|
+
end
|
4057
|
+
|
4058
|
+
# Returns the logging configuration for the specified SIP media
|
4059
|
+
# application.
|
4060
|
+
#
|
4061
|
+
# @option params [required, String] :sip_media_application_id
|
4062
|
+
# The SIP media application ID.
|
4063
|
+
#
|
4064
|
+
# @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4065
|
+
#
|
4066
|
+
# * {Types::GetSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
4067
|
+
#
|
4068
|
+
# @example Request syntax with placeholder values
|
4069
|
+
#
|
4070
|
+
# resp = client.get_sip_media_application_logging_configuration({
|
4071
|
+
# sip_media_application_id: "NonEmptyString", # required
|
4072
|
+
# })
|
4073
|
+
#
|
4074
|
+
# @example Response structure
|
4075
|
+
#
|
4076
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
4077
|
+
#
|
4078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplicationLoggingConfiguration AWS API Documentation
|
4079
|
+
#
|
4080
|
+
# @overload get_sip_media_application_logging_configuration(params = {})
|
4081
|
+
# @param [Hash] params ({})
|
4082
|
+
def get_sip_media_application_logging_configuration(params = {}, options = {})
|
4083
|
+
req = build_request(:get_sip_media_application_logging_configuration, params)
|
4084
|
+
req.send_request(options)
|
4085
|
+
end
|
4086
|
+
|
4087
|
+
# Retrieves the details of a SIP rule, such as the rule ID, name,
|
4088
|
+
# triggers, and target endpoints.
|
4089
|
+
#
|
4090
|
+
# @option params [required, String] :sip_rule_id
|
4091
|
+
# The SIP rule ID.
|
4092
|
+
#
|
4093
|
+
# @return [Types::GetSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4094
|
+
#
|
4095
|
+
# * {Types::GetSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
4096
|
+
#
|
4097
|
+
# @example Request syntax with placeholder values
|
4098
|
+
#
|
4099
|
+
# resp = client.get_sip_rule({
|
4100
|
+
# sip_rule_id: "NonEmptyString", # required
|
4101
|
+
# })
|
4102
|
+
#
|
4103
|
+
# @example Response structure
|
4104
|
+
#
|
4105
|
+
# resp.sip_rule.sip_rule_id #=> String
|
4106
|
+
# resp.sip_rule.name #=> String
|
4107
|
+
# resp.sip_rule.disabled #=> Boolean
|
4108
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
4109
|
+
# resp.sip_rule.trigger_value #=> String
|
4110
|
+
# resp.sip_rule.target_applications #=> Array
|
4111
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
4112
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
4113
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
4114
|
+
# resp.sip_rule.created_timestamp #=> Time
|
4115
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
4116
|
+
#
|
4117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipRule AWS API Documentation
|
4118
|
+
#
|
4119
|
+
# @overload get_sip_rule(params = {})
|
4120
|
+
# @param [Hash] params ({})
|
4121
|
+
def get_sip_rule(params = {}, options = {})
|
4122
|
+
req = build_request(:get_sip_rule, params)
|
4123
|
+
req.send_request(options)
|
4124
|
+
end
|
4125
|
+
|
4126
|
+
# Retrieves details for the specified user ID, such as primary email
|
4127
|
+
# address, license type,and personal meeting PIN.
|
4128
|
+
#
|
4129
|
+
# To retrieve user details with an email address instead of a user ID,
|
4130
|
+
# use the ListUsers action, and then filter by email address.
|
4131
|
+
#
|
4132
|
+
# @option params [required, String] :account_id
|
4133
|
+
# The Amazon Chime account ID.
|
4134
|
+
#
|
4135
|
+
# @option params [required, String] :user_id
|
4136
|
+
# The user ID.
|
4137
|
+
#
|
4138
|
+
# @return [Types::GetUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4139
|
+
#
|
4140
|
+
# * {Types::GetUserResponse#user #user} => Types::User
|
2585
4141
|
#
|
2586
4142
|
# @example Request syntax with placeholder values
|
2587
4143
|
#
|
@@ -2652,7 +4208,7 @@ module Aws::Chime
|
|
2652
4208
|
end
|
2653
4209
|
|
2654
4210
|
# Retrieves details for the specified Amazon Chime Voice Connector, such
|
2655
|
-
# as timestamps,
|
4211
|
+
# as timestamps,name, outbound host, and encryption requirements.
|
2656
4212
|
#
|
2657
4213
|
# @option params [required, String] :voice_connector_id
|
2658
4214
|
# The Amazon Chime Voice Connector ID.
|
@@ -2719,7 +4275,7 @@ module Aws::Chime
|
|
2719
4275
|
end
|
2720
4276
|
|
2721
4277
|
# Retrieves details for the specified Amazon Chime Voice Connector
|
2722
|
-
# group, such as timestamps,
|
4278
|
+
# group, such as timestamps,name, and associated `VoiceConnectorItems` .
|
2723
4279
|
#
|
2724
4280
|
# @option params [required, String] :voice_connector_group_id
|
2725
4281
|
# The Amazon Chime Voice Connector group ID.
|
@@ -2958,230 +4514,807 @@ module Aws::Chime
|
|
2958
4514
|
# @option params [required, String] :account_id
|
2959
4515
|
# The Amazon Chime account ID.
|
2960
4516
|
#
|
2961
|
-
# @option params [required, Array<String>] :user_email_list
|
2962
|
-
# The user email addresses to which to send the email invitation.
|
4517
|
+
# @option params [required, Array<String>] :user_email_list
|
4518
|
+
# The user email addresses to which to send the email invitation.
|
4519
|
+
#
|
4520
|
+
# @option params [String] :user_type
|
4521
|
+
# The user type.
|
4522
|
+
#
|
4523
|
+
# @return [Types::InviteUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4524
|
+
#
|
4525
|
+
# * {Types::InviteUsersResponse#invites #invites} => Array<Types::Invite>
|
4526
|
+
#
|
4527
|
+
# @example Request syntax with placeholder values
|
4528
|
+
#
|
4529
|
+
# resp = client.invite_users({
|
4530
|
+
# account_id: "NonEmptyString", # required
|
4531
|
+
# user_email_list: ["EmailAddress"], # required
|
4532
|
+
# user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
|
4533
|
+
# })
|
4534
|
+
#
|
4535
|
+
# @example Response structure
|
4536
|
+
#
|
4537
|
+
# resp.invites #=> Array
|
4538
|
+
# resp.invites[0].invite_id #=> String
|
4539
|
+
# resp.invites[0].status #=> String, one of "Pending", "Accepted", "Failed"
|
4540
|
+
# resp.invites[0].email_address #=> String
|
4541
|
+
# resp.invites[0].email_status #=> String, one of "NotSent", "Sent", "Failed"
|
4542
|
+
#
|
4543
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsers AWS API Documentation
|
4544
|
+
#
|
4545
|
+
# @overload invite_users(params = {})
|
4546
|
+
# @param [Hash] params ({})
|
4547
|
+
def invite_users(params = {}, options = {})
|
4548
|
+
req = build_request(:invite_users, params)
|
4549
|
+
req.send_request(options)
|
4550
|
+
end
|
4551
|
+
|
4552
|
+
# Lists the Amazon Chime accounts under the administrator's AWS
|
4553
|
+
# account. You can filter accounts by account name prefix. To find out
|
4554
|
+
# which Amazon Chime account a user belongs to, toucan filter by the
|
4555
|
+
# user's email address, which returns one account result.
|
4556
|
+
#
|
4557
|
+
# @option params [String] :name
|
4558
|
+
# Amazon Chime account name prefix with which to filter results.
|
4559
|
+
#
|
4560
|
+
# @option params [String] :user_email
|
4561
|
+
# User email address with which to filter results.
|
4562
|
+
#
|
4563
|
+
# @option params [String] :next_token
|
4564
|
+
# The token to use to retrieve the next page of results.
|
4565
|
+
#
|
4566
|
+
# @option params [Integer] :max_results
|
4567
|
+
# The maximum number of results to return in a single call. Defaults to
|
4568
|
+
# 100.
|
4569
|
+
#
|
4570
|
+
# @return [Types::ListAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4571
|
+
#
|
4572
|
+
# * {Types::ListAccountsResponse#accounts #accounts} => Array<Types::Account>
|
4573
|
+
# * {Types::ListAccountsResponse#next_token #next_token} => String
|
4574
|
+
#
|
4575
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4576
|
+
#
|
4577
|
+
# @example Request syntax with placeholder values
|
4578
|
+
#
|
4579
|
+
# resp = client.list_accounts({
|
4580
|
+
# name: "AccountName",
|
4581
|
+
# user_email: "EmailAddress",
|
4582
|
+
# next_token: "String",
|
4583
|
+
# max_results: 1,
|
4584
|
+
# })
|
4585
|
+
#
|
4586
|
+
# @example Response structure
|
4587
|
+
#
|
4588
|
+
# resp.accounts #=> Array
|
4589
|
+
# resp.accounts[0].aws_account_id #=> String
|
4590
|
+
# resp.accounts[0].account_id #=> String
|
4591
|
+
# resp.accounts[0].name #=> String
|
4592
|
+
# resp.accounts[0].account_type #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
|
4593
|
+
# resp.accounts[0].created_timestamp #=> Time
|
4594
|
+
# resp.accounts[0].default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
4595
|
+
# resp.accounts[0].supported_licenses #=> Array
|
4596
|
+
# resp.accounts[0].supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
4597
|
+
# resp.accounts[0].signin_delegate_groups #=> Array
|
4598
|
+
# resp.accounts[0].signin_delegate_groups[0].group_name #=> String
|
4599
|
+
# resp.next_token #=> String
|
4600
|
+
#
|
4601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccounts AWS API Documentation
|
4602
|
+
#
|
4603
|
+
# @overload list_accounts(params = {})
|
4604
|
+
# @param [Hash] params ({})
|
4605
|
+
def list_accounts(params = {}, options = {})
|
4606
|
+
req = build_request(:list_accounts, params)
|
4607
|
+
req.send_request(options)
|
4608
|
+
end
|
4609
|
+
|
4610
|
+
# Returns a list of the administrators in the `AppInstance`.
|
4611
|
+
#
|
4612
|
+
# @option params [required, String] :app_instance_arn
|
4613
|
+
# The ARN of the `AppInstance`.
|
4614
|
+
#
|
4615
|
+
# @option params [Integer] :max_results
|
4616
|
+
# The maximum number of administrators that you want to return.
|
4617
|
+
#
|
4618
|
+
# @option params [String] :next_token
|
4619
|
+
# The token returned from previous API requests until the number of
|
4620
|
+
# administrators is reached.
|
4621
|
+
#
|
4622
|
+
# @return [Types::ListAppInstanceAdminsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4623
|
+
#
|
4624
|
+
# * {Types::ListAppInstanceAdminsResponse#app_instance_arn #app_instance_arn} => String
|
4625
|
+
# * {Types::ListAppInstanceAdminsResponse#app_instance_admins #app_instance_admins} => Array<Types::AppInstanceAdminSummary>
|
4626
|
+
# * {Types::ListAppInstanceAdminsResponse#next_token #next_token} => String
|
4627
|
+
#
|
4628
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4629
|
+
#
|
4630
|
+
# @example Request syntax with placeholder values
|
4631
|
+
#
|
4632
|
+
# resp = client.list_app_instance_admins({
|
4633
|
+
# app_instance_arn: "ChimeArn", # required
|
4634
|
+
# max_results: 1,
|
4635
|
+
# next_token: "NextToken",
|
4636
|
+
# })
|
4637
|
+
#
|
4638
|
+
# @example Response structure
|
4639
|
+
#
|
4640
|
+
# resp.app_instance_arn #=> String
|
4641
|
+
# resp.app_instance_admins #=> Array
|
4642
|
+
# resp.app_instance_admins[0].admin.arn #=> String
|
4643
|
+
# resp.app_instance_admins[0].admin.name #=> String
|
4644
|
+
# resp.next_token #=> String
|
4645
|
+
#
|
4646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstanceAdmins AWS API Documentation
|
4647
|
+
#
|
4648
|
+
# @overload list_app_instance_admins(params = {})
|
4649
|
+
# @param [Hash] params ({})
|
4650
|
+
def list_app_instance_admins(params = {}, options = {})
|
4651
|
+
req = build_request(:list_app_instance_admins, params)
|
4652
|
+
req.send_request(options)
|
4653
|
+
end
|
4654
|
+
|
4655
|
+
# List all `AppInstanceUsers` created under a single `AppInstance`.
|
4656
|
+
#
|
4657
|
+
# @option params [required, String] :app_instance_arn
|
4658
|
+
# The ARN of the `AppInstance`.
|
4659
|
+
#
|
4660
|
+
# @option params [Integer] :max_results
|
4661
|
+
# The maximum number of requests that you want returned.
|
4662
|
+
#
|
4663
|
+
# @option params [String] :next_token
|
4664
|
+
# The token passed by previous API calls until all requested users are
|
4665
|
+
# returned.
|
4666
|
+
#
|
4667
|
+
# @return [Types::ListAppInstanceUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4668
|
+
#
|
4669
|
+
# * {Types::ListAppInstanceUsersResponse#app_instance_arn #app_instance_arn} => String
|
4670
|
+
# * {Types::ListAppInstanceUsersResponse#app_instance_users #app_instance_users} => Array<Types::AppInstanceUserSummary>
|
4671
|
+
# * {Types::ListAppInstanceUsersResponse#next_token #next_token} => String
|
4672
|
+
#
|
4673
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4674
|
+
#
|
4675
|
+
# @example Request syntax with placeholder values
|
4676
|
+
#
|
4677
|
+
# resp = client.list_app_instance_users({
|
4678
|
+
# app_instance_arn: "ChimeArn", # required
|
4679
|
+
# max_results: 1,
|
4680
|
+
# next_token: "NextToken",
|
4681
|
+
# })
|
4682
|
+
#
|
4683
|
+
# @example Response structure
|
4684
|
+
#
|
4685
|
+
# resp.app_instance_arn #=> String
|
4686
|
+
# resp.app_instance_users #=> Array
|
4687
|
+
# resp.app_instance_users[0].app_instance_user_arn #=> String
|
4688
|
+
# resp.app_instance_users[0].name #=> String
|
4689
|
+
# resp.app_instance_users[0].metadata #=> String
|
4690
|
+
# resp.next_token #=> String
|
4691
|
+
#
|
4692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstanceUsers AWS API Documentation
|
4693
|
+
#
|
4694
|
+
# @overload list_app_instance_users(params = {})
|
4695
|
+
# @param [Hash] params ({})
|
4696
|
+
def list_app_instance_users(params = {}, options = {})
|
4697
|
+
req = build_request(:list_app_instance_users, params)
|
4698
|
+
req.send_request(options)
|
4699
|
+
end
|
4700
|
+
|
4701
|
+
# Lists all Amazon Chime `AppInstance`s created under a single AWS
|
4702
|
+
# account.
|
4703
|
+
#
|
4704
|
+
# @option params [Integer] :max_results
|
4705
|
+
# The maximum number of `AppInstance`s that you want to return.
|
4706
|
+
#
|
4707
|
+
# @option params [String] :next_token
|
4708
|
+
# The token passed by previous API requests until you reach the maximum
|
4709
|
+
# number of `AppInstance`s.
|
4710
|
+
#
|
4711
|
+
# @return [Types::ListAppInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4712
|
+
#
|
4713
|
+
# * {Types::ListAppInstancesResponse#app_instances #app_instances} => Array<Types::AppInstanceSummary>
|
4714
|
+
# * {Types::ListAppInstancesResponse#next_token #next_token} => String
|
4715
|
+
#
|
4716
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4717
|
+
#
|
4718
|
+
# @example Request syntax with placeholder values
|
4719
|
+
#
|
4720
|
+
# resp = client.list_app_instances({
|
4721
|
+
# max_results: 1,
|
4722
|
+
# next_token: "NextToken",
|
4723
|
+
# })
|
4724
|
+
#
|
4725
|
+
# @example Response structure
|
4726
|
+
#
|
4727
|
+
# resp.app_instances #=> Array
|
4728
|
+
# resp.app_instances[0].app_instance_arn #=> String
|
4729
|
+
# resp.app_instances[0].name #=> String
|
4730
|
+
# resp.app_instances[0].metadata #=> String
|
4731
|
+
# resp.next_token #=> String
|
4732
|
+
#
|
4733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstances AWS API Documentation
|
4734
|
+
#
|
4735
|
+
# @overload list_app_instances(params = {})
|
4736
|
+
# @param [Hash] params ({})
|
4737
|
+
def list_app_instances(params = {}, options = {})
|
4738
|
+
req = build_request(:list_app_instances, params)
|
4739
|
+
req.send_request(options)
|
4740
|
+
end
|
4741
|
+
|
4742
|
+
# Lists the tags applied to an Amazon Chime SDK attendee resource.
|
4743
|
+
#
|
4744
|
+
# @option params [required, String] :meeting_id
|
4745
|
+
# The Amazon Chime SDK meeting ID.
|
4746
|
+
#
|
4747
|
+
# @option params [required, String] :attendee_id
|
4748
|
+
# The Amazon Chime SDK attendee ID.
|
4749
|
+
#
|
4750
|
+
# @return [Types::ListAttendeeTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4751
|
+
#
|
4752
|
+
# * {Types::ListAttendeeTagsResponse#tags #tags} => Array<Types::Tag>
|
4753
|
+
#
|
4754
|
+
# @example Request syntax with placeholder values
|
4755
|
+
#
|
4756
|
+
# resp = client.list_attendee_tags({
|
4757
|
+
# meeting_id: "GuidString", # required
|
4758
|
+
# attendee_id: "GuidString", # required
|
4759
|
+
# })
|
4760
|
+
#
|
4761
|
+
# @example Response structure
|
4762
|
+
#
|
4763
|
+
# resp.tags #=> Array
|
4764
|
+
# resp.tags[0].key #=> String
|
4765
|
+
# resp.tags[0].value #=> String
|
4766
|
+
#
|
4767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAttendeeTags AWS API Documentation
|
4768
|
+
#
|
4769
|
+
# @overload list_attendee_tags(params = {})
|
4770
|
+
# @param [Hash] params ({})
|
4771
|
+
def list_attendee_tags(params = {}, options = {})
|
4772
|
+
req = build_request(:list_attendee_tags, params)
|
4773
|
+
req.send_request(options)
|
4774
|
+
end
|
4775
|
+
|
4776
|
+
# Lists the attendees for the specified Amazon Chime SDK meeting. For
|
4777
|
+
# more information about the Amazon Chime SDK, see [Using the Amazon
|
4778
|
+
# Chime SDK][1] in the *Amazon Chime Developer Guide* .
|
4779
|
+
#
|
4780
|
+
#
|
4781
|
+
#
|
4782
|
+
# [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
|
4783
|
+
#
|
4784
|
+
# @option params [required, String] :meeting_id
|
4785
|
+
# The Amazon Chime SDK meeting ID.
|
4786
|
+
#
|
4787
|
+
# @option params [String] :next_token
|
4788
|
+
# The token to use to retrieve the next page of results.
|
4789
|
+
#
|
4790
|
+
# @option params [Integer] :max_results
|
4791
|
+
# The maximum number of results to return in a single call.
|
4792
|
+
#
|
4793
|
+
# @return [Types::ListAttendeesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4794
|
+
#
|
4795
|
+
# * {Types::ListAttendeesResponse#attendees #attendees} => Array<Types::Attendee>
|
4796
|
+
# * {Types::ListAttendeesResponse#next_token #next_token} => String
|
4797
|
+
#
|
4798
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4799
|
+
#
|
4800
|
+
# @example Request syntax with placeholder values
|
4801
|
+
#
|
4802
|
+
# resp = client.list_attendees({
|
4803
|
+
# meeting_id: "GuidString", # required
|
4804
|
+
# next_token: "String",
|
4805
|
+
# max_results: 1,
|
4806
|
+
# })
|
4807
|
+
#
|
4808
|
+
# @example Response structure
|
4809
|
+
#
|
4810
|
+
# resp.attendees #=> Array
|
4811
|
+
# resp.attendees[0].external_user_id #=> String
|
4812
|
+
# resp.attendees[0].attendee_id #=> String
|
4813
|
+
# resp.attendees[0].join_token #=> String
|
4814
|
+
# resp.next_token #=> String
|
4815
|
+
#
|
4816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAttendees AWS API Documentation
|
4817
|
+
#
|
4818
|
+
# @overload list_attendees(params = {})
|
4819
|
+
# @param [Hash] params ({})
|
4820
|
+
def list_attendees(params = {}, options = {})
|
4821
|
+
req = build_request(:list_attendees, params)
|
4822
|
+
req.send_request(options)
|
4823
|
+
end
|
4824
|
+
|
4825
|
+
# Lists the bots associated with the administrator's Amazon Chime
|
4826
|
+
# Enterprise account ID.
|
4827
|
+
#
|
4828
|
+
# @option params [required, String] :account_id
|
4829
|
+
# The Amazon Chime account ID.
|
4830
|
+
#
|
4831
|
+
# @option params [Integer] :max_results
|
4832
|
+
# The maximum number of results to return in a single call. The default
|
4833
|
+
# is 10.
|
4834
|
+
#
|
4835
|
+
# @option params [String] :next_token
|
4836
|
+
# The token to use to retrieve the next page of results.
|
4837
|
+
#
|
4838
|
+
# @return [Types::ListBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4839
|
+
#
|
4840
|
+
# * {Types::ListBotsResponse#bots #bots} => Array<Types::Bot>
|
4841
|
+
# * {Types::ListBotsResponse#next_token #next_token} => String
|
4842
|
+
#
|
4843
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4844
|
+
#
|
4845
|
+
# @example Request syntax with placeholder values
|
4846
|
+
#
|
4847
|
+
# resp = client.list_bots({
|
4848
|
+
# account_id: "NonEmptyString", # required
|
4849
|
+
# max_results: 1,
|
4850
|
+
# next_token: "String",
|
4851
|
+
# })
|
4852
|
+
#
|
4853
|
+
# @example Response structure
|
4854
|
+
#
|
4855
|
+
# resp.bots #=> Array
|
4856
|
+
# resp.bots[0].bot_id #=> String
|
4857
|
+
# resp.bots[0].user_id #=> String
|
4858
|
+
# resp.bots[0].display_name #=> String
|
4859
|
+
# resp.bots[0].bot_type #=> String, one of "ChatBot"
|
4860
|
+
# resp.bots[0].disabled #=> Boolean
|
4861
|
+
# resp.bots[0].created_timestamp #=> Time
|
4862
|
+
# resp.bots[0].updated_timestamp #=> Time
|
4863
|
+
# resp.bots[0].bot_email #=> String
|
4864
|
+
# resp.bots[0].security_token #=> String
|
4865
|
+
# resp.next_token #=> String
|
4866
|
+
#
|
4867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListBots AWS API Documentation
|
4868
|
+
#
|
4869
|
+
# @overload list_bots(params = {})
|
4870
|
+
# @param [Hash] params ({})
|
4871
|
+
def list_bots(params = {}, options = {})
|
4872
|
+
req = build_request(:list_bots, params)
|
4873
|
+
req.send_request(options)
|
4874
|
+
end
|
4875
|
+
|
4876
|
+
# Lists all the users banned from a particular channel.
|
4877
|
+
#
|
4878
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
4879
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
4880
|
+
# in the header.
|
4881
|
+
#
|
4882
|
+
# </note>
|
4883
|
+
#
|
4884
|
+
# @option params [required, String] :channel_arn
|
4885
|
+
# The ARN of the channel.
|
4886
|
+
#
|
4887
|
+
# @option params [Integer] :max_results
|
4888
|
+
# The maximum number of bans that you want returned.
|
4889
|
+
#
|
4890
|
+
# @option params [String] :next_token
|
4891
|
+
# The token passed by previous API calls until all requested bans are
|
4892
|
+
# returned.
|
4893
|
+
#
|
4894
|
+
# @option params [String] :chime_bearer
|
4895
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
4896
|
+
#
|
4897
|
+
# @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4898
|
+
#
|
4899
|
+
# * {Types::ListChannelBansResponse#channel_arn #channel_arn} => String
|
4900
|
+
# * {Types::ListChannelBansResponse#next_token #next_token} => String
|
4901
|
+
# * {Types::ListChannelBansResponse#channel_bans #channel_bans} => Array<Types::ChannelBanSummary>
|
4902
|
+
#
|
4903
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4904
|
+
#
|
4905
|
+
# @example Request syntax with placeholder values
|
4906
|
+
#
|
4907
|
+
# resp = client.list_channel_bans({
|
4908
|
+
# channel_arn: "ChimeArn", # required
|
4909
|
+
# max_results: 1,
|
4910
|
+
# next_token: "NextToken",
|
4911
|
+
# chime_bearer: "ChimeArn",
|
4912
|
+
# })
|
4913
|
+
#
|
4914
|
+
# @example Response structure
|
4915
|
+
#
|
4916
|
+
# resp.channel_arn #=> String
|
4917
|
+
# resp.next_token #=> String
|
4918
|
+
# resp.channel_bans #=> Array
|
4919
|
+
# resp.channel_bans[0].member.arn #=> String
|
4920
|
+
# resp.channel_bans[0].member.name #=> String
|
4921
|
+
#
|
4922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelBans AWS API Documentation
|
4923
|
+
#
|
4924
|
+
# @overload list_channel_bans(params = {})
|
4925
|
+
# @param [Hash] params ({})
|
4926
|
+
def list_channel_bans(params = {}, options = {})
|
4927
|
+
req = build_request(:list_channel_bans, params)
|
4928
|
+
req.send_request(options)
|
4929
|
+
end
|
4930
|
+
|
4931
|
+
# Lists all channel memberships in a channel.
|
4932
|
+
#
|
4933
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
4934
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
4935
|
+
# in the header.
|
4936
|
+
#
|
4937
|
+
# </note>
|
4938
|
+
#
|
4939
|
+
# @option params [required, String] :channel_arn
|
4940
|
+
# The maximum number of channel memberships that you want returned.
|
4941
|
+
#
|
4942
|
+
# @option params [String] :type
|
4943
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
4944
|
+
# are always returned as part of `ListChannelMemberships`. Hidden
|
4945
|
+
# members are only returned if the type filter in
|
4946
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
|
4947
|
+
# not returned.
|
4948
|
+
#
|
4949
|
+
# @option params [Integer] :max_results
|
4950
|
+
# The maximum number of channel memberships that you want returned.
|
4951
|
+
#
|
4952
|
+
# @option params [String] :next_token
|
4953
|
+
# The token passed by previous API calls until all requested channel
|
4954
|
+
# memberships are returned.
|
4955
|
+
#
|
4956
|
+
# @option params [String] :chime_bearer
|
4957
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
4958
|
+
#
|
4959
|
+
# @return [Types::ListChannelMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4960
|
+
#
|
4961
|
+
# * {Types::ListChannelMembershipsResponse#channel_arn #channel_arn} => String
|
4962
|
+
# * {Types::ListChannelMembershipsResponse#channel_memberships #channel_memberships} => Array<Types::ChannelMembershipSummary>
|
4963
|
+
# * {Types::ListChannelMembershipsResponse#next_token #next_token} => String
|
4964
|
+
#
|
4965
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4966
|
+
#
|
4967
|
+
# @example Request syntax with placeholder values
|
4968
|
+
#
|
4969
|
+
# resp = client.list_channel_memberships({
|
4970
|
+
# channel_arn: "ChimeArn", # required
|
4971
|
+
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
4972
|
+
# max_results: 1,
|
4973
|
+
# next_token: "NextToken",
|
4974
|
+
# chime_bearer: "ChimeArn",
|
4975
|
+
# })
|
4976
|
+
#
|
4977
|
+
# @example Response structure
|
4978
|
+
#
|
4979
|
+
# resp.channel_arn #=> String
|
4980
|
+
# resp.channel_memberships #=> Array
|
4981
|
+
# resp.channel_memberships[0].member.arn #=> String
|
4982
|
+
# resp.channel_memberships[0].member.name #=> String
|
4983
|
+
# resp.next_token #=> String
|
4984
|
+
#
|
4985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMemberships AWS API Documentation
|
4986
|
+
#
|
4987
|
+
# @overload list_channel_memberships(params = {})
|
4988
|
+
# @param [Hash] params ({})
|
4989
|
+
def list_channel_memberships(params = {}, options = {})
|
4990
|
+
req = build_request(:list_channel_memberships, params)
|
4991
|
+
req.send_request(options)
|
4992
|
+
end
|
4993
|
+
|
4994
|
+
# Lists all channels that a particular `AppInstanceUser` is a part of.
|
4995
|
+
# Only an `AppInstanceAdmin` can call the API with a user ARN that is
|
4996
|
+
# not their own.
|
4997
|
+
#
|
4998
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
4999
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5000
|
+
# in the header.
|
5001
|
+
#
|
5002
|
+
# </note>
|
5003
|
+
#
|
5004
|
+
# @option params [String] :app_instance_user_arn
|
5005
|
+
# The ARN of the `AppInstanceUser`s
|
5006
|
+
#
|
5007
|
+
# @option params [Integer] :max_results
|
5008
|
+
# The maximum number of users that you want returned.
|
5009
|
+
#
|
5010
|
+
# @option params [String] :next_token
|
5011
|
+
# The token returned from previous API requests until the number of
|
5012
|
+
# channel memberships is reached.
|
2963
5013
|
#
|
2964
|
-
# @option params [String] :
|
2965
|
-
# The user
|
5014
|
+
# @option params [String] :chime_bearer
|
5015
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2966
5016
|
#
|
2967
|
-
# @return [Types::
|
5017
|
+
# @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2968
5018
|
#
|
2969
|
-
# * {Types::
|
5019
|
+
# * {Types::ListChannelMembershipsForAppInstanceUserResponse#channel_memberships #channel_memberships} => Array<Types::ChannelMembershipForAppInstanceUserSummary>
|
5020
|
+
# * {Types::ListChannelMembershipsForAppInstanceUserResponse#next_token #next_token} => String
|
5021
|
+
#
|
5022
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2970
5023
|
#
|
2971
5024
|
# @example Request syntax with placeholder values
|
2972
5025
|
#
|
2973
|
-
# resp = client.
|
2974
|
-
#
|
2975
|
-
#
|
2976
|
-
#
|
5026
|
+
# resp = client.list_channel_memberships_for_app_instance_user({
|
5027
|
+
# app_instance_user_arn: "ChimeArn",
|
5028
|
+
# max_results: 1,
|
5029
|
+
# next_token: "NextToken",
|
5030
|
+
# chime_bearer: "ChimeArn",
|
2977
5031
|
# })
|
2978
5032
|
#
|
2979
5033
|
# @example Response structure
|
2980
5034
|
#
|
2981
|
-
# resp.
|
2982
|
-
# resp.
|
2983
|
-
# resp.
|
2984
|
-
# resp.
|
2985
|
-
# resp.
|
5035
|
+
# resp.channel_memberships #=> Array
|
5036
|
+
# resp.channel_memberships[0].channel_summary.name #=> String
|
5037
|
+
# resp.channel_memberships[0].channel_summary.channel_arn #=> String
|
5038
|
+
# resp.channel_memberships[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
5039
|
+
# resp.channel_memberships[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
5040
|
+
# resp.channel_memberships[0].channel_summary.metadata #=> String
|
5041
|
+
# resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
|
5042
|
+
# resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
5043
|
+
# resp.channel_memberships[0].app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
5044
|
+
# resp.next_token #=> String
|
2986
5045
|
#
|
2987
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
5046
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMembershipsForAppInstanceUser AWS API Documentation
|
2988
5047
|
#
|
2989
|
-
# @overload
|
5048
|
+
# @overload list_channel_memberships_for_app_instance_user(params = {})
|
2990
5049
|
# @param [Hash] params ({})
|
2991
|
-
def
|
2992
|
-
req = build_request(:
|
5050
|
+
def list_channel_memberships_for_app_instance_user(params = {}, options = {})
|
5051
|
+
req = build_request(:list_channel_memberships_for_app_instance_user, params)
|
2993
5052
|
req.send_request(options)
|
2994
5053
|
end
|
2995
5054
|
|
2996
|
-
#
|
2997
|
-
#
|
2998
|
-
#
|
2999
|
-
# user's email address, which returns one account result.
|
5055
|
+
# List all the messages in a channel. Returns a paginated list of
|
5056
|
+
# `ChannelMessages`. By default, sorted by creation timestamp in
|
5057
|
+
# descending order .
|
3000
5058
|
#
|
3001
|
-
#
|
3002
|
-
#
|
5059
|
+
# <note markdown="1"> Redacted messages appear in the results as empty, since they are only
|
5060
|
+
# redacted, not deleted. Deleted messages do not appear in the results.
|
5061
|
+
# This action always returns the latest version of an edited message.
|
3003
5062
|
#
|
3004
|
-
#
|
3005
|
-
#
|
5063
|
+
# Also, the x-amz-chime-bearer request header is mandatory. Use the
|
5064
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5065
|
+
# in the header.
|
3006
5066
|
#
|
3007
|
-
#
|
3008
|
-
#
|
5067
|
+
# </note>
|
5068
|
+
#
|
5069
|
+
# @option params [required, String] :channel_arn
|
5070
|
+
# The ARN of the channel.
|
5071
|
+
#
|
5072
|
+
# @option params [String] :sort_order
|
5073
|
+
# The order in which you want messages sorted. Default is Descending,
|
5074
|
+
# based on time created.
|
5075
|
+
#
|
5076
|
+
# @option params [Time,DateTime,Date,Integer,String] :not_before
|
5077
|
+
# The initial or starting time stamp for your requested messages.
|
5078
|
+
#
|
5079
|
+
# @option params [Time,DateTime,Date,Integer,String] :not_after
|
5080
|
+
# The final or ending time stamp for your requested messages.
|
3009
5081
|
#
|
3010
5082
|
# @option params [Integer] :max_results
|
3011
|
-
# The maximum number of
|
3012
|
-
# 100.
|
5083
|
+
# The maximum number of messages that you want returned.
|
3013
5084
|
#
|
3014
|
-
# @
|
5085
|
+
# @option params [String] :next_token
|
5086
|
+
# The token passed by previous API calls until all requested messages
|
5087
|
+
# are returned.
|
3015
5088
|
#
|
3016
|
-
#
|
3017
|
-
#
|
5089
|
+
# @option params [String] :chime_bearer
|
5090
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5091
|
+
#
|
5092
|
+
# @return [Types::ListChannelMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5093
|
+
#
|
5094
|
+
# * {Types::ListChannelMessagesResponse#channel_arn #channel_arn} => String
|
5095
|
+
# * {Types::ListChannelMessagesResponse#next_token #next_token} => String
|
5096
|
+
# * {Types::ListChannelMessagesResponse#channel_messages #channel_messages} => Array<Types::ChannelMessageSummary>
|
3018
5097
|
#
|
3019
5098
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3020
5099
|
#
|
3021
5100
|
# @example Request syntax with placeholder values
|
3022
5101
|
#
|
3023
|
-
# resp = client.
|
3024
|
-
#
|
3025
|
-
#
|
3026
|
-
#
|
5102
|
+
# resp = client.list_channel_messages({
|
5103
|
+
# channel_arn: "ChimeArn", # required
|
5104
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
5105
|
+
# not_before: Time.now,
|
5106
|
+
# not_after: Time.now,
|
3027
5107
|
# max_results: 1,
|
5108
|
+
# next_token: "NextToken",
|
5109
|
+
# chime_bearer: "ChimeArn",
|
3028
5110
|
# })
|
3029
5111
|
#
|
3030
5112
|
# @example Response structure
|
3031
5113
|
#
|
3032
|
-
# resp.
|
3033
|
-
# resp.accounts[0].aws_account_id #=> String
|
3034
|
-
# resp.accounts[0].account_id #=> String
|
3035
|
-
# resp.accounts[0].name #=> String
|
3036
|
-
# resp.accounts[0].account_type #=> String, one of "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC"
|
3037
|
-
# resp.accounts[0].created_timestamp #=> Time
|
3038
|
-
# resp.accounts[0].default_license #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
3039
|
-
# resp.accounts[0].supported_licenses #=> Array
|
3040
|
-
# resp.accounts[0].supported_licenses[0] #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
3041
|
-
# resp.accounts[0].signin_delegate_groups #=> Array
|
3042
|
-
# resp.accounts[0].signin_delegate_groups[0].group_name #=> String
|
5114
|
+
# resp.channel_arn #=> String
|
3043
5115
|
# resp.next_token #=> String
|
3044
|
-
#
|
3045
|
-
#
|
3046
|
-
#
|
3047
|
-
#
|
5116
|
+
# resp.channel_messages #=> Array
|
5117
|
+
# resp.channel_messages[0].message_id #=> String
|
5118
|
+
# resp.channel_messages[0].content #=> String
|
5119
|
+
# resp.channel_messages[0].metadata #=> String
|
5120
|
+
# resp.channel_messages[0].type #=> String, one of "STANDARD", "CONTROL"
|
5121
|
+
# resp.channel_messages[0].created_timestamp #=> Time
|
5122
|
+
# resp.channel_messages[0].last_updated_timestamp #=> Time
|
5123
|
+
# resp.channel_messages[0].last_edited_timestamp #=> Time
|
5124
|
+
# resp.channel_messages[0].sender.arn #=> String
|
5125
|
+
# resp.channel_messages[0].sender.name #=> String
|
5126
|
+
# resp.channel_messages[0].redacted #=> Boolean
|
5127
|
+
#
|
5128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMessages AWS API Documentation
|
5129
|
+
#
|
5130
|
+
# @overload list_channel_messages(params = {})
|
3048
5131
|
# @param [Hash] params ({})
|
3049
|
-
def
|
3050
|
-
req = build_request(:
|
5132
|
+
def list_channel_messages(params = {}, options = {})
|
5133
|
+
req = build_request(:list_channel_messages, params)
|
3051
5134
|
req.send_request(options)
|
3052
5135
|
end
|
3053
5136
|
|
3054
|
-
# Lists the
|
5137
|
+
# Lists all the moderators for a channel.
|
3055
5138
|
#
|
3056
|
-
#
|
3057
|
-
#
|
5139
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
5140
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5141
|
+
# in the header.
|
3058
5142
|
#
|
3059
|
-
#
|
3060
|
-
# The Amazon Chime SDK attendee ID.
|
5143
|
+
# </note>
|
3061
5144
|
#
|
3062
|
-
# @
|
5145
|
+
# @option params [required, String] :channel_arn
|
5146
|
+
# The ARN of the channel.
|
3063
5147
|
#
|
3064
|
-
#
|
5148
|
+
# @option params [Integer] :max_results
|
5149
|
+
# The maximum number of moderators that you want returned.
|
5150
|
+
#
|
5151
|
+
# @option params [String] :next_token
|
5152
|
+
# The token passed by previous API calls until all requested moderators
|
5153
|
+
# are returned.
|
5154
|
+
#
|
5155
|
+
# @option params [String] :chime_bearer
|
5156
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5157
|
+
#
|
5158
|
+
# @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5159
|
+
#
|
5160
|
+
# * {Types::ListChannelModeratorsResponse#channel_arn #channel_arn} => String
|
5161
|
+
# * {Types::ListChannelModeratorsResponse#next_token #next_token} => String
|
5162
|
+
# * {Types::ListChannelModeratorsResponse#channel_moderators #channel_moderators} => Array<Types::ChannelModeratorSummary>
|
5163
|
+
#
|
5164
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3065
5165
|
#
|
3066
5166
|
# @example Request syntax with placeholder values
|
3067
5167
|
#
|
3068
|
-
# resp = client.
|
3069
|
-
#
|
3070
|
-
#
|
5168
|
+
# resp = client.list_channel_moderators({
|
5169
|
+
# channel_arn: "ChimeArn", # required
|
5170
|
+
# max_results: 1,
|
5171
|
+
# next_token: "NextToken",
|
5172
|
+
# chime_bearer: "ChimeArn",
|
3071
5173
|
# })
|
3072
5174
|
#
|
3073
5175
|
# @example Response structure
|
3074
5176
|
#
|
3075
|
-
# resp.
|
3076
|
-
# resp.
|
3077
|
-
# resp.
|
5177
|
+
# resp.channel_arn #=> String
|
5178
|
+
# resp.next_token #=> String
|
5179
|
+
# resp.channel_moderators #=> Array
|
5180
|
+
# resp.channel_moderators[0].moderator.arn #=> String
|
5181
|
+
# resp.channel_moderators[0].moderator.name #=> String
|
3078
5182
|
#
|
3079
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
5183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelModerators AWS API Documentation
|
3080
5184
|
#
|
3081
|
-
# @overload
|
5185
|
+
# @overload list_channel_moderators(params = {})
|
3082
5186
|
# @param [Hash] params ({})
|
3083
|
-
def
|
3084
|
-
req = build_request(:
|
5187
|
+
def list_channel_moderators(params = {}, options = {})
|
5188
|
+
req = build_request(:list_channel_moderators, params)
|
3085
5189
|
req.send_request(options)
|
3086
5190
|
end
|
3087
5191
|
|
3088
|
-
# Lists
|
3089
|
-
#
|
3090
|
-
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
5192
|
+
# Lists all Channels created under a single Chime App as a paginated
|
5193
|
+
# list. You can specify filters to narrow results.
|
3091
5194
|
#
|
5195
|
+
# **Functionality & restrictions**
|
3092
5196
|
#
|
5197
|
+
# * Use privacy = `PUBLIC` to retrieve all public channels in the
|
5198
|
+
# account
|
3093
5199
|
#
|
3094
|
-
#
|
5200
|
+
# * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
|
5201
|
+
# private channels in an account.
|
3095
5202
|
#
|
3096
|
-
#
|
3097
|
-
#
|
5203
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
5204
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5205
|
+
# in the header.
|
3098
5206
|
#
|
3099
|
-
#
|
3100
|
-
#
|
5207
|
+
# </note>
|
5208
|
+
#
|
5209
|
+
# @option params [required, String] :app_instance_arn
|
5210
|
+
# The ARN of the `AppInstance`.
|
5211
|
+
#
|
5212
|
+
# @option params [String] :privacy
|
5213
|
+
# The privacy setting. `PUBLIC` retrieves all the public channels.
|
5214
|
+
# `PRIVATE` retrieves private channels. Only an `AppInstanceAdmin` can
|
5215
|
+
# retrieve private channels.
|
3101
5216
|
#
|
3102
5217
|
# @option params [Integer] :max_results
|
3103
|
-
# The maximum number of
|
5218
|
+
# The maximum number of channels that you want to return.
|
3104
5219
|
#
|
3105
|
-
# @
|
5220
|
+
# @option params [String] :next_token
|
5221
|
+
# The token passed by previous API calls until all requested channels
|
5222
|
+
# are returned.
|
3106
5223
|
#
|
3107
|
-
#
|
3108
|
-
#
|
5224
|
+
# @option params [String] :chime_bearer
|
5225
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5226
|
+
#
|
5227
|
+
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5228
|
+
#
|
5229
|
+
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
5230
|
+
# * {Types::ListChannelsResponse#next_token #next_token} => String
|
3109
5231
|
#
|
3110
5232
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3111
5233
|
#
|
3112
5234
|
# @example Request syntax with placeholder values
|
3113
5235
|
#
|
3114
|
-
# resp = client.
|
3115
|
-
#
|
3116
|
-
#
|
5236
|
+
# resp = client.list_channels({
|
5237
|
+
# app_instance_arn: "ChimeArn", # required
|
5238
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
3117
5239
|
# max_results: 1,
|
5240
|
+
# next_token: "NextToken",
|
5241
|
+
# chime_bearer: "ChimeArn",
|
3118
5242
|
# })
|
3119
5243
|
#
|
3120
5244
|
# @example Response structure
|
3121
5245
|
#
|
3122
|
-
# resp.
|
3123
|
-
# resp.
|
3124
|
-
# resp.
|
3125
|
-
# resp.
|
5246
|
+
# resp.channels #=> Array
|
5247
|
+
# resp.channels[0].name #=> String
|
5248
|
+
# resp.channels[0].channel_arn #=> String
|
5249
|
+
# resp.channels[0].mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
5250
|
+
# resp.channels[0].privacy #=> String, one of "PUBLIC", "PRIVATE"
|
5251
|
+
# resp.channels[0].metadata #=> String
|
5252
|
+
# resp.channels[0].last_message_timestamp #=> Time
|
3126
5253
|
# resp.next_token #=> String
|
3127
5254
|
#
|
3128
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
5255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannels AWS API Documentation
|
3129
5256
|
#
|
3130
|
-
# @overload
|
5257
|
+
# @overload list_channels(params = {})
|
3131
5258
|
# @param [Hash] params ({})
|
3132
|
-
def
|
3133
|
-
req = build_request(:
|
5259
|
+
def list_channels(params = {}, options = {})
|
5260
|
+
req = build_request(:list_channels, params)
|
3134
5261
|
req.send_request(options)
|
3135
5262
|
end
|
3136
5263
|
|
3137
|
-
#
|
3138
|
-
# Enterprise account ID.
|
5264
|
+
# A list of the channels moderated by an `AppInstanceUser`.
|
3139
5265
|
#
|
3140
|
-
#
|
3141
|
-
#
|
5266
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
5267
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5268
|
+
# in the header.
|
5269
|
+
#
|
5270
|
+
# </note>
|
5271
|
+
#
|
5272
|
+
# @option params [String] :app_instance_user_arn
|
5273
|
+
# The ARN of the user in the moderated channel.
|
3142
5274
|
#
|
3143
5275
|
# @option params [Integer] :max_results
|
3144
|
-
# The maximum number of
|
3145
|
-
# is 10.
|
5276
|
+
# The maximum number of channels in the request.
|
3146
5277
|
#
|
3147
5278
|
# @option params [String] :next_token
|
3148
|
-
# The token
|
5279
|
+
# The token returned from previous API requests until the number of
|
5280
|
+
# channels moderated by the user is reached.
|
3149
5281
|
#
|
3150
|
-
# @
|
5282
|
+
# @option params [String] :chime_bearer
|
5283
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3151
5284
|
#
|
3152
|
-
#
|
3153
|
-
#
|
5285
|
+
# @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5286
|
+
#
|
5287
|
+
# * {Types::ListChannelsModeratedByAppInstanceUserResponse#channels #channels} => Array<Types::ChannelModeratedByAppInstanceUserSummary>
|
5288
|
+
# * {Types::ListChannelsModeratedByAppInstanceUserResponse#next_token #next_token} => String
|
3154
5289
|
#
|
3155
5290
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3156
5291
|
#
|
3157
5292
|
# @example Request syntax with placeholder values
|
3158
5293
|
#
|
3159
|
-
# resp = client.
|
3160
|
-
#
|
5294
|
+
# resp = client.list_channels_moderated_by_app_instance_user({
|
5295
|
+
# app_instance_user_arn: "ChimeArn",
|
3161
5296
|
# max_results: 1,
|
3162
|
-
# next_token: "
|
5297
|
+
# next_token: "NextToken",
|
5298
|
+
# chime_bearer: "ChimeArn",
|
3163
5299
|
# })
|
3164
5300
|
#
|
3165
5301
|
# @example Response structure
|
3166
5302
|
#
|
3167
|
-
# resp.
|
3168
|
-
# resp.
|
3169
|
-
# resp.
|
3170
|
-
# resp.
|
3171
|
-
# resp.
|
3172
|
-
# resp.
|
3173
|
-
# resp.
|
3174
|
-
# resp.bots[0].updated_timestamp #=> Time
|
3175
|
-
# resp.bots[0].bot_email #=> String
|
3176
|
-
# resp.bots[0].security_token #=> String
|
5303
|
+
# resp.channels #=> Array
|
5304
|
+
# resp.channels[0].channel_summary.name #=> String
|
5305
|
+
# resp.channels[0].channel_summary.channel_arn #=> String
|
5306
|
+
# resp.channels[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
5307
|
+
# resp.channels[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
5308
|
+
# resp.channels[0].channel_summary.metadata #=> String
|
5309
|
+
# resp.channels[0].channel_summary.last_message_timestamp #=> Time
|
3177
5310
|
# resp.next_token #=> String
|
3178
5311
|
#
|
3179
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
5312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelsModeratedByAppInstanceUser AWS API Documentation
|
3180
5313
|
#
|
3181
|
-
# @overload
|
5314
|
+
# @overload list_channels_moderated_by_app_instance_user(params = {})
|
3182
5315
|
# @param [Hash] params ({})
|
3183
|
-
def
|
3184
|
-
req = build_request(:
|
5316
|
+
def list_channels_moderated_by_app_instance_user(params = {}, options = {})
|
5317
|
+
req = build_request(:list_channels_moderated_by_app_instance_user, params)
|
3185
5318
|
req.send_request(options)
|
3186
5319
|
end
|
3187
5320
|
|
@@ -3217,7 +5350,7 @@ module Aws::Chime
|
|
3217
5350
|
|
3218
5351
|
# Lists up to 100 active Amazon Chime SDK meetings. For more information
|
3219
5352
|
# about the Amazon Chime SDK, see [Using the Amazon Chime SDK][1] in the
|
3220
|
-
# *Amazon Chime Developer Guide
|
5353
|
+
# *Amazon Chime Developer Guide* .
|
3221
5354
|
#
|
3222
5355
|
#
|
3223
5356
|
#
|
@@ -3346,7 +5479,7 @@ module Aws::Chime
|
|
3346
5479
|
# resp = client.list_phone_numbers({
|
3347
5480
|
# status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
|
3348
5481
|
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
3349
|
-
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId
|
5482
|
+
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
|
3350
5483
|
# filter_value: "String",
|
3351
5484
|
# max_results: 1,
|
3352
5485
|
# next_token: "String",
|
@@ -3368,7 +5501,7 @@ module Aws::Chime
|
|
3368
5501
|
# resp.phone_numbers[0].capabilities.outbound_mms #=> Boolean
|
3369
5502
|
# resp.phone_numbers[0].associations #=> Array
|
3370
5503
|
# resp.phone_numbers[0].associations[0].value #=> String
|
3371
|
-
# resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
5504
|
+
# resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
3372
5505
|
# resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
|
3373
5506
|
# resp.phone_numbers[0].calling_name #=> String
|
3374
5507
|
# resp.phone_numbers[0].calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -3555,6 +5688,103 @@ module Aws::Chime
|
|
3555
5688
|
req.send_request(options)
|
3556
5689
|
end
|
3557
5690
|
|
5691
|
+
# Lists the SIP media applications under the administrator's AWS
|
5692
|
+
# account.
|
5693
|
+
#
|
5694
|
+
# @option params [Integer] :max_results
|
5695
|
+
# The maximum number of results to return in a single call. Defaults to
|
5696
|
+
# 100.
|
5697
|
+
#
|
5698
|
+
# @option params [String] :next_token
|
5699
|
+
# The token to use to retrieve the next page of results.
|
5700
|
+
#
|
5701
|
+
# @return [Types::ListSipMediaApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5702
|
+
#
|
5703
|
+
# * {Types::ListSipMediaApplicationsResponse#sip_media_applications #sip_media_applications} => Array<Types::SipMediaApplication>
|
5704
|
+
# * {Types::ListSipMediaApplicationsResponse#next_token #next_token} => String
|
5705
|
+
#
|
5706
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5707
|
+
#
|
5708
|
+
# @example Request syntax with placeholder values
|
5709
|
+
#
|
5710
|
+
# resp = client.list_sip_media_applications({
|
5711
|
+
# max_results: 1,
|
5712
|
+
# next_token: "NextTokenString",
|
5713
|
+
# })
|
5714
|
+
#
|
5715
|
+
# @example Response structure
|
5716
|
+
#
|
5717
|
+
# resp.sip_media_applications #=> Array
|
5718
|
+
# resp.sip_media_applications[0].sip_media_application_id #=> String
|
5719
|
+
# resp.sip_media_applications[0].aws_region #=> String
|
5720
|
+
# resp.sip_media_applications[0].name #=> String
|
5721
|
+
# resp.sip_media_applications[0].endpoints #=> Array
|
5722
|
+
# resp.sip_media_applications[0].endpoints[0].lambda_arn #=> String
|
5723
|
+
# resp.sip_media_applications[0].created_timestamp #=> Time
|
5724
|
+
# resp.sip_media_applications[0].updated_timestamp #=> Time
|
5725
|
+
# resp.next_token #=> String
|
5726
|
+
#
|
5727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipMediaApplications AWS API Documentation
|
5728
|
+
#
|
5729
|
+
# @overload list_sip_media_applications(params = {})
|
5730
|
+
# @param [Hash] params ({})
|
5731
|
+
def list_sip_media_applications(params = {}, options = {})
|
5732
|
+
req = build_request(:list_sip_media_applications, params)
|
5733
|
+
req.send_request(options)
|
5734
|
+
end
|
5735
|
+
|
5736
|
+
# Lists the SIP rules under the administrator's AWS account.
|
5737
|
+
#
|
5738
|
+
# @option params [String] :sip_media_application_id
|
5739
|
+
# The SIP media application ID.
|
5740
|
+
#
|
5741
|
+
# @option params [Integer] :max_results
|
5742
|
+
# The maximum number of results to return in a single call. Defaults to
|
5743
|
+
# 100.
|
5744
|
+
#
|
5745
|
+
# @option params [String] :next_token
|
5746
|
+
# The token to use to retrieve the next page of results.
|
5747
|
+
#
|
5748
|
+
# @return [Types::ListSipRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5749
|
+
#
|
5750
|
+
# * {Types::ListSipRulesResponse#sip_rules #sip_rules} => Array<Types::SipRule>
|
5751
|
+
# * {Types::ListSipRulesResponse#next_token #next_token} => String
|
5752
|
+
#
|
5753
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5754
|
+
#
|
5755
|
+
# @example Request syntax with placeholder values
|
5756
|
+
#
|
5757
|
+
# resp = client.list_sip_rules({
|
5758
|
+
# sip_media_application_id: "NonEmptyString",
|
5759
|
+
# max_results: 1,
|
5760
|
+
# next_token: "NextTokenString",
|
5761
|
+
# })
|
5762
|
+
#
|
5763
|
+
# @example Response structure
|
5764
|
+
#
|
5765
|
+
# resp.sip_rules #=> Array
|
5766
|
+
# resp.sip_rules[0].sip_rule_id #=> String
|
5767
|
+
# resp.sip_rules[0].name #=> String
|
5768
|
+
# resp.sip_rules[0].disabled #=> Boolean
|
5769
|
+
# resp.sip_rules[0].trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
5770
|
+
# resp.sip_rules[0].trigger_value #=> String
|
5771
|
+
# resp.sip_rules[0].target_applications #=> Array
|
5772
|
+
# resp.sip_rules[0].target_applications[0].sip_media_application_id #=> String
|
5773
|
+
# resp.sip_rules[0].target_applications[0].priority #=> Integer
|
5774
|
+
# resp.sip_rules[0].target_applications[0].aws_region #=> String
|
5775
|
+
# resp.sip_rules[0].created_timestamp #=> Time
|
5776
|
+
# resp.sip_rules[0].updated_timestamp #=> Time
|
5777
|
+
# resp.next_token #=> String
|
5778
|
+
#
|
5779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipRules AWS API Documentation
|
5780
|
+
#
|
5781
|
+
# @overload list_sip_rules(params = {})
|
5782
|
+
# @param [Hash] params ({})
|
5783
|
+
def list_sip_rules(params = {}, options = {})
|
5784
|
+
req = build_request(:list_sip_rules, params)
|
5785
|
+
req.send_request(options)
|
5786
|
+
end
|
5787
|
+
|
3558
5788
|
# Lists the tags applied to an Amazon Chime SDK meeting resource.
|
3559
5789
|
#
|
3560
5790
|
# @option params [required, String] :resource_arn
|
@@ -3759,39 +5989,117 @@ module Aws::Chime
|
|
3759
5989
|
# resp.voice_connectors[0].updated_timestamp #=> Time
|
3760
5990
|
# resp.next_token #=> String
|
3761
5991
|
#
|
3762
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectors AWS API Documentation
|
5992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectors AWS API Documentation
|
5993
|
+
#
|
5994
|
+
# @overload list_voice_connectors(params = {})
|
5995
|
+
# @param [Hash] params ({})
|
5996
|
+
def list_voice_connectors(params = {}, options = {})
|
5997
|
+
req = build_request(:list_voice_connectors, params)
|
5998
|
+
req.send_request(options)
|
5999
|
+
end
|
6000
|
+
|
6001
|
+
# Logs out the specified user from all of the devices they are currently
|
6002
|
+
# logged into.
|
6003
|
+
#
|
6004
|
+
# @option params [required, String] :account_id
|
6005
|
+
# The Amazon Chime account ID.
|
6006
|
+
#
|
6007
|
+
# @option params [required, String] :user_id
|
6008
|
+
# The user ID.
|
6009
|
+
#
|
6010
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6011
|
+
#
|
6012
|
+
# @example Request syntax with placeholder values
|
6013
|
+
#
|
6014
|
+
# resp = client.logout_user({
|
6015
|
+
# account_id: "NonEmptyString", # required
|
6016
|
+
# user_id: "NonEmptyString", # required
|
6017
|
+
# })
|
6018
|
+
#
|
6019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUser AWS API Documentation
|
6020
|
+
#
|
6021
|
+
# @overload logout_user(params = {})
|
6022
|
+
# @param [Hash] params ({})
|
6023
|
+
def logout_user(params = {}, options = {})
|
6024
|
+
req = build_request(:logout_user, params)
|
6025
|
+
req.send_request(options)
|
6026
|
+
end
|
6027
|
+
|
6028
|
+
# Sets the amount of time in days that a given `AppInstance` retains
|
6029
|
+
# data.
|
6030
|
+
#
|
6031
|
+
# @option params [required, String] :app_instance_arn
|
6032
|
+
# The ARN of the `AppInstance`.
|
6033
|
+
#
|
6034
|
+
# @option params [required, Types::AppInstanceRetentionSettings] :app_instance_retention_settings
|
6035
|
+
# The time in days to retain data. Data type: number.
|
6036
|
+
#
|
6037
|
+
# @return [Types::PutAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6038
|
+
#
|
6039
|
+
# * {Types::PutAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
|
6040
|
+
# * {Types::PutAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
|
6041
|
+
#
|
6042
|
+
# @example Request syntax with placeholder values
|
6043
|
+
#
|
6044
|
+
# resp = client.put_app_instance_retention_settings({
|
6045
|
+
# app_instance_arn: "ChimeArn", # required
|
6046
|
+
# app_instance_retention_settings: { # required
|
6047
|
+
# channel_retention_settings: {
|
6048
|
+
# retention_days: 1,
|
6049
|
+
# },
|
6050
|
+
# },
|
6051
|
+
# })
|
6052
|
+
#
|
6053
|
+
# @example Response structure
|
3763
6054
|
#
|
3764
|
-
#
|
6055
|
+
# resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
|
6056
|
+
# resp.initiate_deletion_timestamp #=> Time
|
6057
|
+
#
|
6058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutAppInstanceRetentionSettings AWS API Documentation
|
6059
|
+
#
|
6060
|
+
# @overload put_app_instance_retention_settings(params = {})
|
3765
6061
|
# @param [Hash] params ({})
|
3766
|
-
def
|
3767
|
-
req = build_request(:
|
6062
|
+
def put_app_instance_retention_settings(params = {}, options = {})
|
6063
|
+
req = build_request(:put_app_instance_retention_settings, params)
|
3768
6064
|
req.send_request(options)
|
3769
6065
|
end
|
3770
6066
|
|
3771
|
-
#
|
3772
|
-
# logged into.
|
6067
|
+
# The data streaming configurations of an `AppInstance`.
|
3773
6068
|
#
|
3774
|
-
# @option params [required, String] :
|
3775
|
-
# The
|
6069
|
+
# @option params [required, String] :app_instance_arn
|
6070
|
+
# The ARN of the `AppInstance`.
|
3776
6071
|
#
|
3777
|
-
# @option params [required,
|
3778
|
-
# The
|
6072
|
+
# @option params [required, Array<Types::AppInstanceStreamingConfiguration>] :app_instance_streaming_configurations
|
6073
|
+
# The streaming configurations set for an `AppInstance`.
|
3779
6074
|
#
|
3780
|
-
# @return [
|
6075
|
+
# @return [Types::PutAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6076
|
+
#
|
6077
|
+
# * {Types::PutAppInstanceStreamingConfigurationsResponse#app_instance_streaming_configurations #app_instance_streaming_configurations} => Array<Types::AppInstanceStreamingConfiguration>
|
3781
6078
|
#
|
3782
6079
|
# @example Request syntax with placeholder values
|
3783
6080
|
#
|
3784
|
-
# resp = client.
|
3785
|
-
#
|
3786
|
-
#
|
6081
|
+
# resp = client.put_app_instance_streaming_configurations({
|
6082
|
+
# app_instance_arn: "ChimeArn", # required
|
6083
|
+
# app_instance_streaming_configurations: [ # required
|
6084
|
+
# {
|
6085
|
+
# app_instance_data_type: "Channel", # required, accepts Channel, ChannelMessage
|
6086
|
+
# resource_arn: "Arn", # required
|
6087
|
+
# },
|
6088
|
+
# ],
|
3787
6089
|
# })
|
3788
6090
|
#
|
3789
|
-
# @
|
6091
|
+
# @example Response structure
|
3790
6092
|
#
|
3791
|
-
#
|
6093
|
+
# resp.app_instance_streaming_configurations #=> Array
|
6094
|
+
# resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
|
6095
|
+
# resp.app_instance_streaming_configurations[0].resource_arn #=> String
|
6096
|
+
#
|
6097
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutAppInstanceStreamingConfigurations AWS API Documentation
|
6098
|
+
#
|
6099
|
+
# @overload put_app_instance_streaming_configurations(params = {})
|
3792
6100
|
# @param [Hash] params ({})
|
3793
|
-
def
|
3794
|
-
req = build_request(:
|
6101
|
+
def put_app_instance_streaming_configurations(params = {}, options = {})
|
6102
|
+
req = build_request(:put_app_instance_streaming_configurations, params)
|
3795
6103
|
req.send_request(options)
|
3796
6104
|
end
|
3797
6105
|
|
@@ -3843,13 +6151,13 @@ module Aws::Chime
|
|
3843
6151
|
# account. We recommend using AWS CloudTrail to monitor usage of this
|
3844
6152
|
# API for your account. For more information, see [Logging Amazon Chime
|
3845
6153
|
# API Calls with AWS CloudTrail][1] in the *Amazon Chime Administration
|
3846
|
-
# Guide
|
6154
|
+
# Guide* .
|
3847
6155
|
#
|
3848
6156
|
# To turn off existing retention settings, remove the number of days
|
3849
6157
|
# from the corresponding **RetentionDays** field in the
|
3850
6158
|
# **RetentionSettings** object. For more information about retention
|
3851
6159
|
# settings, see [Managing Chat Retention Policies][2] in the *Amazon
|
3852
|
-
# Chime Administration Guide
|
6160
|
+
# Chime Administration Guide* .
|
3853
6161
|
#
|
3854
6162
|
#
|
3855
6163
|
#
|
@@ -3896,6 +6204,41 @@ module Aws::Chime
|
|
3896
6204
|
req.send_request(options)
|
3897
6205
|
end
|
3898
6206
|
|
6207
|
+
# Updates the logging configuration for the specified SIP media
|
6208
|
+
# application.
|
6209
|
+
#
|
6210
|
+
# @option params [required, String] :sip_media_application_id
|
6211
|
+
# The SIP media application ID.
|
6212
|
+
#
|
6213
|
+
# @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
|
6214
|
+
# The actual logging configuration.
|
6215
|
+
#
|
6216
|
+
# @return [Types::PutSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6217
|
+
#
|
6218
|
+
# * {Types::PutSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
6219
|
+
#
|
6220
|
+
# @example Request syntax with placeholder values
|
6221
|
+
#
|
6222
|
+
# resp = client.put_sip_media_application_logging_configuration({
|
6223
|
+
# sip_media_application_id: "NonEmptyString", # required
|
6224
|
+
# sip_media_application_logging_configuration: {
|
6225
|
+
# enable_sip_media_application_message_logs: false,
|
6226
|
+
# },
|
6227
|
+
# })
|
6228
|
+
#
|
6229
|
+
# @example Response structure
|
6230
|
+
#
|
6231
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
6232
|
+
#
|
6233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutSipMediaApplicationLoggingConfiguration AWS API Documentation
|
6234
|
+
#
|
6235
|
+
# @overload put_sip_media_application_logging_configuration(params = {})
|
6236
|
+
# @param [Hash] params ({})
|
6237
|
+
def put_sip_media_application_logging_configuration(params = {}, options = {})
|
6238
|
+
req = build_request(:put_sip_media_application_logging_configuration, params)
|
6239
|
+
req.send_request(options)
|
6240
|
+
end
|
6241
|
+
|
3899
6242
|
# Puts emergency calling configuration details to the specified Amazon
|
3900
6243
|
# Chime Voice Connector, such as emergency phone numbers and calling
|
3901
6244
|
# countries. Origination and termination settings must be enabled for
|
@@ -4087,7 +6430,7 @@ module Aws::Chime
|
|
4087
6430
|
|
4088
6431
|
# Adds a streaming configuration for the specified Amazon Chime Voice
|
4089
6432
|
# Connector. The streaming configuration specifies whether media
|
4090
|
-
# streaming is enabled for sending to
|
6433
|
+
# streaming is enabled for sending to Indonesians. It also sets the
|
4091
6434
|
# retention period, in hours, for the Amazon Kinesis data.
|
4092
6435
|
#
|
4093
6436
|
# @option params [required, String] :voice_connector_id
|
@@ -4214,6 +6557,53 @@ module Aws::Chime
|
|
4214
6557
|
req.send_request(options)
|
4215
6558
|
end
|
4216
6559
|
|
6560
|
+
# Redacts message content, but not metadata. The message exists in the
|
6561
|
+
# back end, but the action returns null content, and the state shows as
|
6562
|
+
# redacted.
|
6563
|
+
#
|
6564
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
6565
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
6566
|
+
# in the header.
|
6567
|
+
#
|
6568
|
+
# </note>
|
6569
|
+
#
|
6570
|
+
# @option params [required, String] :channel_arn
|
6571
|
+
# The ARN of the channel containing the messages that you want to
|
6572
|
+
# redact.
|
6573
|
+
#
|
6574
|
+
# @option params [required, String] :message_id
|
6575
|
+
# The ID of the message being redacted.
|
6576
|
+
#
|
6577
|
+
# @option params [String] :chime_bearer
|
6578
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
6579
|
+
#
|
6580
|
+
# @return [Types::RedactChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6581
|
+
#
|
6582
|
+
# * {Types::RedactChannelMessageResponse#channel_arn #channel_arn} => String
|
6583
|
+
# * {Types::RedactChannelMessageResponse#message_id #message_id} => String
|
6584
|
+
#
|
6585
|
+
# @example Request syntax with placeholder values
|
6586
|
+
#
|
6587
|
+
# resp = client.redact_channel_message({
|
6588
|
+
# channel_arn: "ChimeArn", # required
|
6589
|
+
# message_id: "MessageId", # required
|
6590
|
+
# chime_bearer: "ChimeArn",
|
6591
|
+
# })
|
6592
|
+
#
|
6593
|
+
# @example Response structure
|
6594
|
+
#
|
6595
|
+
# resp.channel_arn #=> String
|
6596
|
+
# resp.message_id #=> String
|
6597
|
+
#
|
6598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/RedactChannelMessage AWS API Documentation
|
6599
|
+
#
|
6600
|
+
# @overload redact_channel_message(params = {})
|
6601
|
+
# @param [Hash] params ({})
|
6602
|
+
def redact_channel_message(params = {}, options = {})
|
6603
|
+
req = build_request(:redact_channel_message, params)
|
6604
|
+
req.send_request(options)
|
6605
|
+
end
|
6606
|
+
|
4217
6607
|
# Redacts the specified message from the specified Amazon Chime
|
4218
6608
|
# conversation.
|
4219
6609
|
#
|
@@ -4245,8 +6635,7 @@ module Aws::Chime
|
|
4245
6635
|
req.send_request(options)
|
4246
6636
|
end
|
4247
6637
|
|
4248
|
-
# Redacts the specified message from the specified Amazon Chime
|
4249
|
-
# room.
|
6638
|
+
# Redacts the specified message from the specified Amazon Chime channel.
|
4250
6639
|
#
|
4251
6640
|
# @option params [required, String] :account_id
|
4252
6641
|
# The Amazon Chime account ID.
|
@@ -4394,7 +6783,7 @@ module Aws::Chime
|
|
4394
6783
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
4395
6784
|
# resp.phone_number.associations #=> Array
|
4396
6785
|
# resp.phone_number.associations[0].value #=> String
|
4397
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
6786
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
4398
6787
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
4399
6788
|
# resp.phone_number.calling_name #=> String
|
4400
6789
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -4464,6 +6853,74 @@ module Aws::Chime
|
|
4464
6853
|
req.send_request(options)
|
4465
6854
|
end
|
4466
6855
|
|
6856
|
+
# Sends a message to a particular channel that the member is a part of.
|
6857
|
+
#
|
6858
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
6859
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
6860
|
+
# in the header.
|
6861
|
+
#
|
6862
|
+
# Also, `STANDARD` messages can contain 4KB of data and the 1KB of
|
6863
|
+
# metadata. `CONTROL` messages can contain 30 bytes of data and no
|
6864
|
+
# metadata.
|
6865
|
+
#
|
6866
|
+
# </note>
|
6867
|
+
#
|
6868
|
+
# @option params [required, String] :channel_arn
|
6869
|
+
# The ARN of the channel.
|
6870
|
+
#
|
6871
|
+
# @option params [required, String] :content
|
6872
|
+
# The content of the message.
|
6873
|
+
#
|
6874
|
+
# @option params [required, String] :type
|
6875
|
+
# The type of message, `STANDARD` or `CONTROL`.
|
6876
|
+
#
|
6877
|
+
# @option params [required, String] :persistence
|
6878
|
+
# Boolean that controls whether the message is persisted on the back
|
6879
|
+
# end. Required.
|
6880
|
+
#
|
6881
|
+
# @option params [String] :metadata
|
6882
|
+
# The optional metadata for each message.
|
6883
|
+
#
|
6884
|
+
# @option params [required, String] :client_request_token
|
6885
|
+
# The `Idempotency` token for each client request.
|
6886
|
+
#
|
6887
|
+
# **A suitable default value is auto-generated.** You should normally
|
6888
|
+
# not need to pass this option.**
|
6889
|
+
#
|
6890
|
+
# @option params [String] :chime_bearer
|
6891
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
6892
|
+
#
|
6893
|
+
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6894
|
+
#
|
6895
|
+
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
6896
|
+
# * {Types::SendChannelMessageResponse#message_id #message_id} => String
|
6897
|
+
#
|
6898
|
+
# @example Request syntax with placeholder values
|
6899
|
+
#
|
6900
|
+
# resp = client.send_channel_message({
|
6901
|
+
# channel_arn: "ChimeArn", # required
|
6902
|
+
# content: "NonEmptyContent", # required
|
6903
|
+
# type: "STANDARD", # required, accepts STANDARD, CONTROL
|
6904
|
+
# persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
|
6905
|
+
# metadata: "Metadata",
|
6906
|
+
# client_request_token: "ClientRequestToken", # required
|
6907
|
+
# chime_bearer: "ChimeArn",
|
6908
|
+
# })
|
6909
|
+
#
|
6910
|
+
# @example Response structure
|
6911
|
+
#
|
6912
|
+
# resp.channel_arn #=> String
|
6913
|
+
# resp.message_id #=> String
|
6914
|
+
#
|
6915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SendChannelMessage AWS API Documentation
|
6916
|
+
#
|
6917
|
+
# @overload send_channel_message(params = {})
|
6918
|
+
# @param [Hash] params ({})
|
6919
|
+
def send_channel_message(params = {}, options = {})
|
6920
|
+
req = build_request(:send_channel_message, params)
|
6921
|
+
req.send_request(options)
|
6922
|
+
end
|
6923
|
+
|
4467
6924
|
# Applies the specified tags to the specified Amazon Chime SDK attendee.
|
4468
6925
|
#
|
4469
6926
|
# @option params [required, String] :meeting_id
|
@@ -4724,6 +7181,79 @@ module Aws::Chime
|
|
4724
7181
|
req.send_request(options)
|
4725
7182
|
end
|
4726
7183
|
|
7184
|
+
# Updates `AppInstance` metadata.
|
7185
|
+
#
|
7186
|
+
# @option params [required, String] :app_instance_arn
|
7187
|
+
# The ARN of the `AppInstance`.
|
7188
|
+
#
|
7189
|
+
# @option params [required, String] :name
|
7190
|
+
# The name that you want to change.
|
7191
|
+
#
|
7192
|
+
# @option params [String] :metadata
|
7193
|
+
# The metadata that you want to change.
|
7194
|
+
#
|
7195
|
+
# @return [Types::UpdateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7196
|
+
#
|
7197
|
+
# * {Types::UpdateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
|
7198
|
+
#
|
7199
|
+
# @example Request syntax with placeholder values
|
7200
|
+
#
|
7201
|
+
# resp = client.update_app_instance({
|
7202
|
+
# app_instance_arn: "ChimeArn", # required
|
7203
|
+
# name: "NonEmptyResourceName", # required
|
7204
|
+
# metadata: "Metadata",
|
7205
|
+
# })
|
7206
|
+
#
|
7207
|
+
# @example Response structure
|
7208
|
+
#
|
7209
|
+
# resp.app_instance_arn #=> String
|
7210
|
+
#
|
7211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAppInstance AWS API Documentation
|
7212
|
+
#
|
7213
|
+
# @overload update_app_instance(params = {})
|
7214
|
+
# @param [Hash] params ({})
|
7215
|
+
def update_app_instance(params = {}, options = {})
|
7216
|
+
req = build_request(:update_app_instance, params)
|
7217
|
+
req.send_request(options)
|
7218
|
+
end
|
7219
|
+
|
7220
|
+
# Updates the details of an `AppInstanceUser`. You can update names and
|
7221
|
+
# metadata.
|
7222
|
+
#
|
7223
|
+
# @option params [required, String] :app_instance_user_arn
|
7224
|
+
# The ARN of the `AppInstanceUser`.
|
7225
|
+
#
|
7226
|
+
# @option params [required, String] :name
|
7227
|
+
# The name of the `AppInstanceUser`.
|
7228
|
+
#
|
7229
|
+
# @option params [String] :metadata
|
7230
|
+
# The metadata of the `AppInstanceUser`.
|
7231
|
+
#
|
7232
|
+
# @return [Types::UpdateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7233
|
+
#
|
7234
|
+
# * {Types::UpdateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
|
7235
|
+
#
|
7236
|
+
# @example Request syntax with placeholder values
|
7237
|
+
#
|
7238
|
+
# resp = client.update_app_instance_user({
|
7239
|
+
# app_instance_user_arn: "ChimeArn", # required
|
7240
|
+
# name: "UserName", # required
|
7241
|
+
# metadata: "Metadata",
|
7242
|
+
# })
|
7243
|
+
#
|
7244
|
+
# @example Response structure
|
7245
|
+
#
|
7246
|
+
# resp.app_instance_user_arn #=> String
|
7247
|
+
#
|
7248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAppInstanceUser AWS API Documentation
|
7249
|
+
#
|
7250
|
+
# @overload update_app_instance_user(params = {})
|
7251
|
+
# @param [Hash] params ({})
|
7252
|
+
def update_app_instance_user(params = {}, options = {})
|
7253
|
+
req = build_request(:update_app_instance_user, params)
|
7254
|
+
req.send_request(options)
|
7255
|
+
end
|
7256
|
+
|
4727
7257
|
# Updates the status of the specified bot, such as starting or stopping
|
4728
7258
|
# the bot from running in your Amazon Chime Enterprise account.
|
4729
7259
|
#
|
@@ -4769,6 +7299,148 @@ module Aws::Chime
|
|
4769
7299
|
req.send_request(options)
|
4770
7300
|
end
|
4771
7301
|
|
7302
|
+
# Update a channel's attributes.
|
7303
|
+
#
|
7304
|
+
# **Restriction**\: You can't change a channel's privacy.
|
7305
|
+
#
|
7306
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
7307
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
7308
|
+
# in the header.
|
7309
|
+
#
|
7310
|
+
# </note>
|
7311
|
+
#
|
7312
|
+
# @option params [required, String] :channel_arn
|
7313
|
+
# The ARN of the channel.
|
7314
|
+
#
|
7315
|
+
# @option params [required, String] :name
|
7316
|
+
# The name of the channel.
|
7317
|
+
#
|
7318
|
+
# @option params [required, String] :mode
|
7319
|
+
# The mode of the update request.
|
7320
|
+
#
|
7321
|
+
# @option params [String] :metadata
|
7322
|
+
# The metadata for the update request.
|
7323
|
+
#
|
7324
|
+
# @option params [String] :chime_bearer
|
7325
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
7326
|
+
#
|
7327
|
+
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7328
|
+
#
|
7329
|
+
# * {Types::UpdateChannelResponse#channel_arn #channel_arn} => String
|
7330
|
+
#
|
7331
|
+
# @example Request syntax with placeholder values
|
7332
|
+
#
|
7333
|
+
# resp = client.update_channel({
|
7334
|
+
# channel_arn: "ChimeArn", # required
|
7335
|
+
# name: "NonEmptyResourceName", # required
|
7336
|
+
# mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
|
7337
|
+
# metadata: "Metadata",
|
7338
|
+
# chime_bearer: "ChimeArn",
|
7339
|
+
# })
|
7340
|
+
#
|
7341
|
+
# @example Response structure
|
7342
|
+
#
|
7343
|
+
# resp.channel_arn #=> String
|
7344
|
+
#
|
7345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannel AWS API Documentation
|
7346
|
+
#
|
7347
|
+
# @overload update_channel(params = {})
|
7348
|
+
# @param [Hash] params ({})
|
7349
|
+
def update_channel(params = {}, options = {})
|
7350
|
+
req = build_request(:update_channel, params)
|
7351
|
+
req.send_request(options)
|
7352
|
+
end
|
7353
|
+
|
7354
|
+
# Updates the content of a message.
|
7355
|
+
#
|
7356
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
7357
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
7358
|
+
# in the header.
|
7359
|
+
#
|
7360
|
+
# </note>
|
7361
|
+
#
|
7362
|
+
# @option params [required, String] :channel_arn
|
7363
|
+
# The ARN of the channel.
|
7364
|
+
#
|
7365
|
+
# @option params [required, String] :message_id
|
7366
|
+
# The ID string of the message being updated.
|
7367
|
+
#
|
7368
|
+
# @option params [String] :content
|
7369
|
+
# The content of the message being updated.
|
7370
|
+
#
|
7371
|
+
# @option params [String] :metadata
|
7372
|
+
# The metadata of the message being updated.
|
7373
|
+
#
|
7374
|
+
# @option params [String] :chime_bearer
|
7375
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
7376
|
+
#
|
7377
|
+
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7378
|
+
#
|
7379
|
+
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
7380
|
+
# * {Types::UpdateChannelMessageResponse#message_id #message_id} => String
|
7381
|
+
#
|
7382
|
+
# @example Request syntax with placeholder values
|
7383
|
+
#
|
7384
|
+
# resp = client.update_channel_message({
|
7385
|
+
# channel_arn: "ChimeArn", # required
|
7386
|
+
# message_id: "MessageId", # required
|
7387
|
+
# content: "Content",
|
7388
|
+
# metadata: "Metadata",
|
7389
|
+
# chime_bearer: "ChimeArn",
|
7390
|
+
# })
|
7391
|
+
#
|
7392
|
+
# @example Response structure
|
7393
|
+
#
|
7394
|
+
# resp.channel_arn #=> String
|
7395
|
+
# resp.message_id #=> String
|
7396
|
+
#
|
7397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannelMessage AWS API Documentation
|
7398
|
+
#
|
7399
|
+
# @overload update_channel_message(params = {})
|
7400
|
+
# @param [Hash] params ({})
|
7401
|
+
def update_channel_message(params = {}, options = {})
|
7402
|
+
req = build_request(:update_channel_message, params)
|
7403
|
+
req.send_request(options)
|
7404
|
+
end
|
7405
|
+
|
7406
|
+
# The details of the time when a user last read messages in a channel.
|
7407
|
+
#
|
7408
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
7409
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
7410
|
+
# in the header.
|
7411
|
+
#
|
7412
|
+
# </note>
|
7413
|
+
#
|
7414
|
+
# @option params [required, String] :channel_arn
|
7415
|
+
# The ARN of the channel.
|
7416
|
+
#
|
7417
|
+
# @option params [String] :chime_bearer
|
7418
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
7419
|
+
#
|
7420
|
+
# @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7421
|
+
#
|
7422
|
+
# * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
|
7423
|
+
#
|
7424
|
+
# @example Request syntax with placeholder values
|
7425
|
+
#
|
7426
|
+
# resp = client.update_channel_read_marker({
|
7427
|
+
# channel_arn: "ChimeArn", # required
|
7428
|
+
# chime_bearer: "ChimeArn",
|
7429
|
+
# })
|
7430
|
+
#
|
7431
|
+
# @example Response structure
|
7432
|
+
#
|
7433
|
+
# resp.channel_arn #=> String
|
7434
|
+
#
|
7435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannelReadMarker AWS API Documentation
|
7436
|
+
#
|
7437
|
+
# @overload update_channel_read_marker(params = {})
|
7438
|
+
# @param [Hash] params ({})
|
7439
|
+
def update_channel_read_marker(params = {}, options = {})
|
7440
|
+
req = build_request(:update_channel_read_marker, params)
|
7441
|
+
req.send_request(options)
|
7442
|
+
end
|
7443
|
+
|
4772
7444
|
# Updates global settings for the administrator's AWS account, such as
|
4773
7445
|
# Amazon Chime Business Calling and Amazon Chime Voice Connector
|
4774
7446
|
# settings.
|
@@ -4849,7 +7521,7 @@ module Aws::Chime
|
|
4849
7521
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
4850
7522
|
# resp.phone_number.associations #=> Array
|
4851
7523
|
# resp.phone_number.associations[0].value #=> String
|
4852
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
7524
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
4853
7525
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
4854
7526
|
# resp.phone_number.calling_name #=> String
|
4855
7527
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -5041,6 +7713,108 @@ module Aws::Chime
|
|
5041
7713
|
req.send_request(options)
|
5042
7714
|
end
|
5043
7715
|
|
7716
|
+
# Updates the details of the specified SIP media application.
|
7717
|
+
#
|
7718
|
+
# @option params [required, String] :sip_media_application_id
|
7719
|
+
# The SIP media application ID.
|
7720
|
+
#
|
7721
|
+
# @option params [String] :name
|
7722
|
+
# The new name for the specified SIP media application.
|
7723
|
+
#
|
7724
|
+
# @option params [Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
7725
|
+
# The new set of endpoints for the specified SIP media application.
|
7726
|
+
#
|
7727
|
+
# @return [Types::UpdateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7728
|
+
#
|
7729
|
+
# * {Types::UpdateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
7730
|
+
#
|
7731
|
+
# @example Request syntax with placeholder values
|
7732
|
+
#
|
7733
|
+
# resp = client.update_sip_media_application({
|
7734
|
+
# sip_media_application_id: "NonEmptyString", # required
|
7735
|
+
# name: "SipMediaApplicationName",
|
7736
|
+
# endpoints: [
|
7737
|
+
# {
|
7738
|
+
# lambda_arn: "FunctionArn",
|
7739
|
+
# },
|
7740
|
+
# ],
|
7741
|
+
# })
|
7742
|
+
#
|
7743
|
+
# @example Response structure
|
7744
|
+
#
|
7745
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
7746
|
+
# resp.sip_media_application.aws_region #=> String
|
7747
|
+
# resp.sip_media_application.name #=> String
|
7748
|
+
# resp.sip_media_application.endpoints #=> Array
|
7749
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
7750
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
7751
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
7752
|
+
#
|
7753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipMediaApplication AWS API Documentation
|
7754
|
+
#
|
7755
|
+
# @overload update_sip_media_application(params = {})
|
7756
|
+
# @param [Hash] params ({})
|
7757
|
+
def update_sip_media_application(params = {}, options = {})
|
7758
|
+
req = build_request(:update_sip_media_application, params)
|
7759
|
+
req.send_request(options)
|
7760
|
+
end
|
7761
|
+
|
7762
|
+
# Updates the details of the specified SIP rule.
|
7763
|
+
#
|
7764
|
+
# @option params [required, String] :sip_rule_id
|
7765
|
+
# The SIP rule ID.
|
7766
|
+
#
|
7767
|
+
# @option params [required, String] :name
|
7768
|
+
# The new name for the specified SIP rule.
|
7769
|
+
#
|
7770
|
+
# @option params [Boolean] :disabled
|
7771
|
+
# The new value specified to indicate whether the rule is disabled.
|
7772
|
+
#
|
7773
|
+
# @option params [Array<Types::SipRuleTargetApplication>] :target_applications
|
7774
|
+
# The new value of the list of target applications.
|
7775
|
+
#
|
7776
|
+
# @return [Types::UpdateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7777
|
+
#
|
7778
|
+
# * {Types::UpdateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
7779
|
+
#
|
7780
|
+
# @example Request syntax with placeholder values
|
7781
|
+
#
|
7782
|
+
# resp = client.update_sip_rule({
|
7783
|
+
# sip_rule_id: "NonEmptyString", # required
|
7784
|
+
# name: "SipRuleName", # required
|
7785
|
+
# disabled: false,
|
7786
|
+
# target_applications: [
|
7787
|
+
# {
|
7788
|
+
# sip_media_application_id: "NonEmptyString",
|
7789
|
+
# priority: 1,
|
7790
|
+
# aws_region: "String",
|
7791
|
+
# },
|
7792
|
+
# ],
|
7793
|
+
# })
|
7794
|
+
#
|
7795
|
+
# @example Response structure
|
7796
|
+
#
|
7797
|
+
# resp.sip_rule.sip_rule_id #=> String
|
7798
|
+
# resp.sip_rule.name #=> String
|
7799
|
+
# resp.sip_rule.disabled #=> Boolean
|
7800
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
7801
|
+
# resp.sip_rule.trigger_value #=> String
|
7802
|
+
# resp.sip_rule.target_applications #=> Array
|
7803
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
7804
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
7805
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
7806
|
+
# resp.sip_rule.created_timestamp #=> Time
|
7807
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
7808
|
+
#
|
7809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipRule AWS API Documentation
|
7810
|
+
#
|
7811
|
+
# @overload update_sip_rule(params = {})
|
7812
|
+
# @param [Hash] params ({})
|
7813
|
+
def update_sip_rule(params = {}, options = {})
|
7814
|
+
req = build_request(:update_sip_rule, params)
|
7815
|
+
req.send_request(options)
|
7816
|
+
end
|
7817
|
+
|
5044
7818
|
# Updates user details for a specified user ID. Currently, only
|
5045
7819
|
# `LicenseType` updates are supported for this action.
|
5046
7820
|
#
|
@@ -5183,7 +7957,7 @@ module Aws::Chime
|
|
5183
7957
|
req.send_request(options)
|
5184
7958
|
end
|
5185
7959
|
|
5186
|
-
# Updates details
|
7960
|
+
# Updates details of the specified Amazon Chime Voice Connector group,
|
5187
7961
|
# such as the name and Amazon Chime Voice Connector priority ranking.
|
5188
7962
|
#
|
5189
7963
|
# @option params [required, String] :voice_connector_group_id
|
@@ -5244,7 +8018,7 @@ module Aws::Chime
|
|
5244
8018
|
params: params,
|
5245
8019
|
config: config)
|
5246
8020
|
context[:gem_name] = 'aws-sdk-chime'
|
5247
|
-
context[:gem_version] = '1.
|
8021
|
+
context[:gem_version] = '1.40.0'
|
5248
8022
|
Seahorse::Client::Request.new(handlers, context)
|
5249
8023
|
end
|
5250
8024
|
|