aws-sdk-chime 1.33.0 → 1.39.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 +3 -2
- data/lib/aws-sdk-chime/client.rb +2623 -118
- data/lib/aws-sdk-chime/client_api.rb +2029 -67
- data/lib/aws-sdk-chime/types.rb +4829 -1379
- 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: 8f36acfcf4078f3d498117b912792043673a8a638a67d68d627c133a720d90cf
|
4
|
+
data.tar.gz: 6b577c579dbd897ba7f48d0c784b7f6ec49d62b253c56ada1c49c9b780622306
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1efe07c5806b6aebba8fe1b210786aaaee7d63f028939683e5791e5cb622cd757ec663d2ad3c6f2cd382e811c9168c5d53621de4ad803c91718a2c18325fdbe8
|
7
|
+
data.tar.gz: d5c47c36cd7fafbd5298f1ebd83d86b6523106bc7f16c36c77a503f991aacc78e30abe55c7b6408a34912c963d8d5cfe5d1c7c09562913d3fb27828ce6af7f17
|
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
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-chime/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::Chime
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.39.0'
|
51
52
|
|
52
53
|
end
|
data/lib/aws-sdk-chime/client.rb
CHANGED
@@ -85,13 +85,28 @@ module Aws::Chime
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::Chime
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -840,6 +855,139 @@ module Aws::Chime
|
|
840
855
|
req.send_request(options)
|
841
856
|
end
|
842
857
|
|
858
|
+
# Creates an Amazon Chime Messaging SDK `AppInstance` under an AWS
|
859
|
+
# Account. Only Messaging SDK customers use this API.
|
860
|
+
# `CreateAppInstance` supports `idempotency` behavior as described in
|
861
|
+
# the AWS API Standard.
|
862
|
+
#
|
863
|
+
# @option params [required, String] :name
|
864
|
+
# The name of the app instance.
|
865
|
+
#
|
866
|
+
# @option params [String] :metadata
|
867
|
+
# The metadata of the app instance. Limited to a 1KB string in UTF-8.
|
868
|
+
#
|
869
|
+
# @option params [required, String] :client_request_token
|
870
|
+
# The `ClientRequestToken` of the app instance.
|
871
|
+
#
|
872
|
+
# **A suitable default value is auto-generated.** You should normally
|
873
|
+
# not need to pass this option.**
|
874
|
+
#
|
875
|
+
# @return [Types::CreateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
876
|
+
#
|
877
|
+
# * {Types::CreateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
|
878
|
+
#
|
879
|
+
# @example Request syntax with placeholder values
|
880
|
+
#
|
881
|
+
# resp = client.create_app_instance({
|
882
|
+
# name: "NonEmptyResourceName", # required
|
883
|
+
# metadata: "Metadata",
|
884
|
+
# client_request_token: "ClientRequestToken", # required
|
885
|
+
# })
|
886
|
+
#
|
887
|
+
# @example Response structure
|
888
|
+
#
|
889
|
+
# resp.app_instance_arn #=> String
|
890
|
+
#
|
891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstance AWS API Documentation
|
892
|
+
#
|
893
|
+
# @overload create_app_instance(params = {})
|
894
|
+
# @param [Hash] params ({})
|
895
|
+
def create_app_instance(params = {}, options = {})
|
896
|
+
req = build_request(:create_app_instance, params)
|
897
|
+
req.send_request(options)
|
898
|
+
end
|
899
|
+
|
900
|
+
# Promotes an `AppInstanceUser` to an `AppInstanceAdmin`. The promoted
|
901
|
+
# user can perform the following actions.
|
902
|
+
#
|
903
|
+
# * `ChannelModerator` actions across all channels in the app instance.
|
904
|
+
#
|
905
|
+
# * `DeleteChannelMessage` actions.
|
906
|
+
#
|
907
|
+
# Only an `AppInstanceUser` can be promoted to an `AppInstanceAdmin`
|
908
|
+
# role.
|
909
|
+
#
|
910
|
+
# @option params [required, String] :app_instance_admin_arn
|
911
|
+
# The ARN of the administrator of the current app instance.
|
912
|
+
#
|
913
|
+
# @option params [required, String] :app_instance_arn
|
914
|
+
# The ARN of the app instance.
|
915
|
+
#
|
916
|
+
# @return [Types::CreateAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
917
|
+
#
|
918
|
+
# * {Types::CreateAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::Identity
|
919
|
+
# * {Types::CreateAppInstanceAdminResponse#app_instance_arn #app_instance_arn} => String
|
920
|
+
#
|
921
|
+
# @example Request syntax with placeholder values
|
922
|
+
#
|
923
|
+
# resp = client.create_app_instance_admin({
|
924
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
925
|
+
# app_instance_arn: "ChimeArn", # required
|
926
|
+
# })
|
927
|
+
#
|
928
|
+
# @example Response structure
|
929
|
+
#
|
930
|
+
# resp.app_instance_admin.arn #=> String
|
931
|
+
# resp.app_instance_admin.name #=> String
|
932
|
+
# resp.app_instance_arn #=> String
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstanceAdmin AWS API Documentation
|
935
|
+
#
|
936
|
+
# @overload create_app_instance_admin(params = {})
|
937
|
+
# @param [Hash] params ({})
|
938
|
+
def create_app_instance_admin(params = {}, options = {})
|
939
|
+
req = build_request(:create_app_instance_admin, params)
|
940
|
+
req.send_request(options)
|
941
|
+
end
|
942
|
+
|
943
|
+
# Creates a user under an Amazon Chime `AppInstance`. The request
|
944
|
+
# consists of a unique `appInstanceUserId` and `Name` for that user.
|
945
|
+
#
|
946
|
+
# @option params [required, String] :app_instance_arn
|
947
|
+
# The ARN of the app instance request.
|
948
|
+
#
|
949
|
+
# @option params [required, String] :app_instance_user_id
|
950
|
+
# The user ID of the app instance.
|
951
|
+
#
|
952
|
+
# @option params [required, String] :name
|
953
|
+
# The user's name.
|
954
|
+
#
|
955
|
+
# @option params [String] :metadata
|
956
|
+
# The request's metadata. Limited to a 1KB string in UTF-8.
|
957
|
+
#
|
958
|
+
# @option params [required, String] :client_request_token
|
959
|
+
# The token assigned to the user requesting an app instance.
|
960
|
+
#
|
961
|
+
# **A suitable default value is auto-generated.** You should normally
|
962
|
+
# not need to pass this option.**
|
963
|
+
#
|
964
|
+
# @return [Types::CreateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
965
|
+
#
|
966
|
+
# * {Types::CreateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
|
967
|
+
#
|
968
|
+
# @example Request syntax with placeholder values
|
969
|
+
#
|
970
|
+
# resp = client.create_app_instance_user({
|
971
|
+
# app_instance_arn: "ChimeArn", # required
|
972
|
+
# app_instance_user_id: "UserId", # required
|
973
|
+
# name: "UserName", # required
|
974
|
+
# metadata: "Metadata",
|
975
|
+
# client_request_token: "ClientRequestToken", # required
|
976
|
+
# })
|
977
|
+
#
|
978
|
+
# @example Response structure
|
979
|
+
#
|
980
|
+
# resp.app_instance_user_arn #=> String
|
981
|
+
#
|
982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstanceUser AWS API Documentation
|
983
|
+
#
|
984
|
+
# @overload create_app_instance_user(params = {})
|
985
|
+
# @param [Hash] params ({})
|
986
|
+
def create_app_instance_user(params = {}, options = {})
|
987
|
+
req = build_request(:create_app_instance_user, params)
|
988
|
+
req.send_request(options)
|
989
|
+
end
|
990
|
+
|
843
991
|
# Creates a new attendee for an active Amazon Chime SDK meeting. For
|
844
992
|
# more information about the Amazon Chime SDK, see [Using the Amazon
|
845
993
|
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
@@ -852,8 +1000,10 @@ module Aws::Chime
|
|
852
1000
|
# The Amazon Chime SDK meeting ID.
|
853
1001
|
#
|
854
1002
|
# @option params [required, String] :external_user_id
|
855
|
-
# The Amazon Chime SDK external user ID.
|
856
|
-
# identity managed by a builder application.
|
1003
|
+
# The Amazon Chime SDK external user ID. An idempotency token. Links the
|
1004
|
+
# attendee to an identity managed by a builder application. If you
|
1005
|
+
# create an attendee with the same external user id, the service returns
|
1006
|
+
# the existing record.
|
857
1007
|
#
|
858
1008
|
# @option params [Array<Types::Tag>] :tags
|
859
1009
|
# The tag key-value pairs.
|
@@ -934,6 +1084,219 @@ module Aws::Chime
|
|
934
1084
|
req.send_request(options)
|
935
1085
|
end
|
936
1086
|
|
1087
|
+
# Creates a channel to which you can add users and send messages.
|
1088
|
+
#
|
1089
|
+
# **Restriction**\: You can't change a channel's privacy.
|
1090
|
+
#
|
1091
|
+
# @option params [required, String] :app_instance_arn
|
1092
|
+
# The ARN of the channel request.
|
1093
|
+
#
|
1094
|
+
# @option params [required, String] :name
|
1095
|
+
# The name of the channel.
|
1096
|
+
#
|
1097
|
+
# @option params [String] :mode
|
1098
|
+
# The channel mode: `UNRESTRICTED` or `RESTRICTED`. Administrators,
|
1099
|
+
# moderators, and channel members can add themselves and other members
|
1100
|
+
# to unrestricted channels. Only administrators and moderators can add
|
1101
|
+
# members to restricted channels.
|
1102
|
+
#
|
1103
|
+
# @option params [String] :privacy
|
1104
|
+
# The channel's privacy level: `PUBLIC` or `PRIVATE`. Private channels
|
1105
|
+
# aren't discoverable by users outside the channel. Public channels are
|
1106
|
+
# discoverable by anyone in the app instance.
|
1107
|
+
#
|
1108
|
+
# @option params [String] :metadata
|
1109
|
+
# The metadata of the creation request. Limited to 1KB and UTF-8.
|
1110
|
+
#
|
1111
|
+
# @option params [required, String] :client_request_token
|
1112
|
+
# The client token for the request. An `Idempotency` token.
|
1113
|
+
#
|
1114
|
+
# **A suitable default value is auto-generated.** You should normally
|
1115
|
+
# not need to pass this option.**
|
1116
|
+
#
|
1117
|
+
# @option params [Array<Types::Tag>] :tags
|
1118
|
+
#
|
1119
|
+
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1120
|
+
#
|
1121
|
+
# * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
|
1122
|
+
#
|
1123
|
+
# @example Request syntax with placeholder values
|
1124
|
+
#
|
1125
|
+
# resp = client.create_channel({
|
1126
|
+
# app_instance_arn: "ChimeArn", # required
|
1127
|
+
# name: "NonEmptyResourceName", # required
|
1128
|
+
# mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
|
1129
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
1130
|
+
# metadata: "Metadata",
|
1131
|
+
# client_request_token: "ClientRequestToken", # required
|
1132
|
+
# tags: [
|
1133
|
+
# {
|
1134
|
+
# key: "TagKey", # required
|
1135
|
+
# value: "TagValue", # required
|
1136
|
+
# },
|
1137
|
+
# ],
|
1138
|
+
# })
|
1139
|
+
#
|
1140
|
+
# @example Response structure
|
1141
|
+
#
|
1142
|
+
# resp.channel_arn #=> String
|
1143
|
+
#
|
1144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannel AWS API Documentation
|
1145
|
+
#
|
1146
|
+
# @overload create_channel(params = {})
|
1147
|
+
# @param [Hash] params ({})
|
1148
|
+
def create_channel(params = {}, options = {})
|
1149
|
+
req = build_request(:create_channel, params)
|
1150
|
+
req.send_request(options)
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Permanently bans a member from a channel. Moderators can't add banned
|
1154
|
+
# members to a channel. To undo a ban, you first have to
|
1155
|
+
# `DeleteChannelBan`, and then `CreateChannelMembership`. Bans are
|
1156
|
+
# cleaned up when you delete users or channels.
|
1157
|
+
#
|
1158
|
+
# If you ban a user who is already part of a channel, that user is
|
1159
|
+
# automatically kicked from the channel.
|
1160
|
+
#
|
1161
|
+
# @option params [required, String] :channel_arn
|
1162
|
+
# The ARN of the ban request.
|
1163
|
+
#
|
1164
|
+
# @option params [required, String] :member_arn
|
1165
|
+
# The ARN of the member being banned.
|
1166
|
+
#
|
1167
|
+
# @return [Types::CreateChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1168
|
+
#
|
1169
|
+
# * {Types::CreateChannelBanResponse#channel_arn #channel_arn} => String
|
1170
|
+
# * {Types::CreateChannelBanResponse#member #member} => Types::Identity
|
1171
|
+
#
|
1172
|
+
# @example Request syntax with placeholder values
|
1173
|
+
#
|
1174
|
+
# resp = client.create_channel_ban({
|
1175
|
+
# channel_arn: "ChimeArn", # required
|
1176
|
+
# member_arn: "ChimeArn", # required
|
1177
|
+
# })
|
1178
|
+
#
|
1179
|
+
# @example Response structure
|
1180
|
+
#
|
1181
|
+
# resp.channel_arn #=> String
|
1182
|
+
# resp.member.arn #=> String
|
1183
|
+
# resp.member.name #=> String
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelBan AWS API Documentation
|
1186
|
+
#
|
1187
|
+
# @overload create_channel_ban(params = {})
|
1188
|
+
# @param [Hash] params ({})
|
1189
|
+
def create_channel_ban(params = {}, options = {})
|
1190
|
+
req = build_request(:create_channel_ban, params)
|
1191
|
+
req.send_request(options)
|
1192
|
+
end
|
1193
|
+
|
1194
|
+
# Adds a user to a channel. The `InvitedBy` response field is derived
|
1195
|
+
# from the request header. A channel member can:
|
1196
|
+
#
|
1197
|
+
# * List messages
|
1198
|
+
#
|
1199
|
+
# * Send messages
|
1200
|
+
#
|
1201
|
+
# * Receive messages
|
1202
|
+
#
|
1203
|
+
# * Edit their own messages
|
1204
|
+
#
|
1205
|
+
# * Leave the channel
|
1206
|
+
#
|
1207
|
+
# Privacy settings impact this action as follows:
|
1208
|
+
#
|
1209
|
+
# * Public Channels: You do not need to be a member to list messages,
|
1210
|
+
# but you must be a member to send messages.
|
1211
|
+
#
|
1212
|
+
# * Private Channels: You must be a member to list or send messages.
|
1213
|
+
#
|
1214
|
+
# @option params [required, String] :channel_arn
|
1215
|
+
# The ARN of the channel to which you're adding users.
|
1216
|
+
#
|
1217
|
+
# @option params [required, String] :member_arn
|
1218
|
+
# The ARN of the member you want to add to the channel.
|
1219
|
+
#
|
1220
|
+
# @option params [required, String] :type
|
1221
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
1222
|
+
# are always returned as part of `ListChannelMemberships`. Hidden
|
1223
|
+
# members are only returned if the type filter in
|
1224
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
|
1225
|
+
# not returned. This is only supported by moderators.
|
1226
|
+
#
|
1227
|
+
# @return [Types::CreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1228
|
+
#
|
1229
|
+
# * {Types::CreateChannelMembershipResponse#channel_arn #channel_arn} => String
|
1230
|
+
# * {Types::CreateChannelMembershipResponse#member #member} => Types::Identity
|
1231
|
+
#
|
1232
|
+
# @example Request syntax with placeholder values
|
1233
|
+
#
|
1234
|
+
# resp = client.create_channel_membership({
|
1235
|
+
# channel_arn: "ChimeArn", # required
|
1236
|
+
# member_arn: "ChimeArn", # required
|
1237
|
+
# type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
|
1238
|
+
# })
|
1239
|
+
#
|
1240
|
+
# @example Response structure
|
1241
|
+
#
|
1242
|
+
# resp.channel_arn #=> String
|
1243
|
+
# resp.member.arn #=> String
|
1244
|
+
# resp.member.name #=> String
|
1245
|
+
#
|
1246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelMembership AWS API Documentation
|
1247
|
+
#
|
1248
|
+
# @overload create_channel_membership(params = {})
|
1249
|
+
# @param [Hash] params ({})
|
1250
|
+
def create_channel_membership(params = {}, options = {})
|
1251
|
+
req = build_request(:create_channel_membership, params)
|
1252
|
+
req.send_request(options)
|
1253
|
+
end
|
1254
|
+
|
1255
|
+
# Creates a new `ChannelModerator`. A channel moderator can:
|
1256
|
+
#
|
1257
|
+
# * Add and remove other members of the channel.
|
1258
|
+
#
|
1259
|
+
# * Add and remove other moderators of the channel.
|
1260
|
+
#
|
1261
|
+
# * Add and remove user bans for the channel.
|
1262
|
+
#
|
1263
|
+
# * Redact messages in the channel.
|
1264
|
+
#
|
1265
|
+
# * List messages in the channel.
|
1266
|
+
#
|
1267
|
+
# @option params [required, String] :channel_arn
|
1268
|
+
# The ARN of the channel.
|
1269
|
+
#
|
1270
|
+
# @option params [required, String] :channel_moderator_arn
|
1271
|
+
# The ARN of the moderator.
|
1272
|
+
#
|
1273
|
+
# @return [Types::CreateChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1274
|
+
#
|
1275
|
+
# * {Types::CreateChannelModeratorResponse#channel_arn #channel_arn} => String
|
1276
|
+
# * {Types::CreateChannelModeratorResponse#channel_moderator #channel_moderator} => Types::Identity
|
1277
|
+
#
|
1278
|
+
# @example Request syntax with placeholder values
|
1279
|
+
#
|
1280
|
+
# resp = client.create_channel_moderator({
|
1281
|
+
# channel_arn: "ChimeArn", # required
|
1282
|
+
# channel_moderator_arn: "ChimeArn", # required
|
1283
|
+
# })
|
1284
|
+
#
|
1285
|
+
# @example Response structure
|
1286
|
+
#
|
1287
|
+
# resp.channel_arn #=> String
|
1288
|
+
# resp.channel_moderator.arn #=> String
|
1289
|
+
# resp.channel_moderator.name #=> String
|
1290
|
+
#
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelModerator AWS API Documentation
|
1292
|
+
#
|
1293
|
+
# @overload create_channel_moderator(params = {})
|
1294
|
+
# @param [Hash] params ({})
|
1295
|
+
def create_channel_moderator(params = {}, options = {})
|
1296
|
+
req = build_request(:create_channel_moderator, params)
|
1297
|
+
req.send_request(options)
|
1298
|
+
end
|
1299
|
+
|
937
1300
|
# Creates a new Amazon Chime SDK meeting in the specified media Region
|
938
1301
|
# with no initial attendees. For more information about specifying media
|
939
1302
|
# Regions, see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime
|
@@ -961,10 +1324,11 @@ module Aws::Chime
|
|
961
1324
|
# @option params [String] :media_region
|
962
1325
|
# The Region in which to create the meeting. Default: `us-east-1`.
|
963
1326
|
#
|
964
|
-
# Available values: `ap-northeast-1`, `ap-
|
965
|
-
# `ap-
|
966
|
-
# `eu-
|
967
|
-
# `
|
1327
|
+
# Available values: `af-south-1`, `ap-northeast-1`, `ap-northeast-2`,
|
1328
|
+
# `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`,
|
1329
|
+
# `eu-central-1`, `eu-north-1`, `eu-south-1`, `eu-west-1`, `eu-west-2`,
|
1330
|
+
# `eu-west-3`, `sa-east-1`, `us-east-1`, `us-east-2`, `us-west-1`,
|
1331
|
+
# `us-west-2`.
|
968
1332
|
#
|
969
1333
|
# @option params [Array<Types::Tag>] :tags
|
970
1334
|
# The tag key-value pairs.
|
@@ -1018,6 +1382,66 @@ module Aws::Chime
|
|
1018
1382
|
req.send_request(options)
|
1019
1383
|
end
|
1020
1384
|
|
1385
|
+
# Uses the join token and call metadata in a meeting request (From
|
1386
|
+
# number, To number, and so forth) to initiate an outbound call to a
|
1387
|
+
# public switched telephone network (PSTN) and joins them into Chime
|
1388
|
+
# meeting. Also ensures that the From number belongs to the customer.
|
1389
|
+
#
|
1390
|
+
# To play welcome audio or implement an interactive voice response
|
1391
|
+
# (IVR), use the `CreateSipMediaApplicationCall` API with the
|
1392
|
+
# corresponding SIP media application ID.
|
1393
|
+
#
|
1394
|
+
# @option params [required, String] :meeting_id
|
1395
|
+
# The Amazon Chime SDK meeting ID.
|
1396
|
+
#
|
1397
|
+
# Type: String
|
1398
|
+
#
|
1399
|
+
# Pattern:
|
1400
|
+
# \[a-fA-F0-9\]\\\{8\\}(?:-\[a-fA-F0-9\]\\\{4\\})\\\{3\\}-\[a-fA-F0-9\]\\\{12\\}
|
1401
|
+
#
|
1402
|
+
# Required: No
|
1403
|
+
#
|
1404
|
+
# @option params [required, String] :from_phone_number
|
1405
|
+
# Phone number used as the caller ID when the remote party receives a
|
1406
|
+
# call.
|
1407
|
+
#
|
1408
|
+
# @option params [required, String] :to_phone_number
|
1409
|
+
# Phone number called when inviting someone to a meeting.
|
1410
|
+
#
|
1411
|
+
# @option params [required, String] :join_token
|
1412
|
+
# Token used by the Amazon Chime SDK attendee. Call the [ CreateAttendee
|
1413
|
+
# API][1] to get a join token.
|
1414
|
+
#
|
1415
|
+
#
|
1416
|
+
#
|
1417
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.html
|
1418
|
+
#
|
1419
|
+
# @return [Types::CreateMeetingDialOutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1420
|
+
#
|
1421
|
+
# * {Types::CreateMeetingDialOutResponse#transaction_id #transaction_id} => String
|
1422
|
+
#
|
1423
|
+
# @example Request syntax with placeholder values
|
1424
|
+
#
|
1425
|
+
# resp = client.create_meeting_dial_out({
|
1426
|
+
# meeting_id: "GuidString", # required
|
1427
|
+
# from_phone_number: "E164PhoneNumber", # required
|
1428
|
+
# to_phone_number: "E164PhoneNumber", # required
|
1429
|
+
# join_token: "JoinTokenString", # required
|
1430
|
+
# })
|
1431
|
+
#
|
1432
|
+
# @example Response structure
|
1433
|
+
#
|
1434
|
+
# resp.transaction_id #=> String
|
1435
|
+
#
|
1436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateMeetingDialOut AWS API Documentation
|
1437
|
+
#
|
1438
|
+
# @overload create_meeting_dial_out(params = {})
|
1439
|
+
# @param [Hash] params ({})
|
1440
|
+
def create_meeting_dial_out(params = {}, options = {})
|
1441
|
+
req = build_request(:create_meeting_dial_out, params)
|
1442
|
+
req.send_request(options)
|
1443
|
+
end
|
1444
|
+
|
1021
1445
|
# Creates a new Amazon Chime SDK meeting in the specified media Region,
|
1022
1446
|
# with attendees. For more information about specifying media Regions,
|
1023
1447
|
# see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime Developer
|
@@ -1045,10 +1469,11 @@ module Aws::Chime
|
|
1045
1469
|
# @option params [String] :media_region
|
1046
1470
|
# The Region in which to create the meeting. Default: `us-east-1`.
|
1047
1471
|
#
|
1048
|
-
# Available values: `ap-northeast-1`, `ap-
|
1049
|
-
# `ap-
|
1050
|
-
# `eu-
|
1051
|
-
# `
|
1472
|
+
# Available values: `af-south-1`, `ap-northeast-1`, `ap-northeast-2`,
|
1473
|
+
# `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`,
|
1474
|
+
# `eu-central-1`, `eu-north-1`, `eu-south-1`, `eu-west-1`, `eu-west-2`,
|
1475
|
+
# `eu-west-3`, `sa-east-1`, `us-east-1`, `us-east-2`, `us-west-1`,
|
1476
|
+
# `us-west-2`.
|
1052
1477
|
#
|
1053
1478
|
# @option params [Array<Types::Tag>] :tags
|
1054
1479
|
# The tag key-value pairs.
|
@@ -1343,67 +1768,226 @@ module Aws::Chime
|
|
1343
1768
|
req.send_request(options)
|
1344
1769
|
end
|
1345
1770
|
|
1346
|
-
# Creates a
|
1347
|
-
#
|
1348
|
-
# @option params [required, String] :account_id
|
1349
|
-
# The Amazon Chime account ID.
|
1771
|
+
# Creates a SIP media application.
|
1350
1772
|
#
|
1351
|
-
# @option params [String] :
|
1352
|
-
#
|
1773
|
+
# @option params [required, String] :aws_region
|
1774
|
+
# AWS Region assigned to the SIP media application.
|
1353
1775
|
#
|
1354
|
-
# @option params [String] :
|
1355
|
-
# The
|
1776
|
+
# @option params [String] :name
|
1777
|
+
# The SIP media application name.
|
1356
1778
|
#
|
1357
|
-
# @option params [
|
1358
|
-
#
|
1779
|
+
# @option params [required, Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
1780
|
+
# List of endpoints (Lambda Amazon Resource Names) specified for the SIP
|
1781
|
+
# media application. Currently, only one endpoint is supported.
|
1359
1782
|
#
|
1360
|
-
# @return [Types::
|
1783
|
+
# @return [Types::CreateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1361
1784
|
#
|
1362
|
-
# * {Types::
|
1785
|
+
# * {Types::CreateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
1363
1786
|
#
|
1364
1787
|
# @example Request syntax with placeholder values
|
1365
1788
|
#
|
1366
|
-
# resp = client.
|
1367
|
-
#
|
1368
|
-
#
|
1369
|
-
#
|
1370
|
-
#
|
1789
|
+
# resp = client.create_sip_media_application({
|
1790
|
+
# aws_region: "String", # required
|
1791
|
+
# name: "SipMediaApplicationName",
|
1792
|
+
# endpoints: [ # required
|
1793
|
+
# {
|
1794
|
+
# lambda_arn: "FunctionArn",
|
1795
|
+
# },
|
1796
|
+
# ],
|
1371
1797
|
# })
|
1372
1798
|
#
|
1373
1799
|
# @example Response structure
|
1374
1800
|
#
|
1375
|
-
# resp.
|
1376
|
-
# resp.
|
1377
|
-
# resp.
|
1378
|
-
# resp.
|
1379
|
-
# resp.
|
1380
|
-
# resp.
|
1381
|
-
# resp.
|
1382
|
-
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
1383
|
-
# resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
1384
|
-
# resp.user.registered_on #=> Time
|
1385
|
-
# resp.user.invited_on #=> Time
|
1386
|
-
# resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
|
1387
|
-
# resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
|
1388
|
-
# resp.user.personal_pin #=> String
|
1801
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
1802
|
+
# resp.sip_media_application.aws_region #=> String
|
1803
|
+
# resp.sip_media_application.name #=> String
|
1804
|
+
# resp.sip_media_application.endpoints #=> Array
|
1805
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
1806
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
1807
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
1389
1808
|
#
|
1390
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
1809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplication AWS API Documentation
|
1391
1810
|
#
|
1392
|
-
# @overload
|
1811
|
+
# @overload create_sip_media_application(params = {})
|
1393
1812
|
# @param [Hash] params ({})
|
1394
|
-
def
|
1395
|
-
req = build_request(:
|
1813
|
+
def create_sip_media_application(params = {}, options = {})
|
1814
|
+
req = build_request(:create_sip_media_application, params)
|
1396
1815
|
req.send_request(options)
|
1397
1816
|
end
|
1398
1817
|
|
1399
|
-
# Creates an
|
1400
|
-
#
|
1401
|
-
#
|
1818
|
+
# Creates an outbound call to a phone number from the phone number
|
1819
|
+
# specified in the request, and it invokes the endpoint of the specified
|
1820
|
+
# `sipMediaApplicationId`.
|
1402
1821
|
#
|
1403
|
-
#
|
1404
|
-
#
|
1405
|
-
#
|
1406
|
-
#
|
1822
|
+
# @option params [String] :from_phone_number
|
1823
|
+
# The phone number that a user calls from.
|
1824
|
+
#
|
1825
|
+
# @option params [String] :to_phone_number
|
1826
|
+
# The phone number that the user dials in order to connect to a meeting
|
1827
|
+
#
|
1828
|
+
# @option params [required, String] :sip_media_application_id
|
1829
|
+
# The ID of the SIP media application.
|
1830
|
+
#
|
1831
|
+
# @return [Types::CreateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1832
|
+
#
|
1833
|
+
# * {Types::CreateSipMediaApplicationCallResponse#sip_media_application_call #sip_media_application_call} => Types::SipMediaApplicationCall
|
1834
|
+
#
|
1835
|
+
# @example Request syntax with placeholder values
|
1836
|
+
#
|
1837
|
+
# resp = client.create_sip_media_application_call({
|
1838
|
+
# from_phone_number: "E164PhoneNumber",
|
1839
|
+
# to_phone_number: "E164PhoneNumber",
|
1840
|
+
# sip_media_application_id: "NonEmptyString", # required
|
1841
|
+
# })
|
1842
|
+
#
|
1843
|
+
# @example Response structure
|
1844
|
+
#
|
1845
|
+
# resp.sip_media_application_call.transaction_id #=> String
|
1846
|
+
#
|
1847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipMediaApplicationCall AWS API Documentation
|
1848
|
+
#
|
1849
|
+
# @overload create_sip_media_application_call(params = {})
|
1850
|
+
# @param [Hash] params ({})
|
1851
|
+
def create_sip_media_application_call(params = {}, options = {})
|
1852
|
+
req = build_request(:create_sip_media_application_call, params)
|
1853
|
+
req.send_request(options)
|
1854
|
+
end
|
1855
|
+
|
1856
|
+
# Creates a SIP rule which can be used to run a SIP media application as
|
1857
|
+
# a target for a specific trigger type.
|
1858
|
+
#
|
1859
|
+
# @option params [required, String] :name
|
1860
|
+
# The name of the SIP rule.
|
1861
|
+
#
|
1862
|
+
# @option params [required, String] :trigger_type
|
1863
|
+
# The type of trigger whose value is assigned to the SIP rule in
|
1864
|
+
# `TriggerValue`. Allowed trigger values are `RequestUriHostname` and
|
1865
|
+
# `ToPhoneNumber`.
|
1866
|
+
#
|
1867
|
+
# @option params [required, String] :trigger_value
|
1868
|
+
# If `TriggerType` is `RequestUriHostname` then the value can be the
|
1869
|
+
# outbound host name of an Amazon Chime Voice Connector. If
|
1870
|
+
# `TriggerType` is `ToPhoneNumber` then the value can be a
|
1871
|
+
# customer-owned phone number in E164 format. `SipRule` is triggered if
|
1872
|
+
# the SIP application requests a host name, or a If `TriggerType` is
|
1873
|
+
# `RequestUriHostname`, then the value can be the outbound hostname of
|
1874
|
+
# an Amazon Chime Voice Connector. If `TriggerType` is `ToPhoneNumber`,
|
1875
|
+
# then the value can be a customer-owned phone number in E164 format.
|
1876
|
+
# `SipRule` is triggered if the SIP application requests a host name, or
|
1877
|
+
# a `ToPhoneNumber` value matches the incoming SIP request.
|
1878
|
+
#
|
1879
|
+
# @option params [Boolean] :disabled
|
1880
|
+
# Enables or disables a rule. You must disable rules before you can
|
1881
|
+
# delete them.
|
1882
|
+
#
|
1883
|
+
# @option params [required, Array<Types::SipRuleTargetApplication>] :target_applications
|
1884
|
+
# List of SIP media applications with priority and AWS Region. Only one
|
1885
|
+
# SIP application per AWS Region can be used.
|
1886
|
+
#
|
1887
|
+
# @return [Types::CreateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1888
|
+
#
|
1889
|
+
# * {Types::CreateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
1890
|
+
#
|
1891
|
+
# @example Request syntax with placeholder values
|
1892
|
+
#
|
1893
|
+
# resp = client.create_sip_rule({
|
1894
|
+
# name: "SipRuleName", # required
|
1895
|
+
# trigger_type: "ToPhoneNumber", # required, accepts ToPhoneNumber, RequestUriHostname
|
1896
|
+
# trigger_value: "NonEmptyString", # required
|
1897
|
+
# disabled: false,
|
1898
|
+
# target_applications: [ # required
|
1899
|
+
# {
|
1900
|
+
# sip_media_application_id: "NonEmptyString",
|
1901
|
+
# priority: 1,
|
1902
|
+
# aws_region: "String",
|
1903
|
+
# },
|
1904
|
+
# ],
|
1905
|
+
# })
|
1906
|
+
#
|
1907
|
+
# @example Response structure
|
1908
|
+
#
|
1909
|
+
# resp.sip_rule.sip_rule_id #=> String
|
1910
|
+
# resp.sip_rule.name #=> String
|
1911
|
+
# resp.sip_rule.disabled #=> Boolean
|
1912
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
1913
|
+
# resp.sip_rule.trigger_value #=> String
|
1914
|
+
# resp.sip_rule.target_applications #=> Array
|
1915
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
1916
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
1917
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
1918
|
+
# resp.sip_rule.created_timestamp #=> Time
|
1919
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
1920
|
+
#
|
1921
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateSipRule AWS API Documentation
|
1922
|
+
#
|
1923
|
+
# @overload create_sip_rule(params = {})
|
1924
|
+
# @param [Hash] params ({})
|
1925
|
+
def create_sip_rule(params = {}, options = {})
|
1926
|
+
req = build_request(:create_sip_rule, params)
|
1927
|
+
req.send_request(options)
|
1928
|
+
end
|
1929
|
+
|
1930
|
+
# Creates a user under the specified Amazon Chime account.
|
1931
|
+
#
|
1932
|
+
# @option params [required, String] :account_id
|
1933
|
+
# The Amazon Chime account ID.
|
1934
|
+
#
|
1935
|
+
# @option params [String] :username
|
1936
|
+
# The user name.
|
1937
|
+
#
|
1938
|
+
# @option params [String] :email
|
1939
|
+
# The user's email address.
|
1940
|
+
#
|
1941
|
+
# @option params [String] :user_type
|
1942
|
+
# The user type.
|
1943
|
+
#
|
1944
|
+
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1945
|
+
#
|
1946
|
+
# * {Types::CreateUserResponse#user #user} => Types::User
|
1947
|
+
#
|
1948
|
+
# @example Request syntax with placeholder values
|
1949
|
+
#
|
1950
|
+
# resp = client.create_user({
|
1951
|
+
# account_id: "NonEmptyString", # required
|
1952
|
+
# username: "String",
|
1953
|
+
# email: "EmailAddress",
|
1954
|
+
# user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
|
1955
|
+
# })
|
1956
|
+
#
|
1957
|
+
# @example Response structure
|
1958
|
+
#
|
1959
|
+
# resp.user.user_id #=> String
|
1960
|
+
# resp.user.account_id #=> String
|
1961
|
+
# resp.user.primary_email #=> String
|
1962
|
+
# resp.user.primary_provisioned_number #=> String
|
1963
|
+
# resp.user.display_name #=> String
|
1964
|
+
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
1965
|
+
# resp.user.user_type #=> String, one of "PrivateUser", "SharedDevice"
|
1966
|
+
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
1967
|
+
# resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
1968
|
+
# resp.user.registered_on #=> Time
|
1969
|
+
# resp.user.invited_on #=> Time
|
1970
|
+
# resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
|
1971
|
+
# resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
|
1972
|
+
# resp.user.personal_pin #=> String
|
1973
|
+
#
|
1974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateUser AWS API Documentation
|
1975
|
+
#
|
1976
|
+
# @overload create_user(params = {})
|
1977
|
+
# @param [Hash] params ({})
|
1978
|
+
def create_user(params = {}, options = {})
|
1979
|
+
req = build_request(:create_user, params)
|
1980
|
+
req.send_request(options)
|
1981
|
+
end
|
1982
|
+
|
1983
|
+
# Creates an Amazon Chime Voice Connector under the administrator's AWS
|
1984
|
+
# account. You can choose to create an Amazon Chime Voice Connector in a
|
1985
|
+
# specific AWS Region.
|
1986
|
+
#
|
1987
|
+
# Enabling CreateVoiceConnectorRequest$RequireEncryption configures your
|
1988
|
+
# Amazon Chime Voice Connector to use TLS transport for SIP signaling
|
1989
|
+
# and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and
|
1990
|
+
# unencrypted outbound calls are blocked.
|
1407
1991
|
#
|
1408
1992
|
# @option params [required, String] :name
|
1409
1993
|
# The name of the Amazon Chime Voice Connector.
|
@@ -1532,6 +2116,99 @@ module Aws::Chime
|
|
1532
2116
|
req.send_request(options)
|
1533
2117
|
end
|
1534
2118
|
|
2119
|
+
# Deletes an `AppInstance` and all associated data asynchronously.
|
2120
|
+
#
|
2121
|
+
# @option params [required, String] :app_instance_arn
|
2122
|
+
# The ARN of the app instance.
|
2123
|
+
#
|
2124
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2125
|
+
#
|
2126
|
+
# @example Request syntax with placeholder values
|
2127
|
+
#
|
2128
|
+
# resp = client.delete_app_instance({
|
2129
|
+
# app_instance_arn: "ChimeArn", # required
|
2130
|
+
# })
|
2131
|
+
#
|
2132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstance AWS API Documentation
|
2133
|
+
#
|
2134
|
+
# @overload delete_app_instance(params = {})
|
2135
|
+
# @param [Hash] params ({})
|
2136
|
+
def delete_app_instance(params = {}, options = {})
|
2137
|
+
req = build_request(:delete_app_instance, params)
|
2138
|
+
req.send_request(options)
|
2139
|
+
end
|
2140
|
+
|
2141
|
+
# Demotes an `AppInstanceAdmin` to an `AppInstanceUser`. This action
|
2142
|
+
# does not delete the user.
|
2143
|
+
#
|
2144
|
+
# @option params [required, String] :app_instance_admin_arn
|
2145
|
+
# The ARN of the app instance's administrator.
|
2146
|
+
#
|
2147
|
+
# @option params [required, String] :app_instance_arn
|
2148
|
+
# The ARN of the app instance.
|
2149
|
+
#
|
2150
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2151
|
+
#
|
2152
|
+
# @example Request syntax with placeholder values
|
2153
|
+
#
|
2154
|
+
# resp = client.delete_app_instance_admin({
|
2155
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
2156
|
+
# app_instance_arn: "ChimeArn", # required
|
2157
|
+
# })
|
2158
|
+
#
|
2159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceAdmin AWS API Documentation
|
2160
|
+
#
|
2161
|
+
# @overload delete_app_instance_admin(params = {})
|
2162
|
+
# @param [Hash] params ({})
|
2163
|
+
def delete_app_instance_admin(params = {}, options = {})
|
2164
|
+
req = build_request(:delete_app_instance_admin, params)
|
2165
|
+
req.send_request(options)
|
2166
|
+
end
|
2167
|
+
|
2168
|
+
# Deletes the streaming configurations of an app instance.
|
2169
|
+
#
|
2170
|
+
# @option params [required, String] :app_instance_arn
|
2171
|
+
# The ARN of the streaming configurations being deleted.
|
2172
|
+
#
|
2173
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2174
|
+
#
|
2175
|
+
# @example Request syntax with placeholder values
|
2176
|
+
#
|
2177
|
+
# resp = client.delete_app_instance_streaming_configurations({
|
2178
|
+
# app_instance_arn: "ChimeArn", # required
|
2179
|
+
# })
|
2180
|
+
#
|
2181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceStreamingConfigurations AWS API Documentation
|
2182
|
+
#
|
2183
|
+
# @overload delete_app_instance_streaming_configurations(params = {})
|
2184
|
+
# @param [Hash] params ({})
|
2185
|
+
def delete_app_instance_streaming_configurations(params = {}, options = {})
|
2186
|
+
req = build_request(:delete_app_instance_streaming_configurations, params)
|
2187
|
+
req.send_request(options)
|
2188
|
+
end
|
2189
|
+
|
2190
|
+
# Deletes an `AppInstanceUser`.
|
2191
|
+
#
|
2192
|
+
# @option params [required, String] :app_instance_user_arn
|
2193
|
+
# The ARN of the user request being deleted.
|
2194
|
+
#
|
2195
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2196
|
+
#
|
2197
|
+
# @example Request syntax with placeholder values
|
2198
|
+
#
|
2199
|
+
# resp = client.delete_app_instance_user({
|
2200
|
+
# app_instance_user_arn: "ChimeArn", # required
|
2201
|
+
# })
|
2202
|
+
#
|
2203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceUser AWS API Documentation
|
2204
|
+
#
|
2205
|
+
# @overload delete_app_instance_user(params = {})
|
2206
|
+
# @param [Hash] params ({})
|
2207
|
+
def delete_app_instance_user(params = {}, options = {})
|
2208
|
+
req = build_request(:delete_app_instance_user, params)
|
2209
|
+
req.send_request(options)
|
2210
|
+
end
|
2211
|
+
|
1535
2212
|
# Deletes an attendee from the specified Amazon Chime SDK meeting and
|
1536
2213
|
# deletes their `JoinToken`. Attendees are automatically deleted when a
|
1537
2214
|
# Amazon Chime SDK meeting is deleted. For more information about the
|
@@ -1566,6 +2243,135 @@ module Aws::Chime
|
|
1566
2243
|
req.send_request(options)
|
1567
2244
|
end
|
1568
2245
|
|
2246
|
+
# Immediately makes a channel and its memberships inaccessible and marks
|
2247
|
+
# them for deletion. This is an irreversible process.
|
2248
|
+
#
|
2249
|
+
# @option params [required, String] :channel_arn
|
2250
|
+
# The ARN of the channel being deleted.
|
2251
|
+
#
|
2252
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2253
|
+
#
|
2254
|
+
# @example Request syntax with placeholder values
|
2255
|
+
#
|
2256
|
+
# resp = client.delete_channel({
|
2257
|
+
# channel_arn: "ChimeArn", # required
|
2258
|
+
# })
|
2259
|
+
#
|
2260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannel AWS API Documentation
|
2261
|
+
#
|
2262
|
+
# @overload delete_channel(params = {})
|
2263
|
+
# @param [Hash] params ({})
|
2264
|
+
def delete_channel(params = {}, options = {})
|
2265
|
+
req = build_request(:delete_channel, params)
|
2266
|
+
req.send_request(options)
|
2267
|
+
end
|
2268
|
+
|
2269
|
+
# Removes a user from a channel's ban list.
|
2270
|
+
#
|
2271
|
+
# @option params [required, String] :channel_arn
|
2272
|
+
# The ARN of the channel from which the app instance user was banned.
|
2273
|
+
#
|
2274
|
+
# @option params [required, String] :member_arn
|
2275
|
+
# The ARN of the app instance user that you want to reinstate.
|
2276
|
+
#
|
2277
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2278
|
+
#
|
2279
|
+
# @example Request syntax with placeholder values
|
2280
|
+
#
|
2281
|
+
# resp = client.delete_channel_ban({
|
2282
|
+
# channel_arn: "ChimeArn", # required
|
2283
|
+
# member_arn: "ChimeArn", # required
|
2284
|
+
# })
|
2285
|
+
#
|
2286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelBan AWS API Documentation
|
2287
|
+
#
|
2288
|
+
# @overload delete_channel_ban(params = {})
|
2289
|
+
# @param [Hash] params ({})
|
2290
|
+
def delete_channel_ban(params = {}, options = {})
|
2291
|
+
req = build_request(:delete_channel_ban, params)
|
2292
|
+
req.send_request(options)
|
2293
|
+
end
|
2294
|
+
|
2295
|
+
# Removes a member from a channel.
|
2296
|
+
#
|
2297
|
+
# @option params [required, String] :channel_arn
|
2298
|
+
# The ARN of the channel from which you want to remove the user.
|
2299
|
+
#
|
2300
|
+
# @option params [required, String] :member_arn
|
2301
|
+
# The ARN of the member that you're removing from the channel.
|
2302
|
+
#
|
2303
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2304
|
+
#
|
2305
|
+
# @example Request syntax with placeholder values
|
2306
|
+
#
|
2307
|
+
# resp = client.delete_channel_membership({
|
2308
|
+
# channel_arn: "ChimeArn", # required
|
2309
|
+
# member_arn: "ChimeArn", # required
|
2310
|
+
# })
|
2311
|
+
#
|
2312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMembership AWS API Documentation
|
2313
|
+
#
|
2314
|
+
# @overload delete_channel_membership(params = {})
|
2315
|
+
# @param [Hash] params ({})
|
2316
|
+
def delete_channel_membership(params = {}, options = {})
|
2317
|
+
req = build_request(:delete_channel_membership, params)
|
2318
|
+
req.send_request(options)
|
2319
|
+
end
|
2320
|
+
|
2321
|
+
# Deletes a channel message. Only admins can perform this action.
|
2322
|
+
# Deletion makes messages inaccessible immediately. A background process
|
2323
|
+
# deletes any revisions created by `UpdateChannelMessage`.
|
2324
|
+
#
|
2325
|
+
# @option params [required, String] :channel_arn
|
2326
|
+
# The ARN of the channel.
|
2327
|
+
#
|
2328
|
+
# @option params [required, String] :message_id
|
2329
|
+
# The ID of the message being deleted.
|
2330
|
+
#
|
2331
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2332
|
+
#
|
2333
|
+
# @example Request syntax with placeholder values
|
2334
|
+
#
|
2335
|
+
# resp = client.delete_channel_message({
|
2336
|
+
# channel_arn: "ChimeArn", # required
|
2337
|
+
# message_id: "MessageId", # required
|
2338
|
+
# })
|
2339
|
+
#
|
2340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMessage AWS API Documentation
|
2341
|
+
#
|
2342
|
+
# @overload delete_channel_message(params = {})
|
2343
|
+
# @param [Hash] params ({})
|
2344
|
+
def delete_channel_message(params = {}, options = {})
|
2345
|
+
req = build_request(:delete_channel_message, params)
|
2346
|
+
req.send_request(options)
|
2347
|
+
end
|
2348
|
+
|
2349
|
+
# Deletes a channel moderator.
|
2350
|
+
#
|
2351
|
+
# @option params [required, String] :channel_arn
|
2352
|
+
# The ARN of the channel.
|
2353
|
+
#
|
2354
|
+
# @option params [required, String] :channel_moderator_arn
|
2355
|
+
# The ARN of the moderator being deleted.
|
2356
|
+
#
|
2357
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2358
|
+
#
|
2359
|
+
# @example Request syntax with placeholder values
|
2360
|
+
#
|
2361
|
+
# resp = client.delete_channel_moderator({
|
2362
|
+
# channel_arn: "ChimeArn", # required
|
2363
|
+
# channel_moderator_arn: "ChimeArn", # required
|
2364
|
+
# })
|
2365
|
+
#
|
2366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelModerator AWS API Documentation
|
2367
|
+
#
|
2368
|
+
# @overload delete_channel_moderator(params = {})
|
2369
|
+
# @param [Hash] params ({})
|
2370
|
+
def delete_channel_moderator(params = {}, options = {})
|
2371
|
+
req = build_request(:delete_channel_moderator, params)
|
2372
|
+
req.send_request(options)
|
2373
|
+
end
|
2374
|
+
|
1569
2375
|
# Deletes the events configuration that allows a bot to receive outgoing
|
1570
2376
|
# events.
|
1571
2377
|
#
|
@@ -1733,6 +2539,51 @@ module Aws::Chime
|
|
1733
2539
|
req.send_request(options)
|
1734
2540
|
end
|
1735
2541
|
|
2542
|
+
# Deletes a SIP media application.
|
2543
|
+
#
|
2544
|
+
# @option params [required, String] :sip_media_application_id
|
2545
|
+
# The SIP media application ID.
|
2546
|
+
#
|
2547
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2548
|
+
#
|
2549
|
+
# @example Request syntax with placeholder values
|
2550
|
+
#
|
2551
|
+
# resp = client.delete_sip_media_application({
|
2552
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2553
|
+
# })
|
2554
|
+
#
|
2555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipMediaApplication AWS API Documentation
|
2556
|
+
#
|
2557
|
+
# @overload delete_sip_media_application(params = {})
|
2558
|
+
# @param [Hash] params ({})
|
2559
|
+
def delete_sip_media_application(params = {}, options = {})
|
2560
|
+
req = build_request(:delete_sip_media_application, params)
|
2561
|
+
req.send_request(options)
|
2562
|
+
end
|
2563
|
+
|
2564
|
+
# Deletes a SIP rule. You must disable a SIP rule before you can delete
|
2565
|
+
# it.
|
2566
|
+
#
|
2567
|
+
# @option params [required, String] :sip_rule_id
|
2568
|
+
# The SIP rule ID.
|
2569
|
+
#
|
2570
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2571
|
+
#
|
2572
|
+
# @example Request syntax with placeholder values
|
2573
|
+
#
|
2574
|
+
# resp = client.delete_sip_rule({
|
2575
|
+
# sip_rule_id: "NonEmptyString", # required
|
2576
|
+
# })
|
2577
|
+
#
|
2578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteSipRule AWS API Documentation
|
2579
|
+
#
|
2580
|
+
# @overload delete_sip_rule(params = {})
|
2581
|
+
# @param [Hash] params ({})
|
2582
|
+
def delete_sip_rule(params = {}, options = {})
|
2583
|
+
req = build_request(:delete_sip_rule, params)
|
2584
|
+
req.send_request(options)
|
2585
|
+
end
|
2586
|
+
|
1736
2587
|
# Deletes the specified Amazon Chime Voice Connector. Any phone numbers
|
1737
2588
|
# associated with the Amazon Chime Voice Connector must be disassociated
|
1738
2589
|
# from it before it can be deleted.
|
@@ -1936,16 +2787,343 @@ module Aws::Chime
|
|
1936
2787
|
req.send_request(options)
|
1937
2788
|
end
|
1938
2789
|
|
1939
|
-
#
|
1940
|
-
# Amazon Chime user.
|
2790
|
+
# Returns the full details of an `AppInstance`.
|
1941
2791
|
#
|
1942
|
-
# @option params [required, String] :
|
1943
|
-
# The
|
2792
|
+
# @option params [required, String] :app_instance_arn
|
2793
|
+
# The ARN of the app instance.
|
1944
2794
|
#
|
1945
|
-
# @
|
1946
|
-
# The user ID.
|
2795
|
+
# @return [Types::DescribeAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1947
2796
|
#
|
1948
|
-
#
|
2797
|
+
# * {Types::DescribeAppInstanceResponse#app_instance #app_instance} => Types::AppInstance
|
2798
|
+
#
|
2799
|
+
# @example Request syntax with placeholder values
|
2800
|
+
#
|
2801
|
+
# resp = client.describe_app_instance({
|
2802
|
+
# app_instance_arn: "ChimeArn", # required
|
2803
|
+
# })
|
2804
|
+
#
|
2805
|
+
# @example Response structure
|
2806
|
+
#
|
2807
|
+
# resp.app_instance.app_instance_arn #=> String
|
2808
|
+
# resp.app_instance.name #=> String
|
2809
|
+
# resp.app_instance.metadata #=> String
|
2810
|
+
# resp.app_instance.created_timestamp #=> Time
|
2811
|
+
# resp.app_instance.last_updated_timestamp #=> Time
|
2812
|
+
#
|
2813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstance AWS API Documentation
|
2814
|
+
#
|
2815
|
+
# @overload describe_app_instance(params = {})
|
2816
|
+
# @param [Hash] params ({})
|
2817
|
+
def describe_app_instance(params = {}, options = {})
|
2818
|
+
req = build_request(:describe_app_instance, params)
|
2819
|
+
req.send_request(options)
|
2820
|
+
end
|
2821
|
+
|
2822
|
+
# Returns the full details of an `AppInstanceAdmin`.
|
2823
|
+
#
|
2824
|
+
# @option params [required, String] :app_instance_admin_arn
|
2825
|
+
# The ARN of the app instance administrator.
|
2826
|
+
#
|
2827
|
+
# @option params [required, String] :app_instance_arn
|
2828
|
+
# The ARN of the app instance.
|
2829
|
+
#
|
2830
|
+
# @return [Types::DescribeAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2831
|
+
#
|
2832
|
+
# * {Types::DescribeAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::AppInstanceAdmin
|
2833
|
+
#
|
2834
|
+
# @example Request syntax with placeholder values
|
2835
|
+
#
|
2836
|
+
# resp = client.describe_app_instance_admin({
|
2837
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
2838
|
+
# app_instance_arn: "ChimeArn", # required
|
2839
|
+
# })
|
2840
|
+
#
|
2841
|
+
# @example Response structure
|
2842
|
+
#
|
2843
|
+
# resp.app_instance_admin.admin.arn #=> String
|
2844
|
+
# resp.app_instance_admin.admin.name #=> String
|
2845
|
+
# resp.app_instance_admin.app_instance_arn #=> String
|
2846
|
+
# resp.app_instance_admin.created_timestamp #=> Time
|
2847
|
+
#
|
2848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstanceAdmin AWS API Documentation
|
2849
|
+
#
|
2850
|
+
# @overload describe_app_instance_admin(params = {})
|
2851
|
+
# @param [Hash] params ({})
|
2852
|
+
def describe_app_instance_admin(params = {}, options = {})
|
2853
|
+
req = build_request(:describe_app_instance_admin, params)
|
2854
|
+
req.send_request(options)
|
2855
|
+
end
|
2856
|
+
|
2857
|
+
# Returns the full details of an `AppInstanceUser`.
|
2858
|
+
#
|
2859
|
+
# @option params [required, String] :app_instance_user_arn
|
2860
|
+
# The ARN of the app instance user.
|
2861
|
+
#
|
2862
|
+
# @return [Types::DescribeAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2863
|
+
#
|
2864
|
+
# * {Types::DescribeAppInstanceUserResponse#app_instance_user #app_instance_user} => Types::AppInstanceUser
|
2865
|
+
#
|
2866
|
+
# @example Request syntax with placeholder values
|
2867
|
+
#
|
2868
|
+
# resp = client.describe_app_instance_user({
|
2869
|
+
# app_instance_user_arn: "ChimeArn", # required
|
2870
|
+
# })
|
2871
|
+
#
|
2872
|
+
# @example Response structure
|
2873
|
+
#
|
2874
|
+
# resp.app_instance_user.app_instance_user_arn #=> String
|
2875
|
+
# resp.app_instance_user.name #=> String
|
2876
|
+
# resp.app_instance_user.created_timestamp #=> Time
|
2877
|
+
# resp.app_instance_user.metadata #=> String
|
2878
|
+
# resp.app_instance_user.last_updated_timestamp #=> Time
|
2879
|
+
#
|
2880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstanceUser AWS API Documentation
|
2881
|
+
#
|
2882
|
+
# @overload describe_app_instance_user(params = {})
|
2883
|
+
# @param [Hash] params ({})
|
2884
|
+
def describe_app_instance_user(params = {}, options = {})
|
2885
|
+
req = build_request(:describe_app_instance_user, params)
|
2886
|
+
req.send_request(options)
|
2887
|
+
end
|
2888
|
+
|
2889
|
+
# Returns the full details of a channel in an Amazon Chime app instance.
|
2890
|
+
#
|
2891
|
+
# @option params [required, String] :channel_arn
|
2892
|
+
# The ARN of the channel.
|
2893
|
+
#
|
2894
|
+
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2895
|
+
#
|
2896
|
+
# * {Types::DescribeChannelResponse#channel #channel} => Types::Channel
|
2897
|
+
#
|
2898
|
+
# @example Request syntax with placeholder values
|
2899
|
+
#
|
2900
|
+
# resp = client.describe_channel({
|
2901
|
+
# channel_arn: "ChimeArn", # required
|
2902
|
+
# })
|
2903
|
+
#
|
2904
|
+
# @example Response structure
|
2905
|
+
#
|
2906
|
+
# resp.channel.name #=> String
|
2907
|
+
# resp.channel.channel_arn #=> String
|
2908
|
+
# resp.channel.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
2909
|
+
# resp.channel.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
2910
|
+
# resp.channel.metadata #=> String
|
2911
|
+
# resp.channel.created_by.arn #=> String
|
2912
|
+
# resp.channel.created_by.name #=> String
|
2913
|
+
# resp.channel.created_timestamp #=> Time
|
2914
|
+
# resp.channel.last_message_timestamp #=> Time
|
2915
|
+
# resp.channel.last_updated_timestamp #=> Time
|
2916
|
+
#
|
2917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannel AWS API Documentation
|
2918
|
+
#
|
2919
|
+
# @overload describe_channel(params = {})
|
2920
|
+
# @param [Hash] params ({})
|
2921
|
+
def describe_channel(params = {}, options = {})
|
2922
|
+
req = build_request(:describe_channel, params)
|
2923
|
+
req.send_request(options)
|
2924
|
+
end
|
2925
|
+
|
2926
|
+
# Returns the full details of a channel ban.
|
2927
|
+
#
|
2928
|
+
# @option params [required, String] :channel_arn
|
2929
|
+
# The ARN of the channel from which the user is banned.
|
2930
|
+
#
|
2931
|
+
# @option params [required, String] :member_arn
|
2932
|
+
# The ARN of the member being banned.
|
2933
|
+
#
|
2934
|
+
# @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2935
|
+
#
|
2936
|
+
# * {Types::DescribeChannelBanResponse#channel_ban #channel_ban} => Types::ChannelBan
|
2937
|
+
#
|
2938
|
+
# @example Request syntax with placeholder values
|
2939
|
+
#
|
2940
|
+
# resp = client.describe_channel_ban({
|
2941
|
+
# channel_arn: "ChimeArn", # required
|
2942
|
+
# member_arn: "ChimeArn", # required
|
2943
|
+
# })
|
2944
|
+
#
|
2945
|
+
# @example Response structure
|
2946
|
+
#
|
2947
|
+
# resp.channel_ban.member.arn #=> String
|
2948
|
+
# resp.channel_ban.member.name #=> String
|
2949
|
+
# resp.channel_ban.channel_arn #=> String
|
2950
|
+
# resp.channel_ban.created_timestamp #=> Time
|
2951
|
+
# resp.channel_ban.created_by.arn #=> String
|
2952
|
+
# resp.channel_ban.created_by.name #=> String
|
2953
|
+
#
|
2954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelBan AWS API Documentation
|
2955
|
+
#
|
2956
|
+
# @overload describe_channel_ban(params = {})
|
2957
|
+
# @param [Hash] params ({})
|
2958
|
+
def describe_channel_ban(params = {}, options = {})
|
2959
|
+
req = build_request(:describe_channel_ban, params)
|
2960
|
+
req.send_request(options)
|
2961
|
+
end
|
2962
|
+
|
2963
|
+
# Returns the full details of a user's channel membership.
|
2964
|
+
#
|
2965
|
+
# @option params [required, String] :channel_arn
|
2966
|
+
# The ARN of the channel.
|
2967
|
+
#
|
2968
|
+
# @option params [required, String] :member_arn
|
2969
|
+
# The ARN of the member.
|
2970
|
+
#
|
2971
|
+
# @return [Types::DescribeChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2972
|
+
#
|
2973
|
+
# * {Types::DescribeChannelMembershipResponse#channel_membership #channel_membership} => Types::ChannelMembership
|
2974
|
+
#
|
2975
|
+
# @example Request syntax with placeholder values
|
2976
|
+
#
|
2977
|
+
# resp = client.describe_channel_membership({
|
2978
|
+
# channel_arn: "ChimeArn", # required
|
2979
|
+
# member_arn: "ChimeArn", # required
|
2980
|
+
# })
|
2981
|
+
#
|
2982
|
+
# @example Response structure
|
2983
|
+
#
|
2984
|
+
# resp.channel_membership.invited_by.arn #=> String
|
2985
|
+
# resp.channel_membership.invited_by.name #=> String
|
2986
|
+
# resp.channel_membership.type #=> String, one of "DEFAULT", "HIDDEN"
|
2987
|
+
# resp.channel_membership.member.arn #=> String
|
2988
|
+
# resp.channel_membership.member.name #=> String
|
2989
|
+
# resp.channel_membership.channel_arn #=> String
|
2990
|
+
# resp.channel_membership.created_timestamp #=> Time
|
2991
|
+
# resp.channel_membership.last_updated_timestamp #=> Time
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelMembership AWS API Documentation
|
2994
|
+
#
|
2995
|
+
# @overload describe_channel_membership(params = {})
|
2996
|
+
# @param [Hash] params ({})
|
2997
|
+
def describe_channel_membership(params = {}, options = {})
|
2998
|
+
req = build_request(:describe_channel_membership, params)
|
2999
|
+
req.send_request(options)
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# Returns the details of a channel based on the membership of the
|
3003
|
+
# `AppInstanceUser` specified.
|
3004
|
+
#
|
3005
|
+
# @option params [required, String] :channel_arn
|
3006
|
+
# The ARN of the channel to which the user belongs.
|
3007
|
+
#
|
3008
|
+
# @option params [required, String] :app_instance_user_arn
|
3009
|
+
# The ARN of the user in a channel.
|
3010
|
+
#
|
3011
|
+
# @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3012
|
+
#
|
3013
|
+
# * {Types::DescribeChannelMembershipForAppInstanceUserResponse#channel_membership #channel_membership} => Types::ChannelMembershipForAppInstanceUserSummary
|
3014
|
+
#
|
3015
|
+
# @example Request syntax with placeholder values
|
3016
|
+
#
|
3017
|
+
# resp = client.describe_channel_membership_for_app_instance_user({
|
3018
|
+
# channel_arn: "ChimeArn", # required
|
3019
|
+
# app_instance_user_arn: "ChimeArn", # required
|
3020
|
+
# })
|
3021
|
+
#
|
3022
|
+
# @example Response structure
|
3023
|
+
#
|
3024
|
+
# resp.channel_membership.channel_summary.name #=> String
|
3025
|
+
# resp.channel_membership.channel_summary.channel_arn #=> String
|
3026
|
+
# resp.channel_membership.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
3027
|
+
# resp.channel_membership.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
3028
|
+
# resp.channel_membership.channel_summary.metadata #=> String
|
3029
|
+
# resp.channel_membership.channel_summary.last_message_timestamp #=> Time
|
3030
|
+
# resp.channel_membership.app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
3031
|
+
# resp.channel_membership.app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
3032
|
+
#
|
3033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelMembershipForAppInstanceUser AWS API Documentation
|
3034
|
+
#
|
3035
|
+
# @overload describe_channel_membership_for_app_instance_user(params = {})
|
3036
|
+
# @param [Hash] params ({})
|
3037
|
+
def describe_channel_membership_for_app_instance_user(params = {}, options = {})
|
3038
|
+
req = build_request(:describe_channel_membership_for_app_instance_user, params)
|
3039
|
+
req.send_request(options)
|
3040
|
+
end
|
3041
|
+
|
3042
|
+
# Returns the full details of a channel moderated by the specified
|
3043
|
+
# `AppInstanceUser`.
|
3044
|
+
#
|
3045
|
+
# @option params [required, String] :channel_arn
|
3046
|
+
# The ARN of the moderated channel.
|
3047
|
+
#
|
3048
|
+
# @option params [required, String] :app_instance_user_arn
|
3049
|
+
# The ARN of the app instance user in the moderated channel.
|
3050
|
+
#
|
3051
|
+
# @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3052
|
+
#
|
3053
|
+
# * {Types::DescribeChannelModeratedByAppInstanceUserResponse#channel #channel} => Types::ChannelModeratedByAppInstanceUserSummary
|
3054
|
+
#
|
3055
|
+
# @example Request syntax with placeholder values
|
3056
|
+
#
|
3057
|
+
# resp = client.describe_channel_moderated_by_app_instance_user({
|
3058
|
+
# channel_arn: "ChimeArn", # required
|
3059
|
+
# app_instance_user_arn: "ChimeArn", # required
|
3060
|
+
# })
|
3061
|
+
#
|
3062
|
+
# @example Response structure
|
3063
|
+
#
|
3064
|
+
# resp.channel.channel_summary.name #=> String
|
3065
|
+
# resp.channel.channel_summary.channel_arn #=> String
|
3066
|
+
# resp.channel.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
3067
|
+
# resp.channel.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
3068
|
+
# resp.channel.channel_summary.metadata #=> String
|
3069
|
+
# resp.channel.channel_summary.last_message_timestamp #=> Time
|
3070
|
+
#
|
3071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelModeratedByAppInstanceUser AWS API Documentation
|
3072
|
+
#
|
3073
|
+
# @overload describe_channel_moderated_by_app_instance_user(params = {})
|
3074
|
+
# @param [Hash] params ({})
|
3075
|
+
def describe_channel_moderated_by_app_instance_user(params = {}, options = {})
|
3076
|
+
req = build_request(:describe_channel_moderated_by_app_instance_user, params)
|
3077
|
+
req.send_request(options)
|
3078
|
+
end
|
3079
|
+
|
3080
|
+
# Returns the full details of a single ChannelModerator.
|
3081
|
+
#
|
3082
|
+
# @option params [required, String] :channel_arn
|
3083
|
+
# The ARN of the channel.
|
3084
|
+
#
|
3085
|
+
# @option params [required, String] :channel_moderator_arn
|
3086
|
+
# The ARN of the channel moderator.
|
3087
|
+
#
|
3088
|
+
# @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3089
|
+
#
|
3090
|
+
# * {Types::DescribeChannelModeratorResponse#channel_moderator #channel_moderator} => Types::ChannelModerator
|
3091
|
+
#
|
3092
|
+
# @example Request syntax with placeholder values
|
3093
|
+
#
|
3094
|
+
# resp = client.describe_channel_moderator({
|
3095
|
+
# channel_arn: "ChimeArn", # required
|
3096
|
+
# channel_moderator_arn: "ChimeArn", # required
|
3097
|
+
# })
|
3098
|
+
#
|
3099
|
+
# @example Response structure
|
3100
|
+
#
|
3101
|
+
# resp.channel_moderator.moderator.arn #=> String
|
3102
|
+
# resp.channel_moderator.moderator.name #=> String
|
3103
|
+
# resp.channel_moderator.channel_arn #=> String
|
3104
|
+
# resp.channel_moderator.created_timestamp #=> Time
|
3105
|
+
# resp.channel_moderator.created_by.arn #=> String
|
3106
|
+
# resp.channel_moderator.created_by.name #=> String
|
3107
|
+
#
|
3108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelModerator AWS API Documentation
|
3109
|
+
#
|
3110
|
+
# @overload describe_channel_moderator(params = {})
|
3111
|
+
# @param [Hash] params ({})
|
3112
|
+
def describe_channel_moderator(params = {}, options = {})
|
3113
|
+
req = build_request(:describe_channel_moderator, params)
|
3114
|
+
req.send_request(options)
|
3115
|
+
end
|
3116
|
+
|
3117
|
+
# Disassociates the primary provisioned phone number from the specified
|
3118
|
+
# Amazon Chime user.
|
3119
|
+
#
|
3120
|
+
# @option params [required, String] :account_id
|
3121
|
+
# The Amazon Chime account ID.
|
3122
|
+
#
|
3123
|
+
# @option params [required, String] :user_id
|
3124
|
+
# The user ID.
|
3125
|
+
#
|
3126
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1949
3127
|
#
|
1950
3128
|
# @example Request syntax with placeholder values
|
1951
3129
|
#
|
@@ -2136,6 +3314,66 @@ module Aws::Chime
|
|
2136
3314
|
req.send_request(options)
|
2137
3315
|
end
|
2138
3316
|
|
3317
|
+
# Gets the retention settings for an app instance.
|
3318
|
+
#
|
3319
|
+
# @option params [required, String] :app_instance_arn
|
3320
|
+
# The ARN of the app instance.
|
3321
|
+
#
|
3322
|
+
# @return [Types::GetAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3323
|
+
#
|
3324
|
+
# * {Types::GetAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
|
3325
|
+
# * {Types::GetAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
|
3326
|
+
#
|
3327
|
+
# @example Request syntax with placeholder values
|
3328
|
+
#
|
3329
|
+
# resp = client.get_app_instance_retention_settings({
|
3330
|
+
# app_instance_arn: "ChimeArn", # required
|
3331
|
+
# })
|
3332
|
+
#
|
3333
|
+
# @example Response structure
|
3334
|
+
#
|
3335
|
+
# resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
|
3336
|
+
# resp.initiate_deletion_timestamp #=> Time
|
3337
|
+
#
|
3338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAppInstanceRetentionSettings AWS API Documentation
|
3339
|
+
#
|
3340
|
+
# @overload get_app_instance_retention_settings(params = {})
|
3341
|
+
# @param [Hash] params ({})
|
3342
|
+
def get_app_instance_retention_settings(params = {}, options = {})
|
3343
|
+
req = build_request(:get_app_instance_retention_settings, params)
|
3344
|
+
req.send_request(options)
|
3345
|
+
end
|
3346
|
+
|
3347
|
+
# Gets the streaming settings for an app instance.
|
3348
|
+
#
|
3349
|
+
# @option params [required, String] :app_instance_arn
|
3350
|
+
# The ARN of the app instance.
|
3351
|
+
#
|
3352
|
+
# @return [Types::GetAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3353
|
+
#
|
3354
|
+
# * {Types::GetAppInstanceStreamingConfigurationsResponse#app_instance_streaming_configurations #app_instance_streaming_configurations} => Array<Types::AppInstanceStreamingConfiguration>
|
3355
|
+
#
|
3356
|
+
# @example Request syntax with placeholder values
|
3357
|
+
#
|
3358
|
+
# resp = client.get_app_instance_streaming_configurations({
|
3359
|
+
# app_instance_arn: "ChimeArn", # required
|
3360
|
+
# })
|
3361
|
+
#
|
3362
|
+
# @example Response structure
|
3363
|
+
#
|
3364
|
+
# resp.app_instance_streaming_configurations #=> Array
|
3365
|
+
# resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
|
3366
|
+
# resp.app_instance_streaming_configurations[0].resource_arn #=> String
|
3367
|
+
#
|
3368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAppInstanceStreamingConfigurations AWS API Documentation
|
3369
|
+
#
|
3370
|
+
# @overload get_app_instance_streaming_configurations(params = {})
|
3371
|
+
# @param [Hash] params ({})
|
3372
|
+
def get_app_instance_streaming_configurations(params = {}, options = {})
|
3373
|
+
req = build_request(:get_app_instance_streaming_configurations, params)
|
3374
|
+
req.send_request(options)
|
3375
|
+
end
|
3376
|
+
|
2139
3377
|
# Gets the Amazon Chime SDK attendee details for a specified meeting ID
|
2140
3378
|
# and attendee ID. For more information about the Amazon Chime SDK, see
|
2141
3379
|
# [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
@@ -2217,6 +3455,49 @@ module Aws::Chime
|
|
2217
3455
|
req.send_request(options)
|
2218
3456
|
end
|
2219
3457
|
|
3458
|
+
# Gets the full details of a channel message.
|
3459
|
+
#
|
3460
|
+
# @option params [required, String] :channel_arn
|
3461
|
+
# The ARN of the channel.
|
3462
|
+
#
|
3463
|
+
# @option params [required, String] :message_id
|
3464
|
+
# The ID of the message.
|
3465
|
+
#
|
3466
|
+
# @return [Types::GetChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3467
|
+
#
|
3468
|
+
# * {Types::GetChannelMessageResponse#channel_message #channel_message} => Types::ChannelMessage
|
3469
|
+
#
|
3470
|
+
# @example Request syntax with placeholder values
|
3471
|
+
#
|
3472
|
+
# resp = client.get_channel_message({
|
3473
|
+
# channel_arn: "ChimeArn", # required
|
3474
|
+
# message_id: "MessageId", # required
|
3475
|
+
# })
|
3476
|
+
#
|
3477
|
+
# @example Response structure
|
3478
|
+
#
|
3479
|
+
# resp.channel_message.channel_arn #=> String
|
3480
|
+
# resp.channel_message.message_id #=> String
|
3481
|
+
# resp.channel_message.content #=> String
|
3482
|
+
# resp.channel_message.metadata #=> String
|
3483
|
+
# resp.channel_message.type #=> String, one of "STANDARD", "CONTROL"
|
3484
|
+
# resp.channel_message.created_timestamp #=> Time
|
3485
|
+
# resp.channel_message.last_edited_timestamp #=> Time
|
3486
|
+
# resp.channel_message.last_updated_timestamp #=> Time
|
3487
|
+
# resp.channel_message.sender.arn #=> String
|
3488
|
+
# resp.channel_message.sender.name #=> String
|
3489
|
+
# resp.channel_message.redacted #=> Boolean
|
3490
|
+
# resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"
|
3491
|
+
#
|
3492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetChannelMessage AWS API Documentation
|
3493
|
+
#
|
3494
|
+
# @overload get_channel_message(params = {})
|
3495
|
+
# @param [Hash] params ({})
|
3496
|
+
def get_channel_message(params = {}, options = {})
|
3497
|
+
req = build_request(:get_channel_message, params)
|
3498
|
+
req.send_request(options)
|
3499
|
+
end
|
3500
|
+
|
2220
3501
|
# Gets details for an events configuration that allows a bot to receive
|
2221
3502
|
# outgoing events, such as an HTTPS endpoint or Lambda function ARN.
|
2222
3503
|
#
|
@@ -2318,6 +3599,25 @@ module Aws::Chime
|
|
2318
3599
|
req.send_request(options)
|
2319
3600
|
end
|
2320
3601
|
|
3602
|
+
# The endpoint for the messaging session.
|
3603
|
+
#
|
3604
|
+
# @return [Types::GetMessagingSessionEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3605
|
+
#
|
3606
|
+
# * {Types::GetMessagingSessionEndpointResponse#endpoint #endpoint} => Types::MessagingSessionEndpoint
|
3607
|
+
#
|
3608
|
+
# @example Response structure
|
3609
|
+
#
|
3610
|
+
# resp.endpoint.url #=> String
|
3611
|
+
#
|
3612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetMessagingSessionEndpoint AWS API Documentation
|
3613
|
+
#
|
3614
|
+
# @overload get_messaging_session_endpoint(params = {})
|
3615
|
+
# @param [Hash] params ({})
|
3616
|
+
def get_messaging_session_endpoint(params = {}, options = {})
|
3617
|
+
req = build_request(:get_messaging_session_endpoint, params)
|
3618
|
+
req.send_request(options)
|
3619
|
+
end
|
3620
|
+
|
2321
3621
|
# Retrieves details for the specified phone number ID, such as
|
2322
3622
|
# associations, capabilities, and product type.
|
2323
3623
|
#
|
@@ -2349,7 +3649,7 @@ module Aws::Chime
|
|
2349
3649
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
2350
3650
|
# resp.phone_number.associations #=> Array
|
2351
3651
|
# resp.phone_number.associations[0].value #=> String
|
2352
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
3652
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
2353
3653
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
2354
3654
|
# resp.phone_number.calling_name #=> String
|
2355
3655
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -2550,63 +3850,166 @@ module Aws::Chime
|
|
2550
3850
|
req.send_request(options)
|
2551
3851
|
end
|
2552
3852
|
|
2553
|
-
# Retrieves
|
2554
|
-
#
|
2555
|
-
#
|
2556
|
-
# To retrieve user details with an email address instead of a user ID,
|
2557
|
-
# use the ListUsers action, and then filter by email address.
|
2558
|
-
#
|
2559
|
-
# @option params [required, String] :account_id
|
2560
|
-
# The Amazon Chime account ID.
|
3853
|
+
# Retrieves the information for a SIP media application, including name,
|
3854
|
+
# AWS Region, and endpoints.
|
2561
3855
|
#
|
2562
|
-
# @option params [required, String] :
|
2563
|
-
# The
|
3856
|
+
# @option params [required, String] :sip_media_application_id
|
3857
|
+
# The SIP media application ID.
|
2564
3858
|
#
|
2565
|
-
# @return [Types::
|
3859
|
+
# @return [Types::GetSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2566
3860
|
#
|
2567
|
-
# * {Types::
|
3861
|
+
# * {Types::GetSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
2568
3862
|
#
|
2569
3863
|
# @example Request syntax with placeholder values
|
2570
3864
|
#
|
2571
|
-
# resp = client.
|
2572
|
-
#
|
2573
|
-
# user_id: "NonEmptyString", # required
|
3865
|
+
# resp = client.get_sip_media_application({
|
3866
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2574
3867
|
# })
|
2575
3868
|
#
|
2576
3869
|
# @example Response structure
|
2577
3870
|
#
|
2578
|
-
# resp.
|
2579
|
-
# resp.
|
2580
|
-
# resp.
|
2581
|
-
# resp.
|
2582
|
-
# resp.
|
2583
|
-
# resp.
|
2584
|
-
# resp.
|
2585
|
-
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
2586
|
-
# resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
2587
|
-
# resp.user.registered_on #=> Time
|
2588
|
-
# resp.user.invited_on #=> Time
|
2589
|
-
# resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
|
2590
|
-
# resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
|
2591
|
-
# resp.user.personal_pin #=> String
|
3871
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
3872
|
+
# resp.sip_media_application.aws_region #=> String
|
3873
|
+
# resp.sip_media_application.name #=> String
|
3874
|
+
# resp.sip_media_application.endpoints #=> Array
|
3875
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
3876
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
3877
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
2592
3878
|
#
|
2593
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
3879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplication AWS API Documentation
|
2594
3880
|
#
|
2595
|
-
# @overload
|
3881
|
+
# @overload get_sip_media_application(params = {})
|
2596
3882
|
# @param [Hash] params ({})
|
2597
|
-
def
|
2598
|
-
req = build_request(:
|
3883
|
+
def get_sip_media_application(params = {}, options = {})
|
3884
|
+
req = build_request(:get_sip_media_application, params)
|
2599
3885
|
req.send_request(options)
|
2600
3886
|
end
|
2601
3887
|
|
2602
|
-
#
|
2603
|
-
#
|
3888
|
+
# Returns the logging configuration for the specified SIP media
|
3889
|
+
# application.
|
2604
3890
|
#
|
2605
|
-
# @option params [required, String] :
|
2606
|
-
# The
|
3891
|
+
# @option params [required, String] :sip_media_application_id
|
3892
|
+
# The ID of the SIP media application.
|
2607
3893
|
#
|
2608
|
-
# @
|
2609
|
-
#
|
3894
|
+
# @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3895
|
+
#
|
3896
|
+
# * {Types::GetSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
3897
|
+
#
|
3898
|
+
# @example Request syntax with placeholder values
|
3899
|
+
#
|
3900
|
+
# resp = client.get_sip_media_application_logging_configuration({
|
3901
|
+
# sip_media_application_id: "NonEmptyString", # required
|
3902
|
+
# })
|
3903
|
+
#
|
3904
|
+
# @example Response structure
|
3905
|
+
#
|
3906
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
3907
|
+
#
|
3908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipMediaApplicationLoggingConfiguration AWS API Documentation
|
3909
|
+
#
|
3910
|
+
# @overload get_sip_media_application_logging_configuration(params = {})
|
3911
|
+
# @param [Hash] params ({})
|
3912
|
+
def get_sip_media_application_logging_configuration(params = {}, options = {})
|
3913
|
+
req = build_request(:get_sip_media_application_logging_configuration, params)
|
3914
|
+
req.send_request(options)
|
3915
|
+
end
|
3916
|
+
|
3917
|
+
# Retrieves the details of a SIP rule, such as the rule ID, name,
|
3918
|
+
# triggers, and target endpoints.
|
3919
|
+
#
|
3920
|
+
# @option params [required, String] :sip_rule_id
|
3921
|
+
# The SIP rule ID.
|
3922
|
+
#
|
3923
|
+
# @return [Types::GetSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3924
|
+
#
|
3925
|
+
# * {Types::GetSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
3926
|
+
#
|
3927
|
+
# @example Request syntax with placeholder values
|
3928
|
+
#
|
3929
|
+
# resp = client.get_sip_rule({
|
3930
|
+
# sip_rule_id: "NonEmptyString", # required
|
3931
|
+
# })
|
3932
|
+
#
|
3933
|
+
# @example Response structure
|
3934
|
+
#
|
3935
|
+
# resp.sip_rule.sip_rule_id #=> String
|
3936
|
+
# resp.sip_rule.name #=> String
|
3937
|
+
# resp.sip_rule.disabled #=> Boolean
|
3938
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
3939
|
+
# resp.sip_rule.trigger_value #=> String
|
3940
|
+
# resp.sip_rule.target_applications #=> Array
|
3941
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
3942
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
3943
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
3944
|
+
# resp.sip_rule.created_timestamp #=> Time
|
3945
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
3946
|
+
#
|
3947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetSipRule AWS API Documentation
|
3948
|
+
#
|
3949
|
+
# @overload get_sip_rule(params = {})
|
3950
|
+
# @param [Hash] params ({})
|
3951
|
+
def get_sip_rule(params = {}, options = {})
|
3952
|
+
req = build_request(:get_sip_rule, params)
|
3953
|
+
req.send_request(options)
|
3954
|
+
end
|
3955
|
+
|
3956
|
+
# Retrieves details for the specified user ID, such as primary email
|
3957
|
+
# address, license type, and personal meeting PIN.
|
3958
|
+
#
|
3959
|
+
# To retrieve user details with an email address instead of a user ID,
|
3960
|
+
# use the ListUsers action, and then filter by email address.
|
3961
|
+
#
|
3962
|
+
# @option params [required, String] :account_id
|
3963
|
+
# The Amazon Chime account ID.
|
3964
|
+
#
|
3965
|
+
# @option params [required, String] :user_id
|
3966
|
+
# The user ID.
|
3967
|
+
#
|
3968
|
+
# @return [Types::GetUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3969
|
+
#
|
3970
|
+
# * {Types::GetUserResponse#user #user} => Types::User
|
3971
|
+
#
|
3972
|
+
# @example Request syntax with placeholder values
|
3973
|
+
#
|
3974
|
+
# resp = client.get_user({
|
3975
|
+
# account_id: "NonEmptyString", # required
|
3976
|
+
# user_id: "NonEmptyString", # required
|
3977
|
+
# })
|
3978
|
+
#
|
3979
|
+
# @example Response structure
|
3980
|
+
#
|
3981
|
+
# resp.user.user_id #=> String
|
3982
|
+
# resp.user.account_id #=> String
|
3983
|
+
# resp.user.primary_email #=> String
|
3984
|
+
# resp.user.primary_provisioned_number #=> String
|
3985
|
+
# resp.user.display_name #=> String
|
3986
|
+
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
3987
|
+
# resp.user.user_type #=> String, one of "PrivateUser", "SharedDevice"
|
3988
|
+
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
3989
|
+
# resp.user.user_invitation_status #=> String, one of "Pending", "Accepted", "Failed"
|
3990
|
+
# resp.user.registered_on #=> Time
|
3991
|
+
# resp.user.invited_on #=> Time
|
3992
|
+
# resp.user.alexa_for_business_metadata.is_alexa_for_business_enabled #=> Boolean
|
3993
|
+
# resp.user.alexa_for_business_metadata.alexa_for_business_room_arn #=> String
|
3994
|
+
# resp.user.personal_pin #=> String
|
3995
|
+
#
|
3996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUser AWS API Documentation
|
3997
|
+
#
|
3998
|
+
# @overload get_user(params = {})
|
3999
|
+
# @param [Hash] params ({})
|
4000
|
+
def get_user(params = {}, options = {})
|
4001
|
+
req = build_request(:get_user, params)
|
4002
|
+
req.send_request(options)
|
4003
|
+
end
|
4004
|
+
|
4005
|
+
# Retrieves settings for the specified user ID, such as any associated
|
4006
|
+
# phone number settings.
|
4007
|
+
#
|
4008
|
+
# @option params [required, String] :account_id
|
4009
|
+
# The Amazon Chime account ID.
|
4010
|
+
#
|
4011
|
+
# @option params [required, String] :user_id
|
4012
|
+
# The user ID.
|
2610
4013
|
#
|
2611
4014
|
# @return [Types::GetUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2612
4015
|
#
|
@@ -2738,7 +4141,7 @@ module Aws::Chime
|
|
2738
4141
|
|
2739
4142
|
# Retrieves the logging configuration details for the specified Amazon
|
2740
4143
|
# Chime Voice Connector. Shows whether SIP message logs are enabled for
|
2741
|
-
# sending to Amazon CloudWatch
|
4144
|
+
# sending to Amazon CloudWatch.
|
2742
4145
|
#
|
2743
4146
|
# @option params [required, String] :voice_connector_id
|
2744
4147
|
# The Amazon Chime Voice Connector ID.
|
@@ -3034,6 +4437,138 @@ module Aws::Chime
|
|
3034
4437
|
req.send_request(options)
|
3035
4438
|
end
|
3036
4439
|
|
4440
|
+
# Returns a list of the administrators in the app instance.
|
4441
|
+
#
|
4442
|
+
# @option params [required, String] :app_instance_arn
|
4443
|
+
# The ARN of the app instance.
|
4444
|
+
#
|
4445
|
+
# @option params [Integer] :max_results
|
4446
|
+
# The maximum number of administrators that you want to return.
|
4447
|
+
#
|
4448
|
+
# @option params [String] :next_token
|
4449
|
+
# The token returned from previous API requests until the number of
|
4450
|
+
# administrators is reached.
|
4451
|
+
#
|
4452
|
+
# @return [Types::ListAppInstanceAdminsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4453
|
+
#
|
4454
|
+
# * {Types::ListAppInstanceAdminsResponse#app_instance_arn #app_instance_arn} => String
|
4455
|
+
# * {Types::ListAppInstanceAdminsResponse#app_instance_admins #app_instance_admins} => Array<Types::AppInstanceAdminSummary>
|
4456
|
+
# * {Types::ListAppInstanceAdminsResponse#next_token #next_token} => String
|
4457
|
+
#
|
4458
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4459
|
+
#
|
4460
|
+
# @example Request syntax with placeholder values
|
4461
|
+
#
|
4462
|
+
# resp = client.list_app_instance_admins({
|
4463
|
+
# app_instance_arn: "ChimeArn", # required
|
4464
|
+
# max_results: 1,
|
4465
|
+
# next_token: "NextToken",
|
4466
|
+
# })
|
4467
|
+
#
|
4468
|
+
# @example Response structure
|
4469
|
+
#
|
4470
|
+
# resp.app_instance_arn #=> String
|
4471
|
+
# resp.app_instance_admins #=> Array
|
4472
|
+
# resp.app_instance_admins[0].admin.arn #=> String
|
4473
|
+
# resp.app_instance_admins[0].admin.name #=> String
|
4474
|
+
# resp.next_token #=> String
|
4475
|
+
#
|
4476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstanceAdmins AWS API Documentation
|
4477
|
+
#
|
4478
|
+
# @overload list_app_instance_admins(params = {})
|
4479
|
+
# @param [Hash] params ({})
|
4480
|
+
def list_app_instance_admins(params = {}, options = {})
|
4481
|
+
req = build_request(:list_app_instance_admins, params)
|
4482
|
+
req.send_request(options)
|
4483
|
+
end
|
4484
|
+
|
4485
|
+
# List all `AppInstanceUsers` created under a single app instance.
|
4486
|
+
#
|
4487
|
+
# @option params [required, String] :app_instance_arn
|
4488
|
+
# The ARN of the app instance.
|
4489
|
+
#
|
4490
|
+
# @option params [Integer] :max_results
|
4491
|
+
# The maximum number of requests that you want returned.
|
4492
|
+
#
|
4493
|
+
# @option params [String] :next_token
|
4494
|
+
# The token passed by previous API calls until all requested users are
|
4495
|
+
# returned.
|
4496
|
+
#
|
4497
|
+
# @return [Types::ListAppInstanceUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4498
|
+
#
|
4499
|
+
# * {Types::ListAppInstanceUsersResponse#app_instance_arn #app_instance_arn} => String
|
4500
|
+
# * {Types::ListAppInstanceUsersResponse#app_instance_users #app_instance_users} => Array<Types::AppInstanceUserSummary>
|
4501
|
+
# * {Types::ListAppInstanceUsersResponse#next_token #next_token} => String
|
4502
|
+
#
|
4503
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4504
|
+
#
|
4505
|
+
# @example Request syntax with placeholder values
|
4506
|
+
#
|
4507
|
+
# resp = client.list_app_instance_users({
|
4508
|
+
# app_instance_arn: "ChimeArn", # required
|
4509
|
+
# max_results: 1,
|
4510
|
+
# next_token: "NextToken",
|
4511
|
+
# })
|
4512
|
+
#
|
4513
|
+
# @example Response structure
|
4514
|
+
#
|
4515
|
+
# resp.app_instance_arn #=> String
|
4516
|
+
# resp.app_instance_users #=> Array
|
4517
|
+
# resp.app_instance_users[0].app_instance_user_arn #=> String
|
4518
|
+
# resp.app_instance_users[0].name #=> String
|
4519
|
+
# resp.app_instance_users[0].metadata #=> String
|
4520
|
+
# resp.next_token #=> String
|
4521
|
+
#
|
4522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstanceUsers AWS API Documentation
|
4523
|
+
#
|
4524
|
+
# @overload list_app_instance_users(params = {})
|
4525
|
+
# @param [Hash] params ({})
|
4526
|
+
def list_app_instance_users(params = {}, options = {})
|
4527
|
+
req = build_request(:list_app_instance_users, params)
|
4528
|
+
req.send_request(options)
|
4529
|
+
end
|
4530
|
+
|
4531
|
+
# Lists all Amazon Chime app instances created under a single AWS
|
4532
|
+
# account.
|
4533
|
+
#
|
4534
|
+
# @option params [Integer] :max_results
|
4535
|
+
# The maximum number of app instances that you want to return.
|
4536
|
+
#
|
4537
|
+
# @option params [String] :next_token
|
4538
|
+
# The token passed by previous API requests until you reach the maximum
|
4539
|
+
# number of app instances.
|
4540
|
+
#
|
4541
|
+
# @return [Types::ListAppInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4542
|
+
#
|
4543
|
+
# * {Types::ListAppInstancesResponse#app_instances #app_instances} => Array<Types::AppInstanceSummary>
|
4544
|
+
# * {Types::ListAppInstancesResponse#next_token #next_token} => String
|
4545
|
+
#
|
4546
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4547
|
+
#
|
4548
|
+
# @example Request syntax with placeholder values
|
4549
|
+
#
|
4550
|
+
# resp = client.list_app_instances({
|
4551
|
+
# max_results: 1,
|
4552
|
+
# next_token: "NextToken",
|
4553
|
+
# })
|
4554
|
+
#
|
4555
|
+
# @example Response structure
|
4556
|
+
#
|
4557
|
+
# resp.app_instances #=> Array
|
4558
|
+
# resp.app_instances[0].app_instance_arn #=> String
|
4559
|
+
# resp.app_instances[0].name #=> String
|
4560
|
+
# resp.app_instances[0].metadata #=> String
|
4561
|
+
# resp.next_token #=> String
|
4562
|
+
#
|
4563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstances AWS API Documentation
|
4564
|
+
#
|
4565
|
+
# @overload list_app_instances(params = {})
|
4566
|
+
# @param [Hash] params ({})
|
4567
|
+
def list_app_instances(params = {}, options = {})
|
4568
|
+
req = build_request(:list_app_instances, params)
|
4569
|
+
req.send_request(options)
|
4570
|
+
end
|
4571
|
+
|
3037
4572
|
# Lists the tags applied to an Amazon Chime SDK attendee resource.
|
3038
4573
|
#
|
3039
4574
|
# @option params [required, String] :meeting_id
|
@@ -3168,6 +4703,383 @@ module Aws::Chime
|
|
3168
4703
|
req.send_request(options)
|
3169
4704
|
end
|
3170
4705
|
|
4706
|
+
# Lists all the users banned from a particular channel.
|
4707
|
+
#
|
4708
|
+
# @option params [required, String] :channel_arn
|
4709
|
+
# The ARN of the channel.
|
4710
|
+
#
|
4711
|
+
# @option params [Integer] :max_results
|
4712
|
+
# The maximum number of bans that you want returned.
|
4713
|
+
#
|
4714
|
+
# @option params [String] :next_token
|
4715
|
+
# The token passed by previous API calls until all requested bans are
|
4716
|
+
# returned.
|
4717
|
+
#
|
4718
|
+
# @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4719
|
+
#
|
4720
|
+
# * {Types::ListChannelBansResponse#channel_arn #channel_arn} => String
|
4721
|
+
# * {Types::ListChannelBansResponse#next_token #next_token} => String
|
4722
|
+
# * {Types::ListChannelBansResponse#channel_bans #channel_bans} => Array<Types::ChannelBanSummary>
|
4723
|
+
#
|
4724
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4725
|
+
#
|
4726
|
+
# @example Request syntax with placeholder values
|
4727
|
+
#
|
4728
|
+
# resp = client.list_channel_bans({
|
4729
|
+
# channel_arn: "ChimeArn", # required
|
4730
|
+
# max_results: 1,
|
4731
|
+
# next_token: "NextToken",
|
4732
|
+
# })
|
4733
|
+
#
|
4734
|
+
# @example Response structure
|
4735
|
+
#
|
4736
|
+
# resp.channel_arn #=> String
|
4737
|
+
# resp.next_token #=> String
|
4738
|
+
# resp.channel_bans #=> Array
|
4739
|
+
# resp.channel_bans[0].member.arn #=> String
|
4740
|
+
# resp.channel_bans[0].member.name #=> String
|
4741
|
+
#
|
4742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelBans AWS API Documentation
|
4743
|
+
#
|
4744
|
+
# @overload list_channel_bans(params = {})
|
4745
|
+
# @param [Hash] params ({})
|
4746
|
+
def list_channel_bans(params = {}, options = {})
|
4747
|
+
req = build_request(:list_channel_bans, params)
|
4748
|
+
req.send_request(options)
|
4749
|
+
end
|
4750
|
+
|
4751
|
+
# Lists all channel memberships in a channel.
|
4752
|
+
#
|
4753
|
+
# @option params [required, String] :channel_arn
|
4754
|
+
# The maximum number of channel memberships that you want returned.
|
4755
|
+
#
|
4756
|
+
# @option params [String] :type
|
4757
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
4758
|
+
# are always returned as part of `ListChannelMemberships`. Hidden
|
4759
|
+
# members are only returned if the type filter in
|
4760
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
|
4761
|
+
# not returned.
|
4762
|
+
#
|
4763
|
+
# @option params [Integer] :max_results
|
4764
|
+
# The maximum number of channel memberships that you want returned.
|
4765
|
+
#
|
4766
|
+
# @option params [String] :next_token
|
4767
|
+
# The token passed by previous API calls until all requested channel
|
4768
|
+
# memberships are returned..
|
4769
|
+
#
|
4770
|
+
# @return [Types::ListChannelMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4771
|
+
#
|
4772
|
+
# * {Types::ListChannelMembershipsResponse#channel_arn #channel_arn} => String
|
4773
|
+
# * {Types::ListChannelMembershipsResponse#channel_memberships #channel_memberships} => Array<Types::ChannelMembershipSummary>
|
4774
|
+
# * {Types::ListChannelMembershipsResponse#next_token #next_token} => String
|
4775
|
+
#
|
4776
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4777
|
+
#
|
4778
|
+
# @example Request syntax with placeholder values
|
4779
|
+
#
|
4780
|
+
# resp = client.list_channel_memberships({
|
4781
|
+
# channel_arn: "ChimeArn", # required
|
4782
|
+
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
4783
|
+
# max_results: 1,
|
4784
|
+
# next_token: "NextToken",
|
4785
|
+
# })
|
4786
|
+
#
|
4787
|
+
# @example Response structure
|
4788
|
+
#
|
4789
|
+
# resp.channel_arn #=> String
|
4790
|
+
# resp.channel_memberships #=> Array
|
4791
|
+
# resp.channel_memberships[0].member.arn #=> String
|
4792
|
+
# resp.channel_memberships[0].member.name #=> String
|
4793
|
+
# resp.next_token #=> String
|
4794
|
+
#
|
4795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMemberships AWS API Documentation
|
4796
|
+
#
|
4797
|
+
# @overload list_channel_memberships(params = {})
|
4798
|
+
# @param [Hash] params ({})
|
4799
|
+
def list_channel_memberships(params = {}, options = {})
|
4800
|
+
req = build_request(:list_channel_memberships, params)
|
4801
|
+
req.send_request(options)
|
4802
|
+
end
|
4803
|
+
|
4804
|
+
# Lists all channels that a particular `AppInstanceUser` is a part of.
|
4805
|
+
# Only an `AppInstanceAdmin` can call the API with a user ARN that is
|
4806
|
+
# not their own.
|
4807
|
+
#
|
4808
|
+
# @option params [String] :app_instance_user_arn
|
4809
|
+
# The ARN of the app instance users
|
4810
|
+
#
|
4811
|
+
# @option params [Integer] :max_results
|
4812
|
+
# The maximum number of users that you want returned.
|
4813
|
+
#
|
4814
|
+
# @option params [String] :next_token
|
4815
|
+
# The token returned from previous API requests until the number of
|
4816
|
+
# channel memberships is reached.
|
4817
|
+
#
|
4818
|
+
# @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4819
|
+
#
|
4820
|
+
# * {Types::ListChannelMembershipsForAppInstanceUserResponse#channel_memberships #channel_memberships} => Array<Types::ChannelMembershipForAppInstanceUserSummary>
|
4821
|
+
# * {Types::ListChannelMembershipsForAppInstanceUserResponse#next_token #next_token} => String
|
4822
|
+
#
|
4823
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4824
|
+
#
|
4825
|
+
# @example Request syntax with placeholder values
|
4826
|
+
#
|
4827
|
+
# resp = client.list_channel_memberships_for_app_instance_user({
|
4828
|
+
# app_instance_user_arn: "ChimeArn",
|
4829
|
+
# max_results: 1,
|
4830
|
+
# next_token: "NextToken",
|
4831
|
+
# })
|
4832
|
+
#
|
4833
|
+
# @example Response structure
|
4834
|
+
#
|
4835
|
+
# resp.channel_memberships #=> Array
|
4836
|
+
# resp.channel_memberships[0].channel_summary.name #=> String
|
4837
|
+
# resp.channel_memberships[0].channel_summary.channel_arn #=> String
|
4838
|
+
# resp.channel_memberships[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
4839
|
+
# resp.channel_memberships[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
4840
|
+
# resp.channel_memberships[0].channel_summary.metadata #=> String
|
4841
|
+
# resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
|
4842
|
+
# resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
4843
|
+
# resp.channel_memberships[0].app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
4844
|
+
# resp.next_token #=> String
|
4845
|
+
#
|
4846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMembershipsForAppInstanceUser AWS API Documentation
|
4847
|
+
#
|
4848
|
+
# @overload list_channel_memberships_for_app_instance_user(params = {})
|
4849
|
+
# @param [Hash] params ({})
|
4850
|
+
def list_channel_memberships_for_app_instance_user(params = {}, options = {})
|
4851
|
+
req = build_request(:list_channel_memberships_for_app_instance_user, params)
|
4852
|
+
req.send_request(options)
|
4853
|
+
end
|
4854
|
+
|
4855
|
+
# List all the messages in a channel. Returns a paginated list of
|
4856
|
+
# `ChannelMessages`. Sorted in descending order by default, based on the
|
4857
|
+
# creation timestamp.
|
4858
|
+
#
|
4859
|
+
# <note markdown="1"> Redacted messages appear in the results as empty, since they are only
|
4860
|
+
# redacted, not deleted. Deleted messages do not appear in the results.
|
4861
|
+
# This action always returns the latest version of an edited message.
|
4862
|
+
#
|
4863
|
+
# </note>
|
4864
|
+
#
|
4865
|
+
# @option params [required, String] :channel_arn
|
4866
|
+
# The ARN of the channel.
|
4867
|
+
#
|
4868
|
+
# @option params [String] :sort_order
|
4869
|
+
# The order in which you want messages sorted. Default is Descending,
|
4870
|
+
# based on time created.
|
4871
|
+
#
|
4872
|
+
# @option params [Time,DateTime,Date,Integer,String] :not_before
|
4873
|
+
# The initial or starting time stamp for your requested messages.
|
4874
|
+
#
|
4875
|
+
# @option params [Time,DateTime,Date,Integer,String] :not_after
|
4876
|
+
# The final or ending time stamp for your requested messages.
|
4877
|
+
#
|
4878
|
+
# @option params [Integer] :max_results
|
4879
|
+
# The maximum number of messages that you want returned.
|
4880
|
+
#
|
4881
|
+
# @option params [String] :next_token
|
4882
|
+
# The token passed by previous API calls until all requested messages
|
4883
|
+
# are returned.
|
4884
|
+
#
|
4885
|
+
# @return [Types::ListChannelMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4886
|
+
#
|
4887
|
+
# * {Types::ListChannelMessagesResponse#channel_arn #channel_arn} => String
|
4888
|
+
# * {Types::ListChannelMessagesResponse#next_token #next_token} => String
|
4889
|
+
# * {Types::ListChannelMessagesResponse#channel_messages #channel_messages} => Array<Types::ChannelMessageSummary>
|
4890
|
+
#
|
4891
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4892
|
+
#
|
4893
|
+
# @example Request syntax with placeholder values
|
4894
|
+
#
|
4895
|
+
# resp = client.list_channel_messages({
|
4896
|
+
# channel_arn: "ChimeArn", # required
|
4897
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4898
|
+
# not_before: Time.now,
|
4899
|
+
# not_after: Time.now,
|
4900
|
+
# max_results: 1,
|
4901
|
+
# next_token: "NextToken",
|
4902
|
+
# })
|
4903
|
+
#
|
4904
|
+
# @example Response structure
|
4905
|
+
#
|
4906
|
+
# resp.channel_arn #=> String
|
4907
|
+
# resp.next_token #=> String
|
4908
|
+
# resp.channel_messages #=> Array
|
4909
|
+
# resp.channel_messages[0].message_id #=> String
|
4910
|
+
# resp.channel_messages[0].content #=> String
|
4911
|
+
# resp.channel_messages[0].metadata #=> String
|
4912
|
+
# resp.channel_messages[0].type #=> String, one of "STANDARD", "CONTROL"
|
4913
|
+
# resp.channel_messages[0].created_timestamp #=> Time
|
4914
|
+
# resp.channel_messages[0].last_updated_timestamp #=> Time
|
4915
|
+
# resp.channel_messages[0].last_edited_timestamp #=> Time
|
4916
|
+
# resp.channel_messages[0].sender.arn #=> String
|
4917
|
+
# resp.channel_messages[0].sender.name #=> String
|
4918
|
+
# resp.channel_messages[0].redacted #=> Boolean
|
4919
|
+
#
|
4920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMessages AWS API Documentation
|
4921
|
+
#
|
4922
|
+
# @overload list_channel_messages(params = {})
|
4923
|
+
# @param [Hash] params ({})
|
4924
|
+
def list_channel_messages(params = {}, options = {})
|
4925
|
+
req = build_request(:list_channel_messages, params)
|
4926
|
+
req.send_request(options)
|
4927
|
+
end
|
4928
|
+
|
4929
|
+
# Lists all the moderators for a channel.
|
4930
|
+
#
|
4931
|
+
# @option params [required, String] :channel_arn
|
4932
|
+
# The ARN of the channel.
|
4933
|
+
#
|
4934
|
+
# @option params [Integer] :max_results
|
4935
|
+
# The maximum number of moderators that you want returned.
|
4936
|
+
#
|
4937
|
+
# @option params [String] :next_token
|
4938
|
+
# The token passed by previous API calls until all requested moderators
|
4939
|
+
# are returned.
|
4940
|
+
#
|
4941
|
+
# @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4942
|
+
#
|
4943
|
+
# * {Types::ListChannelModeratorsResponse#channel_arn #channel_arn} => String
|
4944
|
+
# * {Types::ListChannelModeratorsResponse#next_token #next_token} => String
|
4945
|
+
# * {Types::ListChannelModeratorsResponse#channel_moderators #channel_moderators} => Array<Types::ChannelModeratorSummary>
|
4946
|
+
#
|
4947
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4948
|
+
#
|
4949
|
+
# @example Request syntax with placeholder values
|
4950
|
+
#
|
4951
|
+
# resp = client.list_channel_moderators({
|
4952
|
+
# channel_arn: "ChimeArn", # required
|
4953
|
+
# max_results: 1,
|
4954
|
+
# next_token: "NextToken",
|
4955
|
+
# })
|
4956
|
+
#
|
4957
|
+
# @example Response structure
|
4958
|
+
#
|
4959
|
+
# resp.channel_arn #=> String
|
4960
|
+
# resp.next_token #=> String
|
4961
|
+
# resp.channel_moderators #=> Array
|
4962
|
+
# resp.channel_moderators[0].moderator.arn #=> String
|
4963
|
+
# resp.channel_moderators[0].moderator.name #=> String
|
4964
|
+
#
|
4965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelModerators AWS API Documentation
|
4966
|
+
#
|
4967
|
+
# @overload list_channel_moderators(params = {})
|
4968
|
+
# @param [Hash] params ({})
|
4969
|
+
def list_channel_moderators(params = {}, options = {})
|
4970
|
+
req = build_request(:list_channel_moderators, params)
|
4971
|
+
req.send_request(options)
|
4972
|
+
end
|
4973
|
+
|
4974
|
+
# Lists all Channels created under a single Chime App as a paginated
|
4975
|
+
# list. You can specify filters to narrow results.
|
4976
|
+
#
|
4977
|
+
# **Functionality & restrictions**
|
4978
|
+
#
|
4979
|
+
# * Use privacy = `PUBLIC` to retrieve all public channels in the
|
4980
|
+
# account
|
4981
|
+
#
|
4982
|
+
# * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
|
4983
|
+
# private channels in an account.
|
4984
|
+
#
|
4985
|
+
# @option params [required, String] :app_instance_arn
|
4986
|
+
# The ARN of the app instance.
|
4987
|
+
#
|
4988
|
+
# @option params [String] :privacy
|
4989
|
+
# The privacy setting. `PUBLIC` retrieves all the public channels.
|
4990
|
+
# `PRIVATE` retrieves private channels. Only an app instance
|
4991
|
+
# administrator can retrieve private channels.
|
4992
|
+
#
|
4993
|
+
# @option params [Integer] :max_results
|
4994
|
+
# The maximum number of channels that you want to return.
|
4995
|
+
#
|
4996
|
+
# @option params [String] :next_token
|
4997
|
+
# The token passed by previous API calls until all requested channels
|
4998
|
+
# are returned.
|
4999
|
+
#
|
5000
|
+
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5001
|
+
#
|
5002
|
+
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
5003
|
+
# * {Types::ListChannelsResponse#next_token #next_token} => String
|
5004
|
+
#
|
5005
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5006
|
+
#
|
5007
|
+
# @example Request syntax with placeholder values
|
5008
|
+
#
|
5009
|
+
# resp = client.list_channels({
|
5010
|
+
# app_instance_arn: "ChimeArn", # required
|
5011
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
5012
|
+
# max_results: 1,
|
5013
|
+
# next_token: "NextToken",
|
5014
|
+
# })
|
5015
|
+
#
|
5016
|
+
# @example Response structure
|
5017
|
+
#
|
5018
|
+
# resp.channels #=> Array
|
5019
|
+
# resp.channels[0].name #=> String
|
5020
|
+
# resp.channels[0].channel_arn #=> String
|
5021
|
+
# resp.channels[0].mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
5022
|
+
# resp.channels[0].privacy #=> String, one of "PUBLIC", "PRIVATE"
|
5023
|
+
# resp.channels[0].metadata #=> String
|
5024
|
+
# resp.channels[0].last_message_timestamp #=> Time
|
5025
|
+
# resp.next_token #=> String
|
5026
|
+
#
|
5027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannels AWS API Documentation
|
5028
|
+
#
|
5029
|
+
# @overload list_channels(params = {})
|
5030
|
+
# @param [Hash] params ({})
|
5031
|
+
def list_channels(params = {}, options = {})
|
5032
|
+
req = build_request(:list_channels, params)
|
5033
|
+
req.send_request(options)
|
5034
|
+
end
|
5035
|
+
|
5036
|
+
# A list of the channels moderated by an app instance user.
|
5037
|
+
#
|
5038
|
+
# @option params [String] :app_instance_user_arn
|
5039
|
+
# The ARN of the user in the moderated channel.
|
5040
|
+
#
|
5041
|
+
# @option params [Integer] :max_results
|
5042
|
+
# The maximum number of channels in the request.
|
5043
|
+
#
|
5044
|
+
# @option params [String] :next_token
|
5045
|
+
# The token returned from previous API requests until the number of
|
5046
|
+
# channels moderated by the user is reached.
|
5047
|
+
#
|
5048
|
+
# @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5049
|
+
#
|
5050
|
+
# * {Types::ListChannelsModeratedByAppInstanceUserResponse#channels #channels} => Array<Types::ChannelModeratedByAppInstanceUserSummary>
|
5051
|
+
# * {Types::ListChannelsModeratedByAppInstanceUserResponse#next_token #next_token} => String
|
5052
|
+
#
|
5053
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5054
|
+
#
|
5055
|
+
# @example Request syntax with placeholder values
|
5056
|
+
#
|
5057
|
+
# resp = client.list_channels_moderated_by_app_instance_user({
|
5058
|
+
# app_instance_user_arn: "ChimeArn",
|
5059
|
+
# max_results: 1,
|
5060
|
+
# next_token: "NextToken",
|
5061
|
+
# })
|
5062
|
+
#
|
5063
|
+
# @example Response structure
|
5064
|
+
#
|
5065
|
+
# resp.channels #=> Array
|
5066
|
+
# resp.channels[0].channel_summary.name #=> String
|
5067
|
+
# resp.channels[0].channel_summary.channel_arn #=> String
|
5068
|
+
# resp.channels[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
5069
|
+
# resp.channels[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
5070
|
+
# resp.channels[0].channel_summary.metadata #=> String
|
5071
|
+
# resp.channels[0].channel_summary.last_message_timestamp #=> Time
|
5072
|
+
# resp.next_token #=> String
|
5073
|
+
#
|
5074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelsModeratedByAppInstanceUser AWS API Documentation
|
5075
|
+
#
|
5076
|
+
# @overload list_channels_moderated_by_app_instance_user(params = {})
|
5077
|
+
# @param [Hash] params ({})
|
5078
|
+
def list_channels_moderated_by_app_instance_user(params = {}, options = {})
|
5079
|
+
req = build_request(:list_channels_moderated_by_app_instance_user, params)
|
5080
|
+
req.send_request(options)
|
5081
|
+
end
|
5082
|
+
|
3171
5083
|
# Lists the tags applied to an Amazon Chime SDK meeting resource.
|
3172
5084
|
#
|
3173
5085
|
# @option params [required, String] :meeting_id
|
@@ -3329,7 +5241,7 @@ module Aws::Chime
|
|
3329
5241
|
# resp = client.list_phone_numbers({
|
3330
5242
|
# status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
|
3331
5243
|
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
3332
|
-
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId
|
5244
|
+
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
|
3333
5245
|
# filter_value: "String",
|
3334
5246
|
# max_results: 1,
|
3335
5247
|
# next_token: "String",
|
@@ -3351,7 +5263,7 @@ module Aws::Chime
|
|
3351
5263
|
# resp.phone_numbers[0].capabilities.outbound_mms #=> Boolean
|
3352
5264
|
# resp.phone_numbers[0].associations #=> Array
|
3353
5265
|
# resp.phone_numbers[0].associations[0].value #=> String
|
3354
|
-
# resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
5266
|
+
# resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
3355
5267
|
# resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
|
3356
5268
|
# resp.phone_numbers[0].calling_name #=> String
|
3357
5269
|
# resp.phone_numbers[0].calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -3529,12 +5441,109 @@ module Aws::Chime
|
|
3529
5441
|
# resp.rooms[0].updated_timestamp #=> Time
|
3530
5442
|
# resp.next_token #=> String
|
3531
5443
|
#
|
3532
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListRooms AWS API Documentation
|
5444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListRooms AWS API Documentation
|
5445
|
+
#
|
5446
|
+
# @overload list_rooms(params = {})
|
5447
|
+
# @param [Hash] params ({})
|
5448
|
+
def list_rooms(params = {}, options = {})
|
5449
|
+
req = build_request(:list_rooms, params)
|
5450
|
+
req.send_request(options)
|
5451
|
+
end
|
5452
|
+
|
5453
|
+
# Lists the SIP media applications under the administrator's AWS
|
5454
|
+
# account.
|
5455
|
+
#
|
5456
|
+
# @option params [Integer] :max_results
|
5457
|
+
# The maximum number of results to return in a single call. Defaults to
|
5458
|
+
# 100.
|
5459
|
+
#
|
5460
|
+
# @option params [String] :next_token
|
5461
|
+
# The token to use to retrieve the next page of results.
|
5462
|
+
#
|
5463
|
+
# @return [Types::ListSipMediaApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5464
|
+
#
|
5465
|
+
# * {Types::ListSipMediaApplicationsResponse#sip_media_applications #sip_media_applications} => Array<Types::SipMediaApplication>
|
5466
|
+
# * {Types::ListSipMediaApplicationsResponse#next_token #next_token} => String
|
5467
|
+
#
|
5468
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5469
|
+
#
|
5470
|
+
# @example Request syntax with placeholder values
|
5471
|
+
#
|
5472
|
+
# resp = client.list_sip_media_applications({
|
5473
|
+
# max_results: 1,
|
5474
|
+
# next_token: "NextTokenString",
|
5475
|
+
# })
|
5476
|
+
#
|
5477
|
+
# @example Response structure
|
5478
|
+
#
|
5479
|
+
# resp.sip_media_applications #=> Array
|
5480
|
+
# resp.sip_media_applications[0].sip_media_application_id #=> String
|
5481
|
+
# resp.sip_media_applications[0].aws_region #=> String
|
5482
|
+
# resp.sip_media_applications[0].name #=> String
|
5483
|
+
# resp.sip_media_applications[0].endpoints #=> Array
|
5484
|
+
# resp.sip_media_applications[0].endpoints[0].lambda_arn #=> String
|
5485
|
+
# resp.sip_media_applications[0].created_timestamp #=> Time
|
5486
|
+
# resp.sip_media_applications[0].updated_timestamp #=> Time
|
5487
|
+
# resp.next_token #=> String
|
5488
|
+
#
|
5489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipMediaApplications AWS API Documentation
|
5490
|
+
#
|
5491
|
+
# @overload list_sip_media_applications(params = {})
|
5492
|
+
# @param [Hash] params ({})
|
5493
|
+
def list_sip_media_applications(params = {}, options = {})
|
5494
|
+
req = build_request(:list_sip_media_applications, params)
|
5495
|
+
req.send_request(options)
|
5496
|
+
end
|
5497
|
+
|
5498
|
+
# Lists the SIP rules under the administrator's AWS account.
|
5499
|
+
#
|
5500
|
+
# @option params [String] :sip_media_application_id
|
5501
|
+
# The SIP media application ID.
|
5502
|
+
#
|
5503
|
+
# @option params [Integer] :max_results
|
5504
|
+
# The maximum number of results to return in a single call. Defaults to
|
5505
|
+
# 100.
|
5506
|
+
#
|
5507
|
+
# @option params [String] :next_token
|
5508
|
+
# The token to use to retrieve the next page of results.
|
5509
|
+
#
|
5510
|
+
# @return [Types::ListSipRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5511
|
+
#
|
5512
|
+
# * {Types::ListSipRulesResponse#sip_rules #sip_rules} => Array<Types::SipRule>
|
5513
|
+
# * {Types::ListSipRulesResponse#next_token #next_token} => String
|
5514
|
+
#
|
5515
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5516
|
+
#
|
5517
|
+
# @example Request syntax with placeholder values
|
5518
|
+
#
|
5519
|
+
# resp = client.list_sip_rules({
|
5520
|
+
# sip_media_application_id: "NonEmptyString",
|
5521
|
+
# max_results: 1,
|
5522
|
+
# next_token: "NextTokenString",
|
5523
|
+
# })
|
5524
|
+
#
|
5525
|
+
# @example Response structure
|
5526
|
+
#
|
5527
|
+
# resp.sip_rules #=> Array
|
5528
|
+
# resp.sip_rules[0].sip_rule_id #=> String
|
5529
|
+
# resp.sip_rules[0].name #=> String
|
5530
|
+
# resp.sip_rules[0].disabled #=> Boolean
|
5531
|
+
# resp.sip_rules[0].trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
5532
|
+
# resp.sip_rules[0].trigger_value #=> String
|
5533
|
+
# resp.sip_rules[0].target_applications #=> Array
|
5534
|
+
# resp.sip_rules[0].target_applications[0].sip_media_application_id #=> String
|
5535
|
+
# resp.sip_rules[0].target_applications[0].priority #=> Integer
|
5536
|
+
# resp.sip_rules[0].target_applications[0].aws_region #=> String
|
5537
|
+
# resp.sip_rules[0].created_timestamp #=> Time
|
5538
|
+
# resp.sip_rules[0].updated_timestamp #=> Time
|
5539
|
+
# resp.next_token #=> String
|
5540
|
+
#
|
5541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSipRules AWS API Documentation
|
3533
5542
|
#
|
3534
|
-
# @overload
|
5543
|
+
# @overload list_sip_rules(params = {})
|
3535
5544
|
# @param [Hash] params ({})
|
3536
|
-
def
|
3537
|
-
req = build_request(:
|
5545
|
+
def list_sip_rules(params = {}, options = {})
|
5546
|
+
req = build_request(:list_sip_rules, params)
|
3538
5547
|
req.send_request(options)
|
3539
5548
|
end
|
3540
5549
|
|
@@ -3778,6 +5787,84 @@ module Aws::Chime
|
|
3778
5787
|
req.send_request(options)
|
3779
5788
|
end
|
3780
5789
|
|
5790
|
+
# Sets the amount of time in days that a given app instance retains
|
5791
|
+
# data.
|
5792
|
+
#
|
5793
|
+
# @option params [required, String] :app_instance_arn
|
5794
|
+
# The ARN of the app instance.
|
5795
|
+
#
|
5796
|
+
# @option params [required, Types::AppInstanceRetentionSettings] :app_instance_retention_settings
|
5797
|
+
# The time in days to retain data. Data type: number.
|
5798
|
+
#
|
5799
|
+
# @return [Types::PutAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5800
|
+
#
|
5801
|
+
# * {Types::PutAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
|
5802
|
+
# * {Types::PutAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
|
5803
|
+
#
|
5804
|
+
# @example Request syntax with placeholder values
|
5805
|
+
#
|
5806
|
+
# resp = client.put_app_instance_retention_settings({
|
5807
|
+
# app_instance_arn: "ChimeArn", # required
|
5808
|
+
# app_instance_retention_settings: { # required
|
5809
|
+
# channel_retention_settings: {
|
5810
|
+
# retention_days: 1,
|
5811
|
+
# },
|
5812
|
+
# },
|
5813
|
+
# })
|
5814
|
+
#
|
5815
|
+
# @example Response structure
|
5816
|
+
#
|
5817
|
+
# resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
|
5818
|
+
# resp.initiate_deletion_timestamp #=> Time
|
5819
|
+
#
|
5820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutAppInstanceRetentionSettings AWS API Documentation
|
5821
|
+
#
|
5822
|
+
# @overload put_app_instance_retention_settings(params = {})
|
5823
|
+
# @param [Hash] params ({})
|
5824
|
+
def put_app_instance_retention_settings(params = {}, options = {})
|
5825
|
+
req = build_request(:put_app_instance_retention_settings, params)
|
5826
|
+
req.send_request(options)
|
5827
|
+
end
|
5828
|
+
|
5829
|
+
# The data streaming configurations of an app instance.
|
5830
|
+
#
|
5831
|
+
# @option params [required, String] :app_instance_arn
|
5832
|
+
# The ARN of the app instance.
|
5833
|
+
#
|
5834
|
+
# @option params [required, Array<Types::AppInstanceStreamingConfiguration>] :app_instance_streaming_configurations
|
5835
|
+
# The streaming configurations set for an app instance.
|
5836
|
+
#
|
5837
|
+
# @return [Types::PutAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5838
|
+
#
|
5839
|
+
# * {Types::PutAppInstanceStreamingConfigurationsResponse#app_instance_streaming_configurations #app_instance_streaming_configurations} => Array<Types::AppInstanceStreamingConfiguration>
|
5840
|
+
#
|
5841
|
+
# @example Request syntax with placeholder values
|
5842
|
+
#
|
5843
|
+
# resp = client.put_app_instance_streaming_configurations({
|
5844
|
+
# app_instance_arn: "ChimeArn", # required
|
5845
|
+
# app_instance_streaming_configurations: [ # required
|
5846
|
+
# {
|
5847
|
+
# app_instance_data_type: "Channel", # required, accepts Channel, ChannelMessage
|
5848
|
+
# resource_arn: "Arn", # required
|
5849
|
+
# },
|
5850
|
+
# ],
|
5851
|
+
# })
|
5852
|
+
#
|
5853
|
+
# @example Response structure
|
5854
|
+
#
|
5855
|
+
# resp.app_instance_streaming_configurations #=> Array
|
5856
|
+
# resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
|
5857
|
+
# resp.app_instance_streaming_configurations[0].resource_arn #=> String
|
5858
|
+
#
|
5859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutAppInstanceStreamingConfigurations AWS API Documentation
|
5860
|
+
#
|
5861
|
+
# @overload put_app_instance_streaming_configurations(params = {})
|
5862
|
+
# @param [Hash] params ({})
|
5863
|
+
def put_app_instance_streaming_configurations(params = {}, options = {})
|
5864
|
+
req = build_request(:put_app_instance_streaming_configurations, params)
|
5865
|
+
req.send_request(options)
|
5866
|
+
end
|
5867
|
+
|
3781
5868
|
# Creates an events configuration that allows a bot to receive outgoing
|
3782
5869
|
# events sent by Amazon Chime. Choose either an HTTPS endpoint or a
|
3783
5870
|
# Lambda function ARN. For more information, see Bot.
|
@@ -3879,6 +5966,41 @@ module Aws::Chime
|
|
3879
5966
|
req.send_request(options)
|
3880
5967
|
end
|
3881
5968
|
|
5969
|
+
# Updates the logging configuration for the specified SIP media
|
5970
|
+
# application.
|
5971
|
+
#
|
5972
|
+
# @option params [required, String] :sip_media_application_id
|
5973
|
+
# The ID of the specified SIP media application
|
5974
|
+
#
|
5975
|
+
# @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
|
5976
|
+
# The actual logging configuration.
|
5977
|
+
#
|
5978
|
+
# @return [Types::PutSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5979
|
+
#
|
5980
|
+
# * {Types::PutSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
5981
|
+
#
|
5982
|
+
# @example Request syntax with placeholder values
|
5983
|
+
#
|
5984
|
+
# resp = client.put_sip_media_application_logging_configuration({
|
5985
|
+
# sip_media_application_id: "NonEmptyString", # required
|
5986
|
+
# sip_media_application_logging_configuration: {
|
5987
|
+
# enable_sip_media_application_message_logs: false,
|
5988
|
+
# },
|
5989
|
+
# })
|
5990
|
+
#
|
5991
|
+
# @example Response structure
|
5992
|
+
#
|
5993
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
5994
|
+
#
|
5995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutSipMediaApplicationLoggingConfiguration AWS API Documentation
|
5996
|
+
#
|
5997
|
+
# @overload put_sip_media_application_logging_configuration(params = {})
|
5998
|
+
# @param [Hash] params ({})
|
5999
|
+
def put_sip_media_application_logging_configuration(params = {}, options = {})
|
6000
|
+
req = build_request(:put_sip_media_application_logging_configuration, params)
|
6001
|
+
req.send_request(options)
|
6002
|
+
end
|
6003
|
+
|
3882
6004
|
# Puts emergency calling configuration details to the specified Amazon
|
3883
6005
|
# Chime Voice Connector, such as emergency phone numbers and calling
|
3884
6006
|
# countries. Origination and termination settings must be enabled for
|
@@ -4197,6 +6319,43 @@ module Aws::Chime
|
|
4197
6319
|
req.send_request(options)
|
4198
6320
|
end
|
4199
6321
|
|
6322
|
+
# Redacts message content, but not metadata. The message exists in the
|
6323
|
+
# back end, but the action returns null content, and the state shows as
|
6324
|
+
# redacted.
|
6325
|
+
#
|
6326
|
+
# @option params [required, String] :channel_arn
|
6327
|
+
# The ARN of the channel containing the messages that you want to
|
6328
|
+
# redact.
|
6329
|
+
#
|
6330
|
+
# @option params [required, String] :message_id
|
6331
|
+
# The ID of the message being redacted.
|
6332
|
+
#
|
6333
|
+
# @return [Types::RedactChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6334
|
+
#
|
6335
|
+
# * {Types::RedactChannelMessageResponse#channel_arn #channel_arn} => String
|
6336
|
+
# * {Types::RedactChannelMessageResponse#message_id #message_id} => String
|
6337
|
+
#
|
6338
|
+
# @example Request syntax with placeholder values
|
6339
|
+
#
|
6340
|
+
# resp = client.redact_channel_message({
|
6341
|
+
# channel_arn: "ChimeArn", # required
|
6342
|
+
# message_id: "MessageId", # required
|
6343
|
+
# })
|
6344
|
+
#
|
6345
|
+
# @example Response structure
|
6346
|
+
#
|
6347
|
+
# resp.channel_arn #=> String
|
6348
|
+
# resp.message_id #=> String
|
6349
|
+
#
|
6350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/RedactChannelMessage AWS API Documentation
|
6351
|
+
#
|
6352
|
+
# @overload redact_channel_message(params = {})
|
6353
|
+
# @param [Hash] params ({})
|
6354
|
+
def redact_channel_message(params = {}, options = {})
|
6355
|
+
req = build_request(:redact_channel_message, params)
|
6356
|
+
req.send_request(options)
|
6357
|
+
end
|
6358
|
+
|
4200
6359
|
# Redacts the specified message from the specified Amazon Chime
|
4201
6360
|
# conversation.
|
4202
6361
|
#
|
@@ -4228,8 +6387,7 @@ module Aws::Chime
|
|
4228
6387
|
req.send_request(options)
|
4229
6388
|
end
|
4230
6389
|
|
4231
|
-
# Redacts the specified message from the specified Amazon Chime
|
4232
|
-
# room.
|
6390
|
+
# Redacts the specified message from the specified Amazon Chime channel.
|
4233
6391
|
#
|
4234
6392
|
# @option params [required, String] :account_id
|
4235
6393
|
# The Amazon Chime account ID.
|
@@ -4377,7 +6535,7 @@ module Aws::Chime
|
|
4377
6535
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
4378
6536
|
# resp.phone_number.associations #=> Array
|
4379
6537
|
# resp.phone_number.associations[0].value #=> String
|
4380
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
6538
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
4381
6539
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
4382
6540
|
# resp.phone_number.calling_name #=> String
|
4383
6541
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -4447,6 +6605,65 @@ module Aws::Chime
|
|
4447
6605
|
req.send_request(options)
|
4448
6606
|
end
|
4449
6607
|
|
6608
|
+
# Sends a message to a particular channel that the member is a part of.
|
6609
|
+
#
|
6610
|
+
# <note markdown="1"> `STANDARD` messages can contain 4KB of data and the 1KB of metadata.
|
6611
|
+
# `CONTROL` messages can contain 30 bytes of data and no metadata.
|
6612
|
+
#
|
6613
|
+
# </note>
|
6614
|
+
#
|
6615
|
+
# @option params [required, String] :channel_arn
|
6616
|
+
# The ARN of the channel.
|
6617
|
+
#
|
6618
|
+
# @option params [required, String] :content
|
6619
|
+
# The content of the message.
|
6620
|
+
#
|
6621
|
+
# @option params [required, String] :type
|
6622
|
+
# The type of message, `STANDARD` or `CONTROL`.
|
6623
|
+
#
|
6624
|
+
# @option params [required, String] :persistence
|
6625
|
+
# Boolean that controls whether the message is persisted on the back
|
6626
|
+
# end. Required.
|
6627
|
+
#
|
6628
|
+
# @option params [String] :metadata
|
6629
|
+
# The optional metadata for each message.
|
6630
|
+
#
|
6631
|
+
# @option params [required, String] :client_request_token
|
6632
|
+
# The `Idempotency` token for each client request.
|
6633
|
+
#
|
6634
|
+
# **A suitable default value is auto-generated.** You should normally
|
6635
|
+
# not need to pass this option.**
|
6636
|
+
#
|
6637
|
+
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6638
|
+
#
|
6639
|
+
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
6640
|
+
# * {Types::SendChannelMessageResponse#message_id #message_id} => String
|
6641
|
+
#
|
6642
|
+
# @example Request syntax with placeholder values
|
6643
|
+
#
|
6644
|
+
# resp = client.send_channel_message({
|
6645
|
+
# channel_arn: "ChimeArn", # required
|
6646
|
+
# content: "NonEmptyContent", # required
|
6647
|
+
# type: "STANDARD", # required, accepts STANDARD, CONTROL
|
6648
|
+
# persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
|
6649
|
+
# metadata: "Metadata",
|
6650
|
+
# client_request_token: "ClientRequestToken", # required
|
6651
|
+
# })
|
6652
|
+
#
|
6653
|
+
# @example Response structure
|
6654
|
+
#
|
6655
|
+
# resp.channel_arn #=> String
|
6656
|
+
# resp.message_id #=> String
|
6657
|
+
#
|
6658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SendChannelMessage AWS API Documentation
|
6659
|
+
#
|
6660
|
+
# @overload send_channel_message(params = {})
|
6661
|
+
# @param [Hash] params ({})
|
6662
|
+
def send_channel_message(params = {}, options = {})
|
6663
|
+
req = build_request(:send_channel_message, params)
|
6664
|
+
req.send_request(options)
|
6665
|
+
end
|
6666
|
+
|
4450
6667
|
# Applies the specified tags to the specified Amazon Chime SDK attendee.
|
4451
6668
|
#
|
4452
6669
|
# @option params [required, String] :meeting_id
|
@@ -4707,6 +6924,79 @@ module Aws::Chime
|
|
4707
6924
|
req.send_request(options)
|
4708
6925
|
end
|
4709
6926
|
|
6927
|
+
# Updates `AppInstance` metadata.
|
6928
|
+
#
|
6929
|
+
# @option params [required, String] :app_instance_arn
|
6930
|
+
# The ARN of the app instance.
|
6931
|
+
#
|
6932
|
+
# @option params [required, String] :name
|
6933
|
+
# The name that you want to change.
|
6934
|
+
#
|
6935
|
+
# @option params [String] :metadata
|
6936
|
+
# The metadata that you want to change.
|
6937
|
+
#
|
6938
|
+
# @return [Types::UpdateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6939
|
+
#
|
6940
|
+
# * {Types::UpdateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
|
6941
|
+
#
|
6942
|
+
# @example Request syntax with placeholder values
|
6943
|
+
#
|
6944
|
+
# resp = client.update_app_instance({
|
6945
|
+
# app_instance_arn: "ChimeArn", # required
|
6946
|
+
# name: "NonEmptyResourceName", # required
|
6947
|
+
# metadata: "Metadata",
|
6948
|
+
# })
|
6949
|
+
#
|
6950
|
+
# @example Response structure
|
6951
|
+
#
|
6952
|
+
# resp.app_instance_arn #=> String
|
6953
|
+
#
|
6954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAppInstance AWS API Documentation
|
6955
|
+
#
|
6956
|
+
# @overload update_app_instance(params = {})
|
6957
|
+
# @param [Hash] params ({})
|
6958
|
+
def update_app_instance(params = {}, options = {})
|
6959
|
+
req = build_request(:update_app_instance, params)
|
6960
|
+
req.send_request(options)
|
6961
|
+
end
|
6962
|
+
|
6963
|
+
# Updates the details for an `AppInstanceUser`. You can update names and
|
6964
|
+
# metadata.
|
6965
|
+
#
|
6966
|
+
# @option params [required, String] :app_instance_user_arn
|
6967
|
+
# The ARN of the app instance user.
|
6968
|
+
#
|
6969
|
+
# @option params [required, String] :name
|
6970
|
+
# The name of the app instance user.
|
6971
|
+
#
|
6972
|
+
# @option params [String] :metadata
|
6973
|
+
# The metadata of the app instance user.
|
6974
|
+
#
|
6975
|
+
# @return [Types::UpdateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6976
|
+
#
|
6977
|
+
# * {Types::UpdateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
|
6978
|
+
#
|
6979
|
+
# @example Request syntax with placeholder values
|
6980
|
+
#
|
6981
|
+
# resp = client.update_app_instance_user({
|
6982
|
+
# app_instance_user_arn: "ChimeArn", # required
|
6983
|
+
# name: "UserName", # required
|
6984
|
+
# metadata: "Metadata",
|
6985
|
+
# })
|
6986
|
+
#
|
6987
|
+
# @example Response structure
|
6988
|
+
#
|
6989
|
+
# resp.app_instance_user_arn #=> String
|
6990
|
+
#
|
6991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAppInstanceUser AWS API Documentation
|
6992
|
+
#
|
6993
|
+
# @overload update_app_instance_user(params = {})
|
6994
|
+
# @param [Hash] params ({})
|
6995
|
+
def update_app_instance_user(params = {}, options = {})
|
6996
|
+
req = build_request(:update_app_instance_user, params)
|
6997
|
+
req.send_request(options)
|
6998
|
+
end
|
6999
|
+
|
4710
7000
|
# Updates the status of the specified bot, such as starting or stopping
|
4711
7001
|
# the bot from running in your Amazon Chime Enterprise account.
|
4712
7002
|
#
|
@@ -4752,6 +7042,119 @@ module Aws::Chime
|
|
4752
7042
|
req.send_request(options)
|
4753
7043
|
end
|
4754
7044
|
|
7045
|
+
# Update a channel's attributes.
|
7046
|
+
#
|
7047
|
+
# **Restriction**\: You can't change a channel's privacy.
|
7048
|
+
#
|
7049
|
+
# @option params [required, String] :channel_arn
|
7050
|
+
# The ARN of the channel.
|
7051
|
+
#
|
7052
|
+
# @option params [required, String] :name
|
7053
|
+
# The name of the channel.
|
7054
|
+
#
|
7055
|
+
# @option params [required, String] :mode
|
7056
|
+
# The mode of the update request.
|
7057
|
+
#
|
7058
|
+
# @option params [String] :metadata
|
7059
|
+
# The metadata of the channel.
|
7060
|
+
#
|
7061
|
+
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7062
|
+
#
|
7063
|
+
# * {Types::UpdateChannelResponse#channel_arn #channel_arn} => String
|
7064
|
+
#
|
7065
|
+
# @example Request syntax with placeholder values
|
7066
|
+
#
|
7067
|
+
# resp = client.update_channel({
|
7068
|
+
# channel_arn: "ChimeArn", # required
|
7069
|
+
# name: "NonEmptyResourceName", # required
|
7070
|
+
# mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
|
7071
|
+
# metadata: "Metadata",
|
7072
|
+
# })
|
7073
|
+
#
|
7074
|
+
# @example Response structure
|
7075
|
+
#
|
7076
|
+
# resp.channel_arn #=> String
|
7077
|
+
#
|
7078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannel AWS API Documentation
|
7079
|
+
#
|
7080
|
+
# @overload update_channel(params = {})
|
7081
|
+
# @param [Hash] params ({})
|
7082
|
+
def update_channel(params = {}, options = {})
|
7083
|
+
req = build_request(:update_channel, params)
|
7084
|
+
req.send_request(options)
|
7085
|
+
end
|
7086
|
+
|
7087
|
+
# Updates the content of a message.
|
7088
|
+
#
|
7089
|
+
# @option params [required, String] :channel_arn
|
7090
|
+
# The ARN of the channel.
|
7091
|
+
#
|
7092
|
+
# @option params [required, String] :message_id
|
7093
|
+
# The ID string of the message being updated.
|
7094
|
+
#
|
7095
|
+
# @option params [String] :content
|
7096
|
+
# The content of the message being updated.
|
7097
|
+
#
|
7098
|
+
# @option params [String] :metadata
|
7099
|
+
# The metadata of the message being updated.
|
7100
|
+
#
|
7101
|
+
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7102
|
+
#
|
7103
|
+
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
7104
|
+
# * {Types::UpdateChannelMessageResponse#message_id #message_id} => String
|
7105
|
+
#
|
7106
|
+
# @example Request syntax with placeholder values
|
7107
|
+
#
|
7108
|
+
# resp = client.update_channel_message({
|
7109
|
+
# channel_arn: "ChimeArn", # required
|
7110
|
+
# message_id: "MessageId", # required
|
7111
|
+
# content: "Content",
|
7112
|
+
# metadata: "Metadata",
|
7113
|
+
# })
|
7114
|
+
#
|
7115
|
+
# @example Response structure
|
7116
|
+
#
|
7117
|
+
# resp.channel_arn #=> String
|
7118
|
+
# resp.message_id #=> String
|
7119
|
+
#
|
7120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannelMessage AWS API Documentation
|
7121
|
+
#
|
7122
|
+
# @overload update_channel_message(params = {})
|
7123
|
+
# @param [Hash] params ({})
|
7124
|
+
def update_channel_message(params = {}, options = {})
|
7125
|
+
req = build_request(:update_channel_message, params)
|
7126
|
+
req.send_request(options)
|
7127
|
+
end
|
7128
|
+
|
7129
|
+
# Sets the timestamp to the point when a user last read messages in a
|
7130
|
+
# channel.
|
7131
|
+
#
|
7132
|
+
# @option params [required, String] :channel_arn
|
7133
|
+
# The ARN of the channel.
|
7134
|
+
#
|
7135
|
+
# @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7136
|
+
#
|
7137
|
+
# * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
|
7138
|
+
#
|
7139
|
+
# @example Request syntax with placeholder values
|
7140
|
+
#
|
7141
|
+
# resp = client.update_channel_read_marker({
|
7142
|
+
# channel_arn: "ChimeArn", # required
|
7143
|
+
# })
|
7144
|
+
#
|
7145
|
+
# @example Response structure
|
7146
|
+
#
|
7147
|
+
# resp.channel_arn #=> String
|
7148
|
+
#
|
7149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannelReadMarker AWS API Documentation
|
7150
|
+
#
|
7151
|
+
# @overload update_channel_read_marker(params = {})
|
7152
|
+
# @param [Hash] params ({})
|
7153
|
+
def update_channel_read_marker(params = {}, options = {})
|
7154
|
+
req = build_request(:update_channel_read_marker, params)
|
7155
|
+
req.send_request(options)
|
7156
|
+
end
|
7157
|
+
|
4755
7158
|
# Updates global settings for the administrator's AWS account, such as
|
4756
7159
|
# Amazon Chime Business Calling and Amazon Chime Voice Connector
|
4757
7160
|
# settings.
|
@@ -4832,7 +7235,7 @@ module Aws::Chime
|
|
4832
7235
|
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
4833
7236
|
# resp.phone_number.associations #=> Array
|
4834
7237
|
# resp.phone_number.associations[0].value #=> String
|
4835
|
-
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId"
|
7238
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
4836
7239
|
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
4837
7240
|
# resp.phone_number.calling_name #=> String
|
4838
7241
|
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
@@ -5024,6 +7427,108 @@ module Aws::Chime
|
|
5024
7427
|
req.send_request(options)
|
5025
7428
|
end
|
5026
7429
|
|
7430
|
+
# Updates the details for the specified SIP media application.
|
7431
|
+
#
|
7432
|
+
# @option params [required, String] :sip_media_application_id
|
7433
|
+
# The SIP media application ID.
|
7434
|
+
#
|
7435
|
+
# @option params [String] :name
|
7436
|
+
# The new name for the specified SIP media application.
|
7437
|
+
#
|
7438
|
+
# @option params [Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
7439
|
+
# The new set of endpoints for the specified SIP media application.
|
7440
|
+
#
|
7441
|
+
# @return [Types::UpdateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7442
|
+
#
|
7443
|
+
# * {Types::UpdateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
7444
|
+
#
|
7445
|
+
# @example Request syntax with placeholder values
|
7446
|
+
#
|
7447
|
+
# resp = client.update_sip_media_application({
|
7448
|
+
# sip_media_application_id: "NonEmptyString", # required
|
7449
|
+
# name: "SipMediaApplicationName",
|
7450
|
+
# endpoints: [
|
7451
|
+
# {
|
7452
|
+
# lambda_arn: "FunctionArn",
|
7453
|
+
# },
|
7454
|
+
# ],
|
7455
|
+
# })
|
7456
|
+
#
|
7457
|
+
# @example Response structure
|
7458
|
+
#
|
7459
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
7460
|
+
# resp.sip_media_application.aws_region #=> String
|
7461
|
+
# resp.sip_media_application.name #=> String
|
7462
|
+
# resp.sip_media_application.endpoints #=> Array
|
7463
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
7464
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
7465
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
7466
|
+
#
|
7467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipMediaApplication AWS API Documentation
|
7468
|
+
#
|
7469
|
+
# @overload update_sip_media_application(params = {})
|
7470
|
+
# @param [Hash] params ({})
|
7471
|
+
def update_sip_media_application(params = {}, options = {})
|
7472
|
+
req = build_request(:update_sip_media_application, params)
|
7473
|
+
req.send_request(options)
|
7474
|
+
end
|
7475
|
+
|
7476
|
+
# Updates the details for the specified SIP rule.
|
7477
|
+
#
|
7478
|
+
# @option params [required, String] :sip_rule_id
|
7479
|
+
# The SIP rule ID.
|
7480
|
+
#
|
7481
|
+
# @option params [required, String] :name
|
7482
|
+
# The new name for the specified SIP rule.
|
7483
|
+
#
|
7484
|
+
# @option params [Boolean] :disabled
|
7485
|
+
# The new value specified to indicate whether the rule is disabled.
|
7486
|
+
#
|
7487
|
+
# @option params [Array<Types::SipRuleTargetApplication>] :target_applications
|
7488
|
+
# The new value of the list of target applications.
|
7489
|
+
#
|
7490
|
+
# @return [Types::UpdateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7491
|
+
#
|
7492
|
+
# * {Types::UpdateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
7493
|
+
#
|
7494
|
+
# @example Request syntax with placeholder values
|
7495
|
+
#
|
7496
|
+
# resp = client.update_sip_rule({
|
7497
|
+
# sip_rule_id: "NonEmptyString", # required
|
7498
|
+
# name: "SipRuleName", # required
|
7499
|
+
# disabled: false,
|
7500
|
+
# target_applications: [
|
7501
|
+
# {
|
7502
|
+
# sip_media_application_id: "NonEmptyString",
|
7503
|
+
# priority: 1,
|
7504
|
+
# aws_region: "String",
|
7505
|
+
# },
|
7506
|
+
# ],
|
7507
|
+
# })
|
7508
|
+
#
|
7509
|
+
# @example Response structure
|
7510
|
+
#
|
7511
|
+
# resp.sip_rule.sip_rule_id #=> String
|
7512
|
+
# resp.sip_rule.name #=> String
|
7513
|
+
# resp.sip_rule.disabled #=> Boolean
|
7514
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
7515
|
+
# resp.sip_rule.trigger_value #=> String
|
7516
|
+
# resp.sip_rule.target_applications #=> Array
|
7517
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
7518
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
7519
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
7520
|
+
# resp.sip_rule.created_timestamp #=> Time
|
7521
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
7522
|
+
#
|
7523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateSipRule AWS API Documentation
|
7524
|
+
#
|
7525
|
+
# @overload update_sip_rule(params = {})
|
7526
|
+
# @param [Hash] params ({})
|
7527
|
+
def update_sip_rule(params = {}, options = {})
|
7528
|
+
req = build_request(:update_sip_rule, params)
|
7529
|
+
req.send_request(options)
|
7530
|
+
end
|
7531
|
+
|
5027
7532
|
# Updates user details for a specified user ID. Currently, only
|
5028
7533
|
# `LicenseType` updates are supported for this action.
|
5029
7534
|
#
|
@@ -5227,7 +7732,7 @@ module Aws::Chime
|
|
5227
7732
|
params: params,
|
5228
7733
|
config: config)
|
5229
7734
|
context[:gem_name] = 'aws-sdk-chime'
|
5230
|
-
context[:gem_version] = '1.
|
7735
|
+
context[:gem_version] = '1.39.0'
|
5231
7736
|
Seahorse::Client::Request.new(handlers, context)
|
5232
7737
|
end
|
5233
7738
|
|