aws-sdk-chimesdkmessaging 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-chimesdkmessaging.rb +53 -0
- data/lib/aws-sdk-chimesdkmessaging/client.rb +1916 -0
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +1057 -0
- data/lib/aws-sdk-chimesdkmessaging/customizations.rb +0 -0
- data/lib/aws-sdk-chimesdkmessaging/errors.rb +227 -0
- data/lib/aws-sdk-chimesdkmessaging/resource.rb +26 -0
- data/lib/aws-sdk-chimesdkmessaging/types.rb +2176 -0
- metadata +90 -0
File without changes
|
@@ -0,0 +1,227 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ChimeSDKMessaging
|
11
|
+
|
12
|
+
# When ChimeSDKMessaging returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::ChimeSDKMessaging::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all ChimeSDKMessaging errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::ChimeSDKMessaging::Errors::ServiceError
|
20
|
+
# # rescues all ChimeSDKMessaging API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {BadRequestException}
|
31
|
+
# * {ConflictException}
|
32
|
+
# * {ForbiddenException}
|
33
|
+
# * {NotFoundException}
|
34
|
+
# * {ResourceLimitExceededException}
|
35
|
+
# * {ServiceFailureException}
|
36
|
+
# * {ServiceUnavailableException}
|
37
|
+
# * {ThrottledClientException}
|
38
|
+
# * {UnauthorizedClientException}
|
39
|
+
#
|
40
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
41
|
+
# if they are not defined above.
|
42
|
+
module Errors
|
43
|
+
|
44
|
+
extend Aws::Errors::DynamicErrors
|
45
|
+
|
46
|
+
class BadRequestException < ServiceError
|
47
|
+
|
48
|
+
# @param [Seahorse::Client::RequestContext] context
|
49
|
+
# @param [String] message
|
50
|
+
# @param [Aws::ChimeSDKMessaging::Types::BadRequestException] data
|
51
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
52
|
+
super(context, message, data)
|
53
|
+
end
|
54
|
+
|
55
|
+
# @return [String]
|
56
|
+
def code
|
57
|
+
@code || @data[:code]
|
58
|
+
end
|
59
|
+
|
60
|
+
# @return [String]
|
61
|
+
def message
|
62
|
+
@message || @data[:message]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
class ConflictException < ServiceError
|
67
|
+
|
68
|
+
# @param [Seahorse::Client::RequestContext] context
|
69
|
+
# @param [String] message
|
70
|
+
# @param [Aws::ChimeSDKMessaging::Types::ConflictException] data
|
71
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
72
|
+
super(context, message, data)
|
73
|
+
end
|
74
|
+
|
75
|
+
# @return [String]
|
76
|
+
def code
|
77
|
+
@code || @data[:code]
|
78
|
+
end
|
79
|
+
|
80
|
+
# @return [String]
|
81
|
+
def message
|
82
|
+
@message || @data[:message]
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
class ForbiddenException < ServiceError
|
87
|
+
|
88
|
+
# @param [Seahorse::Client::RequestContext] context
|
89
|
+
# @param [String] message
|
90
|
+
# @param [Aws::ChimeSDKMessaging::Types::ForbiddenException] data
|
91
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
92
|
+
super(context, message, data)
|
93
|
+
end
|
94
|
+
|
95
|
+
# @return [String]
|
96
|
+
def code
|
97
|
+
@code || @data[:code]
|
98
|
+
end
|
99
|
+
|
100
|
+
# @return [String]
|
101
|
+
def message
|
102
|
+
@message || @data[:message]
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
class NotFoundException < ServiceError
|
107
|
+
|
108
|
+
# @param [Seahorse::Client::RequestContext] context
|
109
|
+
# @param [String] message
|
110
|
+
# @param [Aws::ChimeSDKMessaging::Types::NotFoundException] data
|
111
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
112
|
+
super(context, message, data)
|
113
|
+
end
|
114
|
+
|
115
|
+
# @return [String]
|
116
|
+
def code
|
117
|
+
@code || @data[:code]
|
118
|
+
end
|
119
|
+
|
120
|
+
# @return [String]
|
121
|
+
def message
|
122
|
+
@message || @data[:message]
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
class ResourceLimitExceededException < ServiceError
|
127
|
+
|
128
|
+
# @param [Seahorse::Client::RequestContext] context
|
129
|
+
# @param [String] message
|
130
|
+
# @param [Aws::ChimeSDKMessaging::Types::ResourceLimitExceededException] data
|
131
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
132
|
+
super(context, message, data)
|
133
|
+
end
|
134
|
+
|
135
|
+
# @return [String]
|
136
|
+
def code
|
137
|
+
@code || @data[:code]
|
138
|
+
end
|
139
|
+
|
140
|
+
# @return [String]
|
141
|
+
def message
|
142
|
+
@message || @data[:message]
|
143
|
+
end
|
144
|
+
end
|
145
|
+
|
146
|
+
class ServiceFailureException < ServiceError
|
147
|
+
|
148
|
+
# @param [Seahorse::Client::RequestContext] context
|
149
|
+
# @param [String] message
|
150
|
+
# @param [Aws::ChimeSDKMessaging::Types::ServiceFailureException] data
|
151
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
152
|
+
super(context, message, data)
|
153
|
+
end
|
154
|
+
|
155
|
+
# @return [String]
|
156
|
+
def code
|
157
|
+
@code || @data[:code]
|
158
|
+
end
|
159
|
+
|
160
|
+
# @return [String]
|
161
|
+
def message
|
162
|
+
@message || @data[:message]
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
class ServiceUnavailableException < ServiceError
|
167
|
+
|
168
|
+
# @param [Seahorse::Client::RequestContext] context
|
169
|
+
# @param [String] message
|
170
|
+
# @param [Aws::ChimeSDKMessaging::Types::ServiceUnavailableException] data
|
171
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
172
|
+
super(context, message, data)
|
173
|
+
end
|
174
|
+
|
175
|
+
# @return [String]
|
176
|
+
def code
|
177
|
+
@code || @data[:code]
|
178
|
+
end
|
179
|
+
|
180
|
+
# @return [String]
|
181
|
+
def message
|
182
|
+
@message || @data[:message]
|
183
|
+
end
|
184
|
+
end
|
185
|
+
|
186
|
+
class ThrottledClientException < ServiceError
|
187
|
+
|
188
|
+
# @param [Seahorse::Client::RequestContext] context
|
189
|
+
# @param [String] message
|
190
|
+
# @param [Aws::ChimeSDKMessaging::Types::ThrottledClientException] data
|
191
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
192
|
+
super(context, message, data)
|
193
|
+
end
|
194
|
+
|
195
|
+
# @return [String]
|
196
|
+
def code
|
197
|
+
@code || @data[:code]
|
198
|
+
end
|
199
|
+
|
200
|
+
# @return [String]
|
201
|
+
def message
|
202
|
+
@message || @data[:message]
|
203
|
+
end
|
204
|
+
end
|
205
|
+
|
206
|
+
class UnauthorizedClientException < ServiceError
|
207
|
+
|
208
|
+
# @param [Seahorse::Client::RequestContext] context
|
209
|
+
# @param [String] message
|
210
|
+
# @param [Aws::ChimeSDKMessaging::Types::UnauthorizedClientException] data
|
211
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
212
|
+
super(context, message, data)
|
213
|
+
end
|
214
|
+
|
215
|
+
# @return [String]
|
216
|
+
def code
|
217
|
+
@code || @data[:code]
|
218
|
+
end
|
219
|
+
|
220
|
+
# @return [String]
|
221
|
+
def message
|
222
|
+
@message || @data[:message]
|
223
|
+
end
|
224
|
+
end
|
225
|
+
|
226
|
+
end
|
227
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ChimeSDKMessaging
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,2176 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ChimeSDKMessaging
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# Summary of the membership details of an `AppInstanceUser`.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] type
|
16
|
+
# The type of `ChannelMembership`.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @!attribute [rw] read_marker_timestamp
|
20
|
+
# The time at which a message was last read.
|
21
|
+
# @return [Time]
|
22
|
+
#
|
23
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/AppInstanceUserMembershipSummary AWS API Documentation
|
24
|
+
#
|
25
|
+
class AppInstanceUserMembershipSummary < Struct.new(
|
26
|
+
:type,
|
27
|
+
:read_marker_timestamp)
|
28
|
+
SENSITIVE = []
|
29
|
+
include Aws::Structure
|
30
|
+
end
|
31
|
+
|
32
|
+
# The input parameters don't match the service's restrictions.
|
33
|
+
#
|
34
|
+
# @!attribute [rw] code
|
35
|
+
# @return [String]
|
36
|
+
#
|
37
|
+
# @!attribute [rw] message
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BadRequestException AWS API Documentation
|
41
|
+
#
|
42
|
+
class BadRequestException < Struct.new(
|
43
|
+
:code,
|
44
|
+
:message)
|
45
|
+
SENSITIVE = []
|
46
|
+
include Aws::Structure
|
47
|
+
end
|
48
|
+
|
49
|
+
# The membership information, including member ARNs, the channel ARN,
|
50
|
+
# and membership types.
|
51
|
+
#
|
52
|
+
# @!attribute [rw] invited_by
|
53
|
+
# The identifier of the member who invited another member.
|
54
|
+
# @return [Types::Identity]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] type
|
57
|
+
# The membership types set for the channel users.
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] members
|
61
|
+
# The users successfully added to the request.
|
62
|
+
# @return [Array<Types::Identity>]
|
63
|
+
#
|
64
|
+
# @!attribute [rw] channel_arn
|
65
|
+
# The ARN of the channel to which you're adding users.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchChannelMemberships AWS API Documentation
|
69
|
+
#
|
70
|
+
class BatchChannelMemberships < Struct.new(
|
71
|
+
:invited_by,
|
72
|
+
:type,
|
73
|
+
:members,
|
74
|
+
:channel_arn)
|
75
|
+
SENSITIVE = []
|
76
|
+
include Aws::Structure
|
77
|
+
end
|
78
|
+
|
79
|
+
# A list of failed member ARNs, error codes, and error messages.
|
80
|
+
#
|
81
|
+
# @!attribute [rw] member_arn
|
82
|
+
# The ARN of the member that the service couldn't add.
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] error_code
|
86
|
+
# The error code.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] error_message
|
90
|
+
# The error message.
|
91
|
+
# @return [String]
|
92
|
+
#
|
93
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembershipError AWS API Documentation
|
94
|
+
#
|
95
|
+
class BatchCreateChannelMembershipError < Struct.new(
|
96
|
+
:member_arn,
|
97
|
+
:error_code,
|
98
|
+
:error_message)
|
99
|
+
SENSITIVE = []
|
100
|
+
include Aws::Structure
|
101
|
+
end
|
102
|
+
|
103
|
+
# @note When making an API call, you may pass BatchCreateChannelMembershipRequest
|
104
|
+
# data as a hash:
|
105
|
+
#
|
106
|
+
# {
|
107
|
+
# channel_arn: "ChimeArn", # required
|
108
|
+
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
109
|
+
# member_arns: ["ChimeArn"], # required
|
110
|
+
# chime_bearer: "ChimeArn", # required
|
111
|
+
# }
|
112
|
+
#
|
113
|
+
# @!attribute [rw] channel_arn
|
114
|
+
# The ARN of the channel to which you're adding users.
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] type
|
118
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default
|
119
|
+
# members are always returned as part of `ListChannelMemberships`.
|
120
|
+
# Hidden members are only returned if the type filter in
|
121
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members
|
122
|
+
# are not returned. This is only supported by moderators.
|
123
|
+
# @return [String]
|
124
|
+
#
|
125
|
+
# @!attribute [rw] member_arns
|
126
|
+
# The ARNs of the members you want to add to the channel.
|
127
|
+
# @return [Array<String>]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] chime_bearer
|
130
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
131
|
+
# @return [String]
|
132
|
+
#
|
133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembershipRequest AWS API Documentation
|
134
|
+
#
|
135
|
+
class BatchCreateChannelMembershipRequest < Struct.new(
|
136
|
+
:channel_arn,
|
137
|
+
:type,
|
138
|
+
:member_arns,
|
139
|
+
:chime_bearer)
|
140
|
+
SENSITIVE = []
|
141
|
+
include Aws::Structure
|
142
|
+
end
|
143
|
+
|
144
|
+
# @!attribute [rw] batch_channel_memberships
|
145
|
+
# The list of channel memberships in the response.
|
146
|
+
# @return [Types::BatchChannelMemberships]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] errors
|
149
|
+
# If the action fails for one or more of the memberships in the
|
150
|
+
# request, a list of the memberships is returned, along with error
|
151
|
+
# codes and error messages.
|
152
|
+
# @return [Array<Types::BatchCreateChannelMembershipError>]
|
153
|
+
#
|
154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembershipResponse AWS API Documentation
|
155
|
+
#
|
156
|
+
class BatchCreateChannelMembershipResponse < Struct.new(
|
157
|
+
:batch_channel_memberships,
|
158
|
+
:errors)
|
159
|
+
SENSITIVE = []
|
160
|
+
include Aws::Structure
|
161
|
+
end
|
162
|
+
|
163
|
+
# The details of a channel.
|
164
|
+
#
|
165
|
+
# @!attribute [rw] name
|
166
|
+
# The name of a channel.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] channel_arn
|
170
|
+
# The ARN of a channel.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] mode
|
174
|
+
# The mode of the channel.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] privacy
|
178
|
+
# The channel's privacy setting.
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] metadata
|
182
|
+
# The channel's metadata.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] created_by
|
186
|
+
# The `AppInstanceUser` who created the channel.
|
187
|
+
# @return [Types::Identity]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] created_timestamp
|
190
|
+
# The time at which the `AppInstanceUser` created the channel.
|
191
|
+
# @return [Time]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] last_message_timestamp
|
194
|
+
# The time at which a member sent the last message in the channel.
|
195
|
+
# @return [Time]
|
196
|
+
#
|
197
|
+
# @!attribute [rw] last_updated_timestamp
|
198
|
+
# The time at which a channel was last updated.
|
199
|
+
# @return [Time]
|
200
|
+
#
|
201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Channel AWS API Documentation
|
202
|
+
#
|
203
|
+
class Channel < Struct.new(
|
204
|
+
:name,
|
205
|
+
:channel_arn,
|
206
|
+
:mode,
|
207
|
+
:privacy,
|
208
|
+
:metadata,
|
209
|
+
:created_by,
|
210
|
+
:created_timestamp,
|
211
|
+
:last_message_timestamp,
|
212
|
+
:last_updated_timestamp)
|
213
|
+
SENSITIVE = [:name, :metadata]
|
214
|
+
include Aws::Structure
|
215
|
+
end
|
216
|
+
|
217
|
+
# The details of a channel ban.
|
218
|
+
#
|
219
|
+
# @!attribute [rw] member
|
220
|
+
# The member being banned from the channel.
|
221
|
+
# @return [Types::Identity]
|
222
|
+
#
|
223
|
+
# @!attribute [rw] channel_arn
|
224
|
+
# The ARN of the channel from which a member is being banned.
|
225
|
+
# @return [String]
|
226
|
+
#
|
227
|
+
# @!attribute [rw] created_timestamp
|
228
|
+
# The time at which the ban was created.
|
229
|
+
# @return [Time]
|
230
|
+
#
|
231
|
+
# @!attribute [rw] created_by
|
232
|
+
# The `AppInstanceUser` who created the ban.
|
233
|
+
# @return [Types::Identity]
|
234
|
+
#
|
235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelBan AWS API Documentation
|
236
|
+
#
|
237
|
+
class ChannelBan < Struct.new(
|
238
|
+
:member,
|
239
|
+
:channel_arn,
|
240
|
+
:created_timestamp,
|
241
|
+
:created_by)
|
242
|
+
SENSITIVE = []
|
243
|
+
include Aws::Structure
|
244
|
+
end
|
245
|
+
|
246
|
+
# Summary of the details of a `ChannelBan`.
|
247
|
+
#
|
248
|
+
# @!attribute [rw] member
|
249
|
+
# The member being banned from a channel.
|
250
|
+
# @return [Types::Identity]
|
251
|
+
#
|
252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelBanSummary AWS API Documentation
|
253
|
+
#
|
254
|
+
class ChannelBanSummary < Struct.new(
|
255
|
+
:member)
|
256
|
+
SENSITIVE = []
|
257
|
+
include Aws::Structure
|
258
|
+
end
|
259
|
+
|
260
|
+
# The details of a channel member.
|
261
|
+
#
|
262
|
+
# @!attribute [rw] invited_by
|
263
|
+
# The identifier of the member who invited another member.
|
264
|
+
# @return [Types::Identity]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] type
|
267
|
+
# The membership type set for the channel member.
|
268
|
+
# @return [String]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] member
|
271
|
+
# The data of the channel member.
|
272
|
+
# @return [Types::Identity]
|
273
|
+
#
|
274
|
+
# @!attribute [rw] channel_arn
|
275
|
+
# The ARN of the member's channel.
|
276
|
+
# @return [String]
|
277
|
+
#
|
278
|
+
# @!attribute [rw] created_timestamp
|
279
|
+
# The time at which the channel membership was created.
|
280
|
+
# @return [Time]
|
281
|
+
#
|
282
|
+
# @!attribute [rw] last_updated_timestamp
|
283
|
+
# The time at which a channel membership was last updated.
|
284
|
+
# @return [Time]
|
285
|
+
#
|
286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMembership AWS API Documentation
|
287
|
+
#
|
288
|
+
class ChannelMembership < Struct.new(
|
289
|
+
:invited_by,
|
290
|
+
:type,
|
291
|
+
:member,
|
292
|
+
:channel_arn,
|
293
|
+
:created_timestamp,
|
294
|
+
:last_updated_timestamp)
|
295
|
+
SENSITIVE = []
|
296
|
+
include Aws::Structure
|
297
|
+
end
|
298
|
+
|
299
|
+
# Summary of the channel membership details of an `AppInstanceUser`.
|
300
|
+
#
|
301
|
+
# @!attribute [rw] channel_summary
|
302
|
+
# Returns the channel data for an `AppInstance`.
|
303
|
+
# @return [Types::ChannelSummary]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] app_instance_user_membership_summary
|
306
|
+
# Returns the channel membership data for an `AppInstance`.
|
307
|
+
# @return [Types::AppInstanceUserMembershipSummary]
|
308
|
+
#
|
309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMembershipForAppInstanceUserSummary AWS API Documentation
|
310
|
+
#
|
311
|
+
class ChannelMembershipForAppInstanceUserSummary < Struct.new(
|
312
|
+
:channel_summary,
|
313
|
+
:app_instance_user_membership_summary)
|
314
|
+
SENSITIVE = []
|
315
|
+
include Aws::Structure
|
316
|
+
end
|
317
|
+
|
318
|
+
# Summary of the details of a `ChannelMembership`.
|
319
|
+
#
|
320
|
+
# @!attribute [rw] member
|
321
|
+
# A member's summary data.
|
322
|
+
# @return [Types::Identity]
|
323
|
+
#
|
324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMembershipSummary AWS API Documentation
|
325
|
+
#
|
326
|
+
class ChannelMembershipSummary < Struct.new(
|
327
|
+
:member)
|
328
|
+
SENSITIVE = []
|
329
|
+
include Aws::Structure
|
330
|
+
end
|
331
|
+
|
332
|
+
# The details of a message in a channel.
|
333
|
+
#
|
334
|
+
# @!attribute [rw] channel_arn
|
335
|
+
# The ARN of the channel.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] message_id
|
339
|
+
# The ID of a message.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] content
|
343
|
+
# The message content.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] metadata
|
347
|
+
# The message metadata.
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] type
|
351
|
+
# The message type.
|
352
|
+
# @return [String]
|
353
|
+
#
|
354
|
+
# @!attribute [rw] created_timestamp
|
355
|
+
# The time at which the message was created.
|
356
|
+
# @return [Time]
|
357
|
+
#
|
358
|
+
# @!attribute [rw] last_edited_timestamp
|
359
|
+
# The time at which a message was edited.
|
360
|
+
# @return [Time]
|
361
|
+
#
|
362
|
+
# @!attribute [rw] last_updated_timestamp
|
363
|
+
# The time at which a message was updated.
|
364
|
+
# @return [Time]
|
365
|
+
#
|
366
|
+
# @!attribute [rw] sender
|
367
|
+
# The message sender.
|
368
|
+
# @return [Types::Identity]
|
369
|
+
#
|
370
|
+
# @!attribute [rw] redacted
|
371
|
+
# Hides the content of a message.
|
372
|
+
# @return [Boolean]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] persistence
|
375
|
+
# The persistence setting for a channel message.
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessage AWS API Documentation
|
379
|
+
#
|
380
|
+
class ChannelMessage < Struct.new(
|
381
|
+
:channel_arn,
|
382
|
+
:message_id,
|
383
|
+
:content,
|
384
|
+
:metadata,
|
385
|
+
:type,
|
386
|
+
:created_timestamp,
|
387
|
+
:last_edited_timestamp,
|
388
|
+
:last_updated_timestamp,
|
389
|
+
:sender,
|
390
|
+
:redacted,
|
391
|
+
:persistence)
|
392
|
+
SENSITIVE = [:content, :metadata]
|
393
|
+
include Aws::Structure
|
394
|
+
end
|
395
|
+
|
396
|
+
# Summary of the messages in a `Channel`.
|
397
|
+
#
|
398
|
+
# @!attribute [rw] message_id
|
399
|
+
# The ID of the message.
|
400
|
+
# @return [String]
|
401
|
+
#
|
402
|
+
# @!attribute [rw] content
|
403
|
+
# The content of the message.
|
404
|
+
# @return [String]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] metadata
|
407
|
+
# The metadata of the message.
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] type
|
411
|
+
# The type of message.
|
412
|
+
# @return [String]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] created_timestamp
|
415
|
+
# The time at which the message summary was created.
|
416
|
+
# @return [Time]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] last_updated_timestamp
|
419
|
+
# The time at which a message was last updated.
|
420
|
+
# @return [Time]
|
421
|
+
#
|
422
|
+
# @!attribute [rw] last_edited_timestamp
|
423
|
+
# The time at which a message was last edited.
|
424
|
+
# @return [Time]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] sender
|
427
|
+
# The message sender.
|
428
|
+
# @return [Types::Identity]
|
429
|
+
#
|
430
|
+
# @!attribute [rw] redacted
|
431
|
+
# Indicates whether a message was redacted.
|
432
|
+
# @return [Boolean]
|
433
|
+
#
|
434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageSummary AWS API Documentation
|
435
|
+
#
|
436
|
+
class ChannelMessageSummary < Struct.new(
|
437
|
+
:message_id,
|
438
|
+
:content,
|
439
|
+
:metadata,
|
440
|
+
:type,
|
441
|
+
:created_timestamp,
|
442
|
+
:last_updated_timestamp,
|
443
|
+
:last_edited_timestamp,
|
444
|
+
:sender,
|
445
|
+
:redacted)
|
446
|
+
SENSITIVE = [:content, :metadata]
|
447
|
+
include Aws::Structure
|
448
|
+
end
|
449
|
+
|
450
|
+
# Summary of the details of a moderated channel.
|
451
|
+
#
|
452
|
+
# @!attribute [rw] channel_summary
|
453
|
+
# Summary of the details of a `Channel`.
|
454
|
+
# @return [Types::ChannelSummary]
|
455
|
+
#
|
456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelModeratedByAppInstanceUserSummary AWS API Documentation
|
457
|
+
#
|
458
|
+
class ChannelModeratedByAppInstanceUserSummary < Struct.new(
|
459
|
+
:channel_summary)
|
460
|
+
SENSITIVE = []
|
461
|
+
include Aws::Structure
|
462
|
+
end
|
463
|
+
|
464
|
+
# The details of a channel moderator.
|
465
|
+
#
|
466
|
+
# @!attribute [rw] moderator
|
467
|
+
# The moderator's data.
|
468
|
+
# @return [Types::Identity]
|
469
|
+
#
|
470
|
+
# @!attribute [rw] channel_arn
|
471
|
+
# The ARN of the moderator's channel.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] created_timestamp
|
475
|
+
# The time at which the moderator was created.
|
476
|
+
# @return [Time]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] created_by
|
479
|
+
# The `AppInstanceUser` who created the moderator.
|
480
|
+
# @return [Types::Identity]
|
481
|
+
#
|
482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelModerator AWS API Documentation
|
483
|
+
#
|
484
|
+
class ChannelModerator < Struct.new(
|
485
|
+
:moderator,
|
486
|
+
:channel_arn,
|
487
|
+
:created_timestamp,
|
488
|
+
:created_by)
|
489
|
+
SENSITIVE = []
|
490
|
+
include Aws::Structure
|
491
|
+
end
|
492
|
+
|
493
|
+
# Summary of the details of a `ChannelModerator`.
|
494
|
+
#
|
495
|
+
# @!attribute [rw] moderator
|
496
|
+
# The data for a moderator.
|
497
|
+
# @return [Types::Identity]
|
498
|
+
#
|
499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelModeratorSummary AWS API Documentation
|
500
|
+
#
|
501
|
+
class ChannelModeratorSummary < Struct.new(
|
502
|
+
:moderator)
|
503
|
+
SENSITIVE = []
|
504
|
+
include Aws::Structure
|
505
|
+
end
|
506
|
+
|
507
|
+
# Summary of the details of a `Channel`.
|
508
|
+
#
|
509
|
+
# @!attribute [rw] name
|
510
|
+
# The name of the channel.
|
511
|
+
# @return [String]
|
512
|
+
#
|
513
|
+
# @!attribute [rw] channel_arn
|
514
|
+
# The ARN of the channel.
|
515
|
+
# @return [String]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] mode
|
518
|
+
# The mode of the channel.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] privacy
|
522
|
+
# The privacy setting of the channel.
|
523
|
+
# @return [String]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] metadata
|
526
|
+
# The metadata of the channel.
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] last_message_timestamp
|
530
|
+
# The time at which the last message in a channel was sent.
|
531
|
+
# @return [Time]
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelSummary AWS API Documentation
|
534
|
+
#
|
535
|
+
class ChannelSummary < Struct.new(
|
536
|
+
:name,
|
537
|
+
:channel_arn,
|
538
|
+
:mode,
|
539
|
+
:privacy,
|
540
|
+
:metadata,
|
541
|
+
:last_message_timestamp)
|
542
|
+
SENSITIVE = [:name, :metadata]
|
543
|
+
include Aws::Structure
|
544
|
+
end
|
545
|
+
|
546
|
+
# The request could not be processed because of conflict in the current
|
547
|
+
# state of the resource.
|
548
|
+
#
|
549
|
+
# @!attribute [rw] code
|
550
|
+
# @return [String]
|
551
|
+
#
|
552
|
+
# @!attribute [rw] message
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ConflictException AWS API Documentation
|
556
|
+
#
|
557
|
+
class ConflictException < Struct.new(
|
558
|
+
:code,
|
559
|
+
:message)
|
560
|
+
SENSITIVE = []
|
561
|
+
include Aws::Structure
|
562
|
+
end
|
563
|
+
|
564
|
+
# @note When making an API call, you may pass CreateChannelBanRequest
|
565
|
+
# data as a hash:
|
566
|
+
#
|
567
|
+
# {
|
568
|
+
# channel_arn: "ChimeArn", # required
|
569
|
+
# member_arn: "ChimeArn", # required
|
570
|
+
# chime_bearer: "ChimeArn", # required
|
571
|
+
# }
|
572
|
+
#
|
573
|
+
# @!attribute [rw] channel_arn
|
574
|
+
# The ARN of the ban request.
|
575
|
+
# @return [String]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] member_arn
|
578
|
+
# The ARN of the member being banned.
|
579
|
+
# @return [String]
|
580
|
+
#
|
581
|
+
# @!attribute [rw] chime_bearer
|
582
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelBanRequest AWS API Documentation
|
586
|
+
#
|
587
|
+
class CreateChannelBanRequest < Struct.new(
|
588
|
+
:channel_arn,
|
589
|
+
:member_arn,
|
590
|
+
:chime_bearer)
|
591
|
+
SENSITIVE = []
|
592
|
+
include Aws::Structure
|
593
|
+
end
|
594
|
+
|
595
|
+
# @!attribute [rw] channel_arn
|
596
|
+
# The ARN of the response to the ban request.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] member
|
600
|
+
# The `ChannelArn` and `BannedIdentity` of the member in the ban
|
601
|
+
# response.
|
602
|
+
# @return [Types::Identity]
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelBanResponse AWS API Documentation
|
605
|
+
#
|
606
|
+
class CreateChannelBanResponse < Struct.new(
|
607
|
+
:channel_arn,
|
608
|
+
:member)
|
609
|
+
SENSITIVE = []
|
610
|
+
include Aws::Structure
|
611
|
+
end
|
612
|
+
|
613
|
+
# @note When making an API call, you may pass CreateChannelMembershipRequest
|
614
|
+
# data as a hash:
|
615
|
+
#
|
616
|
+
# {
|
617
|
+
# channel_arn: "ChimeArn", # required
|
618
|
+
# member_arn: "ChimeArn", # required
|
619
|
+
# type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
|
620
|
+
# chime_bearer: "ChimeArn", # required
|
621
|
+
# }
|
622
|
+
#
|
623
|
+
# @!attribute [rw] channel_arn
|
624
|
+
# The ARN of the channel to which you're adding users.
|
625
|
+
# @return [String]
|
626
|
+
#
|
627
|
+
# @!attribute [rw] member_arn
|
628
|
+
# The ARN of the member you want to add to the channel.
|
629
|
+
# @return [String]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] type
|
632
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default
|
633
|
+
# members are always returned as part of `ListChannelMemberships`.
|
634
|
+
# Hidden members are only returned if the type filter in
|
635
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members
|
636
|
+
# are not returned. This is only supported by moderators.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @!attribute [rw] chime_bearer
|
640
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembershipRequest AWS API Documentation
|
644
|
+
#
|
645
|
+
class CreateChannelMembershipRequest < Struct.new(
|
646
|
+
:channel_arn,
|
647
|
+
:member_arn,
|
648
|
+
:type,
|
649
|
+
:chime_bearer)
|
650
|
+
SENSITIVE = []
|
651
|
+
include Aws::Structure
|
652
|
+
end
|
653
|
+
|
654
|
+
# @!attribute [rw] channel_arn
|
655
|
+
# The ARN of the channel.
|
656
|
+
# @return [String]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] member
|
659
|
+
# The ARN and metadata of the member being added.
|
660
|
+
# @return [Types::Identity]
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembershipResponse AWS API Documentation
|
663
|
+
#
|
664
|
+
class CreateChannelMembershipResponse < Struct.new(
|
665
|
+
:channel_arn,
|
666
|
+
:member)
|
667
|
+
SENSITIVE = []
|
668
|
+
include Aws::Structure
|
669
|
+
end
|
670
|
+
|
671
|
+
# @note When making an API call, you may pass CreateChannelModeratorRequest
|
672
|
+
# data as a hash:
|
673
|
+
#
|
674
|
+
# {
|
675
|
+
# channel_arn: "ChimeArn", # required
|
676
|
+
# channel_moderator_arn: "ChimeArn", # required
|
677
|
+
# chime_bearer: "ChimeArn", # required
|
678
|
+
# }
|
679
|
+
#
|
680
|
+
# @!attribute [rw] channel_arn
|
681
|
+
# The ARN of the channel.
|
682
|
+
# @return [String]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] channel_moderator_arn
|
685
|
+
# The ARN of the moderator.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] chime_bearer
|
689
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
690
|
+
# @return [String]
|
691
|
+
#
|
692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelModeratorRequest AWS API Documentation
|
693
|
+
#
|
694
|
+
class CreateChannelModeratorRequest < Struct.new(
|
695
|
+
:channel_arn,
|
696
|
+
:channel_moderator_arn,
|
697
|
+
:chime_bearer)
|
698
|
+
SENSITIVE = []
|
699
|
+
include Aws::Structure
|
700
|
+
end
|
701
|
+
|
702
|
+
# @!attribute [rw] channel_arn
|
703
|
+
# The ARN of the channel.
|
704
|
+
# @return [String]
|
705
|
+
#
|
706
|
+
# @!attribute [rw] channel_moderator
|
707
|
+
# The ARNs of the channel and the moderator.
|
708
|
+
# @return [Types::Identity]
|
709
|
+
#
|
710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelModeratorResponse AWS API Documentation
|
711
|
+
#
|
712
|
+
class CreateChannelModeratorResponse < Struct.new(
|
713
|
+
:channel_arn,
|
714
|
+
:channel_moderator)
|
715
|
+
SENSITIVE = []
|
716
|
+
include Aws::Structure
|
717
|
+
end
|
718
|
+
|
719
|
+
# @note When making an API call, you may pass CreateChannelRequest
|
720
|
+
# data as a hash:
|
721
|
+
#
|
722
|
+
# {
|
723
|
+
# app_instance_arn: "ChimeArn", # required
|
724
|
+
# name: "NonEmptyResourceName", # required
|
725
|
+
# mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
|
726
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
727
|
+
# metadata: "Metadata",
|
728
|
+
# client_request_token: "ClientRequestToken", # required
|
729
|
+
# tags: [
|
730
|
+
# {
|
731
|
+
# key: "TagKey", # required
|
732
|
+
# value: "TagValue", # required
|
733
|
+
# },
|
734
|
+
# ],
|
735
|
+
# chime_bearer: "ChimeArn", # required
|
736
|
+
# }
|
737
|
+
#
|
738
|
+
# @!attribute [rw] app_instance_arn
|
739
|
+
# The ARN of the channel request.
|
740
|
+
# @return [String]
|
741
|
+
#
|
742
|
+
# @!attribute [rw] name
|
743
|
+
# The name of the channel.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] mode
|
747
|
+
# The channel mode: `UNRESTRICTED` or `RESTRICTED`. Administrators,
|
748
|
+
# moderators, and channel members can add themselves and other members
|
749
|
+
# to unrestricted channels. Only administrators and moderators can add
|
750
|
+
# members to restricted channels.
|
751
|
+
# @return [String]
|
752
|
+
#
|
753
|
+
# @!attribute [rw] privacy
|
754
|
+
# The channel's privacy level: `PUBLIC` or `PRIVATE`. Private
|
755
|
+
# channels aren't discoverable by users outside the channel. Public
|
756
|
+
# channels are discoverable by anyone in the `AppInstance`.
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] metadata
|
760
|
+
# The metadata of the creation request. Limited to 1KB and UTF-8.
|
761
|
+
# @return [String]
|
762
|
+
#
|
763
|
+
# @!attribute [rw] client_request_token
|
764
|
+
# The client token for the request. An `Idempotency` token.
|
765
|
+
#
|
766
|
+
# **A suitable default value is auto-generated.** You should normally
|
767
|
+
# not need to pass this option.
|
768
|
+
# @return [String]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] tags
|
771
|
+
# The tags for the creation request.
|
772
|
+
# @return [Array<Types::Tag>]
|
773
|
+
#
|
774
|
+
# @!attribute [rw] chime_bearer
|
775
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
776
|
+
# @return [String]
|
777
|
+
#
|
778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelRequest AWS API Documentation
|
779
|
+
#
|
780
|
+
class CreateChannelRequest < Struct.new(
|
781
|
+
:app_instance_arn,
|
782
|
+
:name,
|
783
|
+
:mode,
|
784
|
+
:privacy,
|
785
|
+
:metadata,
|
786
|
+
:client_request_token,
|
787
|
+
:tags,
|
788
|
+
:chime_bearer)
|
789
|
+
SENSITIVE = [:name, :metadata, :client_request_token]
|
790
|
+
include Aws::Structure
|
791
|
+
end
|
792
|
+
|
793
|
+
# @!attribute [rw] channel_arn
|
794
|
+
# The ARN of the channel.
|
795
|
+
# @return [String]
|
796
|
+
#
|
797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelResponse AWS API Documentation
|
798
|
+
#
|
799
|
+
class CreateChannelResponse < Struct.new(
|
800
|
+
:channel_arn)
|
801
|
+
SENSITIVE = []
|
802
|
+
include Aws::Structure
|
803
|
+
end
|
804
|
+
|
805
|
+
# @note When making an API call, you may pass DeleteChannelBanRequest
|
806
|
+
# data as a hash:
|
807
|
+
#
|
808
|
+
# {
|
809
|
+
# channel_arn: "ChimeArn", # required
|
810
|
+
# member_arn: "ChimeArn", # required
|
811
|
+
# chime_bearer: "ChimeArn", # required
|
812
|
+
# }
|
813
|
+
#
|
814
|
+
# @!attribute [rw] channel_arn
|
815
|
+
# The ARN of the channel from which the `AppInstanceUser` was banned.
|
816
|
+
# @return [String]
|
817
|
+
#
|
818
|
+
# @!attribute [rw] member_arn
|
819
|
+
# The ARN of the `AppInstanceUser` that you want to reinstate.
|
820
|
+
# @return [String]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] chime_bearer
|
823
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
824
|
+
# @return [String]
|
825
|
+
#
|
826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelBanRequest AWS API Documentation
|
827
|
+
#
|
828
|
+
class DeleteChannelBanRequest < Struct.new(
|
829
|
+
:channel_arn,
|
830
|
+
:member_arn,
|
831
|
+
:chime_bearer)
|
832
|
+
SENSITIVE = []
|
833
|
+
include Aws::Structure
|
834
|
+
end
|
835
|
+
|
836
|
+
# @note When making an API call, you may pass DeleteChannelMembershipRequest
|
837
|
+
# data as a hash:
|
838
|
+
#
|
839
|
+
# {
|
840
|
+
# channel_arn: "ChimeArn", # required
|
841
|
+
# member_arn: "ChimeArn", # required
|
842
|
+
# chime_bearer: "ChimeArn", # required
|
843
|
+
# }
|
844
|
+
#
|
845
|
+
# @!attribute [rw] channel_arn
|
846
|
+
# The ARN of the channel from which you want to remove the user.
|
847
|
+
# @return [String]
|
848
|
+
#
|
849
|
+
# @!attribute [rw] member_arn
|
850
|
+
# The ARN of the member that you're removing from the channel.
|
851
|
+
# @return [String]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] chime_bearer
|
854
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembershipRequest AWS API Documentation
|
858
|
+
#
|
859
|
+
class DeleteChannelMembershipRequest < Struct.new(
|
860
|
+
:channel_arn,
|
861
|
+
:member_arn,
|
862
|
+
:chime_bearer)
|
863
|
+
SENSITIVE = []
|
864
|
+
include Aws::Structure
|
865
|
+
end
|
866
|
+
|
867
|
+
# @note When making an API call, you may pass DeleteChannelMessageRequest
|
868
|
+
# data as a hash:
|
869
|
+
#
|
870
|
+
# {
|
871
|
+
# channel_arn: "ChimeArn", # required
|
872
|
+
# message_id: "MessageId", # required
|
873
|
+
# chime_bearer: "ChimeArn", # required
|
874
|
+
# }
|
875
|
+
#
|
876
|
+
# @!attribute [rw] channel_arn
|
877
|
+
# The ARN of the channel.
|
878
|
+
# @return [String]
|
879
|
+
#
|
880
|
+
# @!attribute [rw] message_id
|
881
|
+
# The ID of the message being deleted.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @!attribute [rw] chime_bearer
|
885
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
886
|
+
# @return [String]
|
887
|
+
#
|
888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessageRequest AWS API Documentation
|
889
|
+
#
|
890
|
+
class DeleteChannelMessageRequest < Struct.new(
|
891
|
+
:channel_arn,
|
892
|
+
:message_id,
|
893
|
+
:chime_bearer)
|
894
|
+
SENSITIVE = []
|
895
|
+
include Aws::Structure
|
896
|
+
end
|
897
|
+
|
898
|
+
# @note When making an API call, you may pass DeleteChannelModeratorRequest
|
899
|
+
# data as a hash:
|
900
|
+
#
|
901
|
+
# {
|
902
|
+
# channel_arn: "ChimeArn", # required
|
903
|
+
# channel_moderator_arn: "ChimeArn", # required
|
904
|
+
# chime_bearer: "ChimeArn", # required
|
905
|
+
# }
|
906
|
+
#
|
907
|
+
# @!attribute [rw] channel_arn
|
908
|
+
# The ARN of the channel.
|
909
|
+
# @return [String]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] channel_moderator_arn
|
912
|
+
# The ARN of the moderator being deleted.
|
913
|
+
# @return [String]
|
914
|
+
#
|
915
|
+
# @!attribute [rw] chime_bearer
|
916
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
917
|
+
# @return [String]
|
918
|
+
#
|
919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelModeratorRequest AWS API Documentation
|
920
|
+
#
|
921
|
+
class DeleteChannelModeratorRequest < Struct.new(
|
922
|
+
:channel_arn,
|
923
|
+
:channel_moderator_arn,
|
924
|
+
:chime_bearer)
|
925
|
+
SENSITIVE = []
|
926
|
+
include Aws::Structure
|
927
|
+
end
|
928
|
+
|
929
|
+
# @note When making an API call, you may pass DeleteChannelRequest
|
930
|
+
# data as a hash:
|
931
|
+
#
|
932
|
+
# {
|
933
|
+
# channel_arn: "ChimeArn", # required
|
934
|
+
# chime_bearer: "ChimeArn", # required
|
935
|
+
# }
|
936
|
+
#
|
937
|
+
# @!attribute [rw] channel_arn
|
938
|
+
# The ARN of the channel being deleted.
|
939
|
+
# @return [String]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] chime_bearer
|
942
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelRequest AWS API Documentation
|
946
|
+
#
|
947
|
+
class DeleteChannelRequest < Struct.new(
|
948
|
+
:channel_arn,
|
949
|
+
:chime_bearer)
|
950
|
+
SENSITIVE = []
|
951
|
+
include Aws::Structure
|
952
|
+
end
|
953
|
+
|
954
|
+
# @note When making an API call, you may pass DescribeChannelBanRequest
|
955
|
+
# data as a hash:
|
956
|
+
#
|
957
|
+
# {
|
958
|
+
# channel_arn: "ChimeArn", # required
|
959
|
+
# member_arn: "ChimeArn", # required
|
960
|
+
# chime_bearer: "ChimeArn", # required
|
961
|
+
# }
|
962
|
+
#
|
963
|
+
# @!attribute [rw] channel_arn
|
964
|
+
# The ARN of the channel from which the user is banned.
|
965
|
+
# @return [String]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] member_arn
|
968
|
+
# The ARN of the member being banned.
|
969
|
+
# @return [String]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] chime_bearer
|
972
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelBanRequest AWS API Documentation
|
976
|
+
#
|
977
|
+
class DescribeChannelBanRequest < Struct.new(
|
978
|
+
:channel_arn,
|
979
|
+
:member_arn,
|
980
|
+
:chime_bearer)
|
981
|
+
SENSITIVE = []
|
982
|
+
include Aws::Structure
|
983
|
+
end
|
984
|
+
|
985
|
+
# @!attribute [rw] channel_ban
|
986
|
+
# The details of the ban.
|
987
|
+
# @return [Types::ChannelBan]
|
988
|
+
#
|
989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelBanResponse AWS API Documentation
|
990
|
+
#
|
991
|
+
class DescribeChannelBanResponse < Struct.new(
|
992
|
+
:channel_ban)
|
993
|
+
SENSITIVE = []
|
994
|
+
include Aws::Structure
|
995
|
+
end
|
996
|
+
|
997
|
+
# @note When making an API call, you may pass DescribeChannelMembershipForAppInstanceUserRequest
|
998
|
+
# data as a hash:
|
999
|
+
#
|
1000
|
+
# {
|
1001
|
+
# channel_arn: "ChimeArn", # required
|
1002
|
+
# app_instance_user_arn: "ChimeArn", # required
|
1003
|
+
# chime_bearer: "ChimeArn", # required
|
1004
|
+
# }
|
1005
|
+
#
|
1006
|
+
# @!attribute [rw] channel_arn
|
1007
|
+
# The ARN of the channel to which the user belongs.
|
1008
|
+
# @return [String]
|
1009
|
+
#
|
1010
|
+
# @!attribute [rw] app_instance_user_arn
|
1011
|
+
# The ARN of the user in a channel.
|
1012
|
+
# @return [String]
|
1013
|
+
#
|
1014
|
+
# @!attribute [rw] chime_bearer
|
1015
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1016
|
+
# @return [String]
|
1017
|
+
#
|
1018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUserRequest AWS API Documentation
|
1019
|
+
#
|
1020
|
+
class DescribeChannelMembershipForAppInstanceUserRequest < Struct.new(
|
1021
|
+
:channel_arn,
|
1022
|
+
:app_instance_user_arn,
|
1023
|
+
:chime_bearer)
|
1024
|
+
SENSITIVE = []
|
1025
|
+
include Aws::Structure
|
1026
|
+
end
|
1027
|
+
|
1028
|
+
# @!attribute [rw] channel_membership
|
1029
|
+
# The channel to which a user belongs.
|
1030
|
+
# @return [Types::ChannelMembershipForAppInstanceUserSummary]
|
1031
|
+
#
|
1032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUserResponse AWS API Documentation
|
1033
|
+
#
|
1034
|
+
class DescribeChannelMembershipForAppInstanceUserResponse < Struct.new(
|
1035
|
+
:channel_membership)
|
1036
|
+
SENSITIVE = []
|
1037
|
+
include Aws::Structure
|
1038
|
+
end
|
1039
|
+
|
1040
|
+
# @note When making an API call, you may pass DescribeChannelMembershipRequest
|
1041
|
+
# data as a hash:
|
1042
|
+
#
|
1043
|
+
# {
|
1044
|
+
# channel_arn: "ChimeArn", # required
|
1045
|
+
# member_arn: "ChimeArn", # required
|
1046
|
+
# chime_bearer: "ChimeArn", # required
|
1047
|
+
# }
|
1048
|
+
#
|
1049
|
+
# @!attribute [rw] channel_arn
|
1050
|
+
# The ARN of the channel.
|
1051
|
+
# @return [String]
|
1052
|
+
#
|
1053
|
+
# @!attribute [rw] member_arn
|
1054
|
+
# The ARN of the member.
|
1055
|
+
# @return [String]
|
1056
|
+
#
|
1057
|
+
# @!attribute [rw] chime_bearer
|
1058
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipRequest AWS API Documentation
|
1062
|
+
#
|
1063
|
+
class DescribeChannelMembershipRequest < Struct.new(
|
1064
|
+
:channel_arn,
|
1065
|
+
:member_arn,
|
1066
|
+
:chime_bearer)
|
1067
|
+
SENSITIVE = []
|
1068
|
+
include Aws::Structure
|
1069
|
+
end
|
1070
|
+
|
1071
|
+
# @!attribute [rw] channel_membership
|
1072
|
+
# The details of the membership.
|
1073
|
+
# @return [Types::ChannelMembership]
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipResponse AWS API Documentation
|
1076
|
+
#
|
1077
|
+
class DescribeChannelMembershipResponse < Struct.new(
|
1078
|
+
:channel_membership)
|
1079
|
+
SENSITIVE = []
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# @note When making an API call, you may pass DescribeChannelModeratedByAppInstanceUserRequest
|
1084
|
+
# data as a hash:
|
1085
|
+
#
|
1086
|
+
# {
|
1087
|
+
# channel_arn: "ChimeArn", # required
|
1088
|
+
# app_instance_user_arn: "ChimeArn", # required
|
1089
|
+
# chime_bearer: "ChimeArn", # required
|
1090
|
+
# }
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] channel_arn
|
1093
|
+
# The ARN of the moderated channel.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] app_instance_user_arn
|
1097
|
+
# The ARN of the `AppInstanceUser` in the moderated channel.
|
1098
|
+
# @return [String]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] chime_bearer
|
1101
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1102
|
+
# @return [String]
|
1103
|
+
#
|
1104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUserRequest AWS API Documentation
|
1105
|
+
#
|
1106
|
+
class DescribeChannelModeratedByAppInstanceUserRequest < Struct.new(
|
1107
|
+
:channel_arn,
|
1108
|
+
:app_instance_user_arn,
|
1109
|
+
:chime_bearer)
|
1110
|
+
SENSITIVE = []
|
1111
|
+
include Aws::Structure
|
1112
|
+
end
|
1113
|
+
|
1114
|
+
# @!attribute [rw] channel
|
1115
|
+
# The moderated channel.
|
1116
|
+
# @return [Types::ChannelModeratedByAppInstanceUserSummary]
|
1117
|
+
#
|
1118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUserResponse AWS API Documentation
|
1119
|
+
#
|
1120
|
+
class DescribeChannelModeratedByAppInstanceUserResponse < Struct.new(
|
1121
|
+
:channel)
|
1122
|
+
SENSITIVE = []
|
1123
|
+
include Aws::Structure
|
1124
|
+
end
|
1125
|
+
|
1126
|
+
# @note When making an API call, you may pass DescribeChannelModeratorRequest
|
1127
|
+
# data as a hash:
|
1128
|
+
#
|
1129
|
+
# {
|
1130
|
+
# channel_arn: "ChimeArn", # required
|
1131
|
+
# channel_moderator_arn: "ChimeArn", # required
|
1132
|
+
# chime_bearer: "ChimeArn", # required
|
1133
|
+
# }
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] channel_arn
|
1136
|
+
# The ARN of the channel.
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] channel_moderator_arn
|
1140
|
+
# The ARN of the channel moderator.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @!attribute [rw] chime_bearer
|
1144
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1145
|
+
# @return [String]
|
1146
|
+
#
|
1147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModeratorRequest AWS API Documentation
|
1148
|
+
#
|
1149
|
+
class DescribeChannelModeratorRequest < Struct.new(
|
1150
|
+
:channel_arn,
|
1151
|
+
:channel_moderator_arn,
|
1152
|
+
:chime_bearer)
|
1153
|
+
SENSITIVE = []
|
1154
|
+
include Aws::Structure
|
1155
|
+
end
|
1156
|
+
|
1157
|
+
# @!attribute [rw] channel_moderator
|
1158
|
+
# The details of the channel moderator.
|
1159
|
+
# @return [Types::ChannelModerator]
|
1160
|
+
#
|
1161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModeratorResponse AWS API Documentation
|
1162
|
+
#
|
1163
|
+
class DescribeChannelModeratorResponse < Struct.new(
|
1164
|
+
:channel_moderator)
|
1165
|
+
SENSITIVE = []
|
1166
|
+
include Aws::Structure
|
1167
|
+
end
|
1168
|
+
|
1169
|
+
# @note When making an API call, you may pass DescribeChannelRequest
|
1170
|
+
# data as a hash:
|
1171
|
+
#
|
1172
|
+
# {
|
1173
|
+
# channel_arn: "ChimeArn", # required
|
1174
|
+
# chime_bearer: "ChimeArn", # required
|
1175
|
+
# }
|
1176
|
+
#
|
1177
|
+
# @!attribute [rw] channel_arn
|
1178
|
+
# The ARN of the channel.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] chime_bearer
|
1182
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1183
|
+
# @return [String]
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelRequest AWS API Documentation
|
1186
|
+
#
|
1187
|
+
class DescribeChannelRequest < Struct.new(
|
1188
|
+
:channel_arn,
|
1189
|
+
:chime_bearer)
|
1190
|
+
SENSITIVE = []
|
1191
|
+
include Aws::Structure
|
1192
|
+
end
|
1193
|
+
|
1194
|
+
# @!attribute [rw] channel
|
1195
|
+
# The channel details.
|
1196
|
+
# @return [Types::Channel]
|
1197
|
+
#
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelResponse AWS API Documentation
|
1199
|
+
#
|
1200
|
+
class DescribeChannelResponse < Struct.new(
|
1201
|
+
:channel)
|
1202
|
+
SENSITIVE = []
|
1203
|
+
include Aws::Structure
|
1204
|
+
end
|
1205
|
+
|
1206
|
+
# The client is permanently forbidden from making the request.
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] code
|
1209
|
+
# @return [String]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] message
|
1212
|
+
# @return [String]
|
1213
|
+
#
|
1214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ForbiddenException AWS API Documentation
|
1215
|
+
#
|
1216
|
+
class ForbiddenException < Struct.new(
|
1217
|
+
:code,
|
1218
|
+
:message)
|
1219
|
+
SENSITIVE = []
|
1220
|
+
include Aws::Structure
|
1221
|
+
end
|
1222
|
+
|
1223
|
+
# @note When making an API call, you may pass GetChannelMessageRequest
|
1224
|
+
# data as a hash:
|
1225
|
+
#
|
1226
|
+
# {
|
1227
|
+
# channel_arn: "ChimeArn", # required
|
1228
|
+
# message_id: "MessageId", # required
|
1229
|
+
# chime_bearer: "ChimeArn", # required
|
1230
|
+
# }
|
1231
|
+
#
|
1232
|
+
# @!attribute [rw] channel_arn
|
1233
|
+
# The ARN of the channel.
|
1234
|
+
# @return [String]
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] message_id
|
1237
|
+
# The ID of the message.
|
1238
|
+
# @return [String]
|
1239
|
+
#
|
1240
|
+
# @!attribute [rw] chime_bearer
|
1241
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1242
|
+
# @return [String]
|
1243
|
+
#
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageRequest AWS API Documentation
|
1245
|
+
#
|
1246
|
+
class GetChannelMessageRequest < Struct.new(
|
1247
|
+
:channel_arn,
|
1248
|
+
:message_id,
|
1249
|
+
:chime_bearer)
|
1250
|
+
SENSITIVE = []
|
1251
|
+
include Aws::Structure
|
1252
|
+
end
|
1253
|
+
|
1254
|
+
# @!attribute [rw] channel_message
|
1255
|
+
# The details of and content in the message.
|
1256
|
+
# @return [Types::ChannelMessage]
|
1257
|
+
#
|
1258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageResponse AWS API Documentation
|
1259
|
+
#
|
1260
|
+
class GetChannelMessageResponse < Struct.new(
|
1261
|
+
:channel_message)
|
1262
|
+
SENSITIVE = []
|
1263
|
+
include Aws::Structure
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
# @api private
|
1267
|
+
#
|
1268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpointRequest AWS API Documentation
|
1269
|
+
#
|
1270
|
+
class GetMessagingSessionEndpointRequest < Aws::EmptyStructure; end
|
1271
|
+
|
1272
|
+
# @!attribute [rw] endpoint
|
1273
|
+
# The endpoint returned in the response.
|
1274
|
+
# @return [Types::MessagingSessionEndpoint]
|
1275
|
+
#
|
1276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpointResponse AWS API Documentation
|
1277
|
+
#
|
1278
|
+
class GetMessagingSessionEndpointResponse < Struct.new(
|
1279
|
+
:endpoint)
|
1280
|
+
SENSITIVE = []
|
1281
|
+
include Aws::Structure
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# The details of a user.
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] arn
|
1287
|
+
# The ARN in an Identity.
|
1288
|
+
# @return [String]
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] name
|
1291
|
+
# The name in an Identity.
|
1292
|
+
# @return [String]
|
1293
|
+
#
|
1294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Identity AWS API Documentation
|
1295
|
+
#
|
1296
|
+
class Identity < Struct.new(
|
1297
|
+
:arn,
|
1298
|
+
:name)
|
1299
|
+
SENSITIVE = [:name]
|
1300
|
+
include Aws::Structure
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# @note When making an API call, you may pass ListChannelBansRequest
|
1304
|
+
# data as a hash:
|
1305
|
+
#
|
1306
|
+
# {
|
1307
|
+
# channel_arn: "ChimeArn", # required
|
1308
|
+
# max_results: 1,
|
1309
|
+
# next_token: "NextToken",
|
1310
|
+
# chime_bearer: "ChimeArn", # required
|
1311
|
+
# }
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] channel_arn
|
1314
|
+
# The ARN of the channel.
|
1315
|
+
# @return [String]
|
1316
|
+
#
|
1317
|
+
# @!attribute [rw] max_results
|
1318
|
+
# The maximum number of bans that you want returned.
|
1319
|
+
# @return [Integer]
|
1320
|
+
#
|
1321
|
+
# @!attribute [rw] next_token
|
1322
|
+
# The token passed by previous API calls until all requested bans are
|
1323
|
+
# returned.
|
1324
|
+
# @return [String]
|
1325
|
+
#
|
1326
|
+
# @!attribute [rw] chime_bearer
|
1327
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1328
|
+
# @return [String]
|
1329
|
+
#
|
1330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelBansRequest AWS API Documentation
|
1331
|
+
#
|
1332
|
+
class ListChannelBansRequest < Struct.new(
|
1333
|
+
:channel_arn,
|
1334
|
+
:max_results,
|
1335
|
+
:next_token,
|
1336
|
+
:chime_bearer)
|
1337
|
+
SENSITIVE = [:next_token]
|
1338
|
+
include Aws::Structure
|
1339
|
+
end
|
1340
|
+
|
1341
|
+
# @!attribute [rw] channel_arn
|
1342
|
+
# The ARN of the channel.
|
1343
|
+
# @return [String]
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] next_token
|
1346
|
+
# The token passed by previous API calls until all requested bans are
|
1347
|
+
# returned.
|
1348
|
+
# @return [String]
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] channel_bans
|
1351
|
+
# The information for each requested ban.
|
1352
|
+
# @return [Array<Types::ChannelBanSummary>]
|
1353
|
+
#
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelBansResponse AWS API Documentation
|
1355
|
+
#
|
1356
|
+
class ListChannelBansResponse < Struct.new(
|
1357
|
+
:channel_arn,
|
1358
|
+
:next_token,
|
1359
|
+
:channel_bans)
|
1360
|
+
SENSITIVE = [:next_token]
|
1361
|
+
include Aws::Structure
|
1362
|
+
end
|
1363
|
+
|
1364
|
+
# @note When making an API call, you may pass ListChannelMembershipsForAppInstanceUserRequest
|
1365
|
+
# data as a hash:
|
1366
|
+
#
|
1367
|
+
# {
|
1368
|
+
# app_instance_user_arn: "ChimeArn",
|
1369
|
+
# max_results: 1,
|
1370
|
+
# next_token: "NextToken",
|
1371
|
+
# chime_bearer: "ChimeArn", # required
|
1372
|
+
# }
|
1373
|
+
#
|
1374
|
+
# @!attribute [rw] app_instance_user_arn
|
1375
|
+
# The ARN of the `AppInstanceUser`s
|
1376
|
+
# @return [String]
|
1377
|
+
#
|
1378
|
+
# @!attribute [rw] max_results
|
1379
|
+
# The maximum number of users that you want returned.
|
1380
|
+
# @return [Integer]
|
1381
|
+
#
|
1382
|
+
# @!attribute [rw] next_token
|
1383
|
+
# The token returned from previous API requests until the number of
|
1384
|
+
# channel memberships is reached.
|
1385
|
+
# @return [String]
|
1386
|
+
#
|
1387
|
+
# @!attribute [rw] chime_bearer
|
1388
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1389
|
+
# @return [String]
|
1390
|
+
#
|
1391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUserRequest AWS API Documentation
|
1392
|
+
#
|
1393
|
+
class ListChannelMembershipsForAppInstanceUserRequest < Struct.new(
|
1394
|
+
:app_instance_user_arn,
|
1395
|
+
:max_results,
|
1396
|
+
:next_token,
|
1397
|
+
:chime_bearer)
|
1398
|
+
SENSITIVE = [:next_token]
|
1399
|
+
include Aws::Structure
|
1400
|
+
end
|
1401
|
+
|
1402
|
+
# @!attribute [rw] channel_memberships
|
1403
|
+
# The token passed by previous API calls until all requested users are
|
1404
|
+
# returned.
|
1405
|
+
# @return [Array<Types::ChannelMembershipForAppInstanceUserSummary>]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] next_token
|
1408
|
+
# The token passed by previous API calls until all requested users are
|
1409
|
+
# returned.
|
1410
|
+
# @return [String]
|
1411
|
+
#
|
1412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUserResponse AWS API Documentation
|
1413
|
+
#
|
1414
|
+
class ListChannelMembershipsForAppInstanceUserResponse < Struct.new(
|
1415
|
+
:channel_memberships,
|
1416
|
+
:next_token)
|
1417
|
+
SENSITIVE = [:next_token]
|
1418
|
+
include Aws::Structure
|
1419
|
+
end
|
1420
|
+
|
1421
|
+
# @note When making an API call, you may pass ListChannelMembershipsRequest
|
1422
|
+
# data as a hash:
|
1423
|
+
#
|
1424
|
+
# {
|
1425
|
+
# channel_arn: "ChimeArn", # required
|
1426
|
+
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
1427
|
+
# max_results: 1,
|
1428
|
+
# next_token: "NextToken",
|
1429
|
+
# chime_bearer: "ChimeArn", # required
|
1430
|
+
# }
|
1431
|
+
#
|
1432
|
+
# @!attribute [rw] channel_arn
|
1433
|
+
# The maximum number of channel memberships that you want returned.
|
1434
|
+
# @return [String]
|
1435
|
+
#
|
1436
|
+
# @!attribute [rw] type
|
1437
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default
|
1438
|
+
# members are always returned as part of `ListChannelMemberships`.
|
1439
|
+
# Hidden members are only returned if the type filter in
|
1440
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members
|
1441
|
+
# are not returned.
|
1442
|
+
# @return [String]
|
1443
|
+
#
|
1444
|
+
# @!attribute [rw] max_results
|
1445
|
+
# The maximum number of channel memberships that you want returned.
|
1446
|
+
# @return [Integer]
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] next_token
|
1449
|
+
# The token passed by previous API calls until all requested channel
|
1450
|
+
# memberships are returned.
|
1451
|
+
# @return [String]
|
1452
|
+
#
|
1453
|
+
# @!attribute [rw] chime_bearer
|
1454
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1455
|
+
# @return [String]
|
1456
|
+
#
|
1457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsRequest AWS API Documentation
|
1458
|
+
#
|
1459
|
+
class ListChannelMembershipsRequest < Struct.new(
|
1460
|
+
:channel_arn,
|
1461
|
+
:type,
|
1462
|
+
:max_results,
|
1463
|
+
:next_token,
|
1464
|
+
:chime_bearer)
|
1465
|
+
SENSITIVE = [:next_token]
|
1466
|
+
include Aws::Structure
|
1467
|
+
end
|
1468
|
+
|
1469
|
+
# @!attribute [rw] channel_arn
|
1470
|
+
# The ARN of the channel.
|
1471
|
+
# @return [String]
|
1472
|
+
#
|
1473
|
+
# @!attribute [rw] channel_memberships
|
1474
|
+
# The information for the requested channel memberships.
|
1475
|
+
# @return [Array<Types::ChannelMembershipSummary>]
|
1476
|
+
#
|
1477
|
+
# @!attribute [rw] next_token
|
1478
|
+
# The token passed by previous API calls until all requested channel
|
1479
|
+
# memberships are returned.
|
1480
|
+
# @return [String]
|
1481
|
+
#
|
1482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsResponse AWS API Documentation
|
1483
|
+
#
|
1484
|
+
class ListChannelMembershipsResponse < Struct.new(
|
1485
|
+
:channel_arn,
|
1486
|
+
:channel_memberships,
|
1487
|
+
:next_token)
|
1488
|
+
SENSITIVE = [:next_token]
|
1489
|
+
include Aws::Structure
|
1490
|
+
end
|
1491
|
+
|
1492
|
+
# @note When making an API call, you may pass ListChannelMessagesRequest
|
1493
|
+
# data as a hash:
|
1494
|
+
#
|
1495
|
+
# {
|
1496
|
+
# channel_arn: "ChimeArn", # required
|
1497
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1498
|
+
# not_before: Time.now,
|
1499
|
+
# not_after: Time.now,
|
1500
|
+
# max_results: 1,
|
1501
|
+
# next_token: "NextToken",
|
1502
|
+
# chime_bearer: "ChimeArn", # required
|
1503
|
+
# }
|
1504
|
+
#
|
1505
|
+
# @!attribute [rw] channel_arn
|
1506
|
+
# The ARN of the channel.
|
1507
|
+
# @return [String]
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] sort_order
|
1510
|
+
# The order in which you want messages sorted. Default is Descending,
|
1511
|
+
# based on time created.
|
1512
|
+
# @return [String]
|
1513
|
+
#
|
1514
|
+
# @!attribute [rw] not_before
|
1515
|
+
# The initial or starting time stamp for your requested messages.
|
1516
|
+
# @return [Time]
|
1517
|
+
#
|
1518
|
+
# @!attribute [rw] not_after
|
1519
|
+
# The final or ending time stamp for your requested messages.
|
1520
|
+
# @return [Time]
|
1521
|
+
#
|
1522
|
+
# @!attribute [rw] max_results
|
1523
|
+
# The maximum number of messages that you want returned.
|
1524
|
+
# @return [Integer]
|
1525
|
+
#
|
1526
|
+
# @!attribute [rw] next_token
|
1527
|
+
# The token passed by previous API calls until all requested messages
|
1528
|
+
# are returned.
|
1529
|
+
# @return [String]
|
1530
|
+
#
|
1531
|
+
# @!attribute [rw] chime_bearer
|
1532
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1533
|
+
# @return [String]
|
1534
|
+
#
|
1535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessagesRequest AWS API Documentation
|
1536
|
+
#
|
1537
|
+
class ListChannelMessagesRequest < Struct.new(
|
1538
|
+
:channel_arn,
|
1539
|
+
:sort_order,
|
1540
|
+
:not_before,
|
1541
|
+
:not_after,
|
1542
|
+
:max_results,
|
1543
|
+
:next_token,
|
1544
|
+
:chime_bearer)
|
1545
|
+
SENSITIVE = [:next_token]
|
1546
|
+
include Aws::Structure
|
1547
|
+
end
|
1548
|
+
|
1549
|
+
# @!attribute [rw] channel_arn
|
1550
|
+
# The ARN of the channel containing the requested messages.
|
1551
|
+
# @return [String]
|
1552
|
+
#
|
1553
|
+
# @!attribute [rw] next_token
|
1554
|
+
# The token passed by previous API calls until all requested messages
|
1555
|
+
# are returned.
|
1556
|
+
# @return [String]
|
1557
|
+
#
|
1558
|
+
# @!attribute [rw] channel_messages
|
1559
|
+
# The information about, and content of, each requested message.
|
1560
|
+
# @return [Array<Types::ChannelMessageSummary>]
|
1561
|
+
#
|
1562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessagesResponse AWS API Documentation
|
1563
|
+
#
|
1564
|
+
class ListChannelMessagesResponse < Struct.new(
|
1565
|
+
:channel_arn,
|
1566
|
+
:next_token,
|
1567
|
+
:channel_messages)
|
1568
|
+
SENSITIVE = [:next_token]
|
1569
|
+
include Aws::Structure
|
1570
|
+
end
|
1571
|
+
|
1572
|
+
# @note When making an API call, you may pass ListChannelModeratorsRequest
|
1573
|
+
# data as a hash:
|
1574
|
+
#
|
1575
|
+
# {
|
1576
|
+
# channel_arn: "ChimeArn", # required
|
1577
|
+
# max_results: 1,
|
1578
|
+
# next_token: "NextToken",
|
1579
|
+
# chime_bearer: "ChimeArn", # required
|
1580
|
+
# }
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] channel_arn
|
1583
|
+
# The ARN of the channel.
|
1584
|
+
# @return [String]
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] max_results
|
1587
|
+
# The maximum number of moderators that you want returned.
|
1588
|
+
# @return [Integer]
|
1589
|
+
#
|
1590
|
+
# @!attribute [rw] next_token
|
1591
|
+
# The token passed by previous API calls until all requested
|
1592
|
+
# moderators are returned.
|
1593
|
+
# @return [String]
|
1594
|
+
#
|
1595
|
+
# @!attribute [rw] chime_bearer
|
1596
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1597
|
+
# @return [String]
|
1598
|
+
#
|
1599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelModeratorsRequest AWS API Documentation
|
1600
|
+
#
|
1601
|
+
class ListChannelModeratorsRequest < Struct.new(
|
1602
|
+
:channel_arn,
|
1603
|
+
:max_results,
|
1604
|
+
:next_token,
|
1605
|
+
:chime_bearer)
|
1606
|
+
SENSITIVE = [:next_token]
|
1607
|
+
include Aws::Structure
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
# @!attribute [rw] channel_arn
|
1611
|
+
# The ARN of the channel.
|
1612
|
+
# @return [String]
|
1613
|
+
#
|
1614
|
+
# @!attribute [rw] next_token
|
1615
|
+
# The token passed by previous API calls until all requested
|
1616
|
+
# moderators are returned.
|
1617
|
+
# @return [String]
|
1618
|
+
#
|
1619
|
+
# @!attribute [rw] channel_moderators
|
1620
|
+
# The information about and names of each moderator.
|
1621
|
+
# @return [Array<Types::ChannelModeratorSummary>]
|
1622
|
+
#
|
1623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelModeratorsResponse AWS API Documentation
|
1624
|
+
#
|
1625
|
+
class ListChannelModeratorsResponse < Struct.new(
|
1626
|
+
:channel_arn,
|
1627
|
+
:next_token,
|
1628
|
+
:channel_moderators)
|
1629
|
+
SENSITIVE = [:next_token]
|
1630
|
+
include Aws::Structure
|
1631
|
+
end
|
1632
|
+
|
1633
|
+
# @note When making an API call, you may pass ListChannelsModeratedByAppInstanceUserRequest
|
1634
|
+
# data as a hash:
|
1635
|
+
#
|
1636
|
+
# {
|
1637
|
+
# app_instance_user_arn: "ChimeArn",
|
1638
|
+
# max_results: 1,
|
1639
|
+
# next_token: "NextToken",
|
1640
|
+
# chime_bearer: "ChimeArn", # required
|
1641
|
+
# }
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] app_instance_user_arn
|
1644
|
+
# The ARN of the user in the moderated channel.
|
1645
|
+
# @return [String]
|
1646
|
+
#
|
1647
|
+
# @!attribute [rw] max_results
|
1648
|
+
# The maximum number of channels in the request.
|
1649
|
+
# @return [Integer]
|
1650
|
+
#
|
1651
|
+
# @!attribute [rw] next_token
|
1652
|
+
# The token returned from previous API requests until the number of
|
1653
|
+
# channels moderated by the user is reached.
|
1654
|
+
# @return [String]
|
1655
|
+
#
|
1656
|
+
# @!attribute [rw] chime_bearer
|
1657
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1658
|
+
# @return [String]
|
1659
|
+
#
|
1660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUserRequest AWS API Documentation
|
1661
|
+
#
|
1662
|
+
class ListChannelsModeratedByAppInstanceUserRequest < Struct.new(
|
1663
|
+
:app_instance_user_arn,
|
1664
|
+
:max_results,
|
1665
|
+
:next_token,
|
1666
|
+
:chime_bearer)
|
1667
|
+
SENSITIVE = [:next_token]
|
1668
|
+
include Aws::Structure
|
1669
|
+
end
|
1670
|
+
|
1671
|
+
# @!attribute [rw] channels
|
1672
|
+
# The moderated channels in the request.
|
1673
|
+
# @return [Array<Types::ChannelModeratedByAppInstanceUserSummary>]
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] next_token
|
1676
|
+
# The token returned from previous API requests until the number of
|
1677
|
+
# channels moderated by the user is reached.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUserResponse AWS API Documentation
|
1681
|
+
#
|
1682
|
+
class ListChannelsModeratedByAppInstanceUserResponse < Struct.new(
|
1683
|
+
:channels,
|
1684
|
+
:next_token)
|
1685
|
+
SENSITIVE = [:next_token]
|
1686
|
+
include Aws::Structure
|
1687
|
+
end
|
1688
|
+
|
1689
|
+
# @note When making an API call, you may pass ListChannelsRequest
|
1690
|
+
# data as a hash:
|
1691
|
+
#
|
1692
|
+
# {
|
1693
|
+
# app_instance_arn: "ChimeArn", # required
|
1694
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
1695
|
+
# max_results: 1,
|
1696
|
+
# next_token: "NextToken",
|
1697
|
+
# chime_bearer: "ChimeArn", # required
|
1698
|
+
# }
|
1699
|
+
#
|
1700
|
+
# @!attribute [rw] app_instance_arn
|
1701
|
+
# The ARN of the `AppInstance`.
|
1702
|
+
# @return [String]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] privacy
|
1705
|
+
# The privacy setting. `PUBLIC` retrieves all the public channels.
|
1706
|
+
# `PRIVATE` retrieves private channels. Only an `AppInstanceAdmin` can
|
1707
|
+
# retrieve private channels.
|
1708
|
+
# @return [String]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] max_results
|
1711
|
+
# The maximum number of channels that you want to return.
|
1712
|
+
# @return [Integer]
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] next_token
|
1715
|
+
# The token passed by previous API calls until all requested channels
|
1716
|
+
# are returned.
|
1717
|
+
# @return [String]
|
1718
|
+
#
|
1719
|
+
# @!attribute [rw] chime_bearer
|
1720
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1721
|
+
# @return [String]
|
1722
|
+
#
|
1723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsRequest AWS API Documentation
|
1724
|
+
#
|
1725
|
+
class ListChannelsRequest < Struct.new(
|
1726
|
+
:app_instance_arn,
|
1727
|
+
:privacy,
|
1728
|
+
:max_results,
|
1729
|
+
:next_token,
|
1730
|
+
:chime_bearer)
|
1731
|
+
SENSITIVE = [:next_token]
|
1732
|
+
include Aws::Structure
|
1733
|
+
end
|
1734
|
+
|
1735
|
+
# @!attribute [rw] channels
|
1736
|
+
# The information about each channel.
|
1737
|
+
# @return [Array<Types::ChannelSummary>]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] next_token
|
1740
|
+
# The token returned from previous API requests until the number of
|
1741
|
+
# channels is reached.
|
1742
|
+
# @return [String]
|
1743
|
+
#
|
1744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsResponse AWS API Documentation
|
1745
|
+
#
|
1746
|
+
class ListChannelsResponse < Struct.new(
|
1747
|
+
:channels,
|
1748
|
+
:next_token)
|
1749
|
+
SENSITIVE = [:next_token]
|
1750
|
+
include Aws::Structure
|
1751
|
+
end
|
1752
|
+
|
1753
|
+
# The websocket endpoint used to connect to Amazon Chime SDK messaging.
|
1754
|
+
#
|
1755
|
+
# @!attribute [rw] url
|
1756
|
+
# The endpoint to which you establish a websocket connection.
|
1757
|
+
# @return [String]
|
1758
|
+
#
|
1759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/MessagingSessionEndpoint AWS API Documentation
|
1760
|
+
#
|
1761
|
+
class MessagingSessionEndpoint < Struct.new(
|
1762
|
+
:url)
|
1763
|
+
SENSITIVE = []
|
1764
|
+
include Aws::Structure
|
1765
|
+
end
|
1766
|
+
|
1767
|
+
# One or more of the resources in the request does not exist in the
|
1768
|
+
# system.
|
1769
|
+
#
|
1770
|
+
# @!attribute [rw] code
|
1771
|
+
# @return [String]
|
1772
|
+
#
|
1773
|
+
# @!attribute [rw] message
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/NotFoundException AWS API Documentation
|
1777
|
+
#
|
1778
|
+
class NotFoundException < Struct.new(
|
1779
|
+
:code,
|
1780
|
+
:message)
|
1781
|
+
SENSITIVE = []
|
1782
|
+
include Aws::Structure
|
1783
|
+
end
|
1784
|
+
|
1785
|
+
# @note When making an API call, you may pass RedactChannelMessageRequest
|
1786
|
+
# data as a hash:
|
1787
|
+
#
|
1788
|
+
# {
|
1789
|
+
# channel_arn: "ChimeArn", # required
|
1790
|
+
# message_id: "MessageId", # required
|
1791
|
+
# chime_bearer: "ChimeArn", # required
|
1792
|
+
# }
|
1793
|
+
#
|
1794
|
+
# @!attribute [rw] channel_arn
|
1795
|
+
# The ARN of the channel containing the messages that you want to
|
1796
|
+
# redact.
|
1797
|
+
# @return [String]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] message_id
|
1800
|
+
# The ID of the message being redacted.
|
1801
|
+
# @return [String]
|
1802
|
+
#
|
1803
|
+
# @!attribute [rw] chime_bearer
|
1804
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1805
|
+
# @return [String]
|
1806
|
+
#
|
1807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessageRequest AWS API Documentation
|
1808
|
+
#
|
1809
|
+
class RedactChannelMessageRequest < Struct.new(
|
1810
|
+
:channel_arn,
|
1811
|
+
:message_id,
|
1812
|
+
:chime_bearer)
|
1813
|
+
SENSITIVE = []
|
1814
|
+
include Aws::Structure
|
1815
|
+
end
|
1816
|
+
|
1817
|
+
# @!attribute [rw] channel_arn
|
1818
|
+
# The ARN of the channel containing the messages that you want to
|
1819
|
+
# redact.
|
1820
|
+
# @return [String]
|
1821
|
+
#
|
1822
|
+
# @!attribute [rw] message_id
|
1823
|
+
# The ID of the message being redacted.
|
1824
|
+
# @return [String]
|
1825
|
+
#
|
1826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessageResponse AWS API Documentation
|
1827
|
+
#
|
1828
|
+
class RedactChannelMessageResponse < Struct.new(
|
1829
|
+
:channel_arn,
|
1830
|
+
:message_id)
|
1831
|
+
SENSITIVE = []
|
1832
|
+
include Aws::Structure
|
1833
|
+
end
|
1834
|
+
|
1835
|
+
# The request exceeds the resource limit.
|
1836
|
+
#
|
1837
|
+
# @!attribute [rw] code
|
1838
|
+
# @return [String]
|
1839
|
+
#
|
1840
|
+
# @!attribute [rw] message
|
1841
|
+
# @return [String]
|
1842
|
+
#
|
1843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ResourceLimitExceededException AWS API Documentation
|
1844
|
+
#
|
1845
|
+
class ResourceLimitExceededException < Struct.new(
|
1846
|
+
:code,
|
1847
|
+
:message)
|
1848
|
+
SENSITIVE = []
|
1849
|
+
include Aws::Structure
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
# @note When making an API call, you may pass SendChannelMessageRequest
|
1853
|
+
# data as a hash:
|
1854
|
+
#
|
1855
|
+
# {
|
1856
|
+
# channel_arn: "ChimeArn", # required
|
1857
|
+
# content: "NonEmptyContent", # required
|
1858
|
+
# type: "STANDARD", # required, accepts STANDARD, CONTROL
|
1859
|
+
# persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
|
1860
|
+
# metadata: "Metadata",
|
1861
|
+
# client_request_token: "ClientRequestToken", # required
|
1862
|
+
# chime_bearer: "ChimeArn", # required
|
1863
|
+
# }
|
1864
|
+
#
|
1865
|
+
# @!attribute [rw] channel_arn
|
1866
|
+
# The ARN of the channel.
|
1867
|
+
# @return [String]
|
1868
|
+
#
|
1869
|
+
# @!attribute [rw] content
|
1870
|
+
# The content of the message.
|
1871
|
+
# @return [String]
|
1872
|
+
#
|
1873
|
+
# @!attribute [rw] type
|
1874
|
+
# The type of message, `STANDARD` or `CONTROL`.
|
1875
|
+
# @return [String]
|
1876
|
+
#
|
1877
|
+
# @!attribute [rw] persistence
|
1878
|
+
# Boolean that controls whether the message is persisted on the back
|
1879
|
+
# end. Required.
|
1880
|
+
# @return [String]
|
1881
|
+
#
|
1882
|
+
# @!attribute [rw] metadata
|
1883
|
+
# The optional metadata for each message.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] client_request_token
|
1887
|
+
# The `Idempotency` token for each client request.
|
1888
|
+
#
|
1889
|
+
# **A suitable default value is auto-generated.** You should normally
|
1890
|
+
# not need to pass this option.
|
1891
|
+
# @return [String]
|
1892
|
+
#
|
1893
|
+
# @!attribute [rw] chime_bearer
|
1894
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1895
|
+
# @return [String]
|
1896
|
+
#
|
1897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageRequest AWS API Documentation
|
1898
|
+
#
|
1899
|
+
class SendChannelMessageRequest < Struct.new(
|
1900
|
+
:channel_arn,
|
1901
|
+
:content,
|
1902
|
+
:type,
|
1903
|
+
:persistence,
|
1904
|
+
:metadata,
|
1905
|
+
:client_request_token,
|
1906
|
+
:chime_bearer)
|
1907
|
+
SENSITIVE = [:content, :metadata, :client_request_token]
|
1908
|
+
include Aws::Structure
|
1909
|
+
end
|
1910
|
+
|
1911
|
+
# @!attribute [rw] channel_arn
|
1912
|
+
# The ARN of the channel.
|
1913
|
+
# @return [String]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] message_id
|
1916
|
+
# The ID string assigned to each message.
|
1917
|
+
# @return [String]
|
1918
|
+
#
|
1919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageResponse AWS API Documentation
|
1920
|
+
#
|
1921
|
+
class SendChannelMessageResponse < Struct.new(
|
1922
|
+
:channel_arn,
|
1923
|
+
:message_id)
|
1924
|
+
SENSITIVE = []
|
1925
|
+
include Aws::Structure
|
1926
|
+
end
|
1927
|
+
|
1928
|
+
# The service encountered an unexpected error.
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] code
|
1931
|
+
# @return [String]
|
1932
|
+
#
|
1933
|
+
# @!attribute [rw] message
|
1934
|
+
# @return [String]
|
1935
|
+
#
|
1936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ServiceFailureException AWS API Documentation
|
1937
|
+
#
|
1938
|
+
class ServiceFailureException < Struct.new(
|
1939
|
+
:code,
|
1940
|
+
:message)
|
1941
|
+
SENSITIVE = []
|
1942
|
+
include Aws::Structure
|
1943
|
+
end
|
1944
|
+
|
1945
|
+
# The service is currently unavailable.
|
1946
|
+
#
|
1947
|
+
# @!attribute [rw] code
|
1948
|
+
# @return [String]
|
1949
|
+
#
|
1950
|
+
# @!attribute [rw] message
|
1951
|
+
# @return [String]
|
1952
|
+
#
|
1953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ServiceUnavailableException AWS API Documentation
|
1954
|
+
#
|
1955
|
+
class ServiceUnavailableException < Struct.new(
|
1956
|
+
:code,
|
1957
|
+
:message)
|
1958
|
+
SENSITIVE = []
|
1959
|
+
include Aws::Structure
|
1960
|
+
end
|
1961
|
+
|
1962
|
+
# Describes a tag applied to a resource.
|
1963
|
+
#
|
1964
|
+
# @note When making an API call, you may pass Tag
|
1965
|
+
# data as a hash:
|
1966
|
+
#
|
1967
|
+
# {
|
1968
|
+
# key: "TagKey", # required
|
1969
|
+
# value: "TagValue", # required
|
1970
|
+
# }
|
1971
|
+
#
|
1972
|
+
# @!attribute [rw] key
|
1973
|
+
# The key of the tag.
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @!attribute [rw] value
|
1977
|
+
# The value of the tag.
|
1978
|
+
# @return [String]
|
1979
|
+
#
|
1980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Tag AWS API Documentation
|
1981
|
+
#
|
1982
|
+
class Tag < Struct.new(
|
1983
|
+
:key,
|
1984
|
+
:value)
|
1985
|
+
SENSITIVE = [:key, :value]
|
1986
|
+
include Aws::Structure
|
1987
|
+
end
|
1988
|
+
|
1989
|
+
# The client exceeded its request rate limit.
|
1990
|
+
#
|
1991
|
+
# @!attribute [rw] code
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] message
|
1995
|
+
# @return [String]
|
1996
|
+
#
|
1997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ThrottledClientException AWS API Documentation
|
1998
|
+
#
|
1999
|
+
class ThrottledClientException < Struct.new(
|
2000
|
+
:code,
|
2001
|
+
:message)
|
2002
|
+
SENSITIVE = []
|
2003
|
+
include Aws::Structure
|
2004
|
+
end
|
2005
|
+
|
2006
|
+
# The client is not currently authorized to make the request.
|
2007
|
+
#
|
2008
|
+
# @!attribute [rw] code
|
2009
|
+
# @return [String]
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] message
|
2012
|
+
# @return [String]
|
2013
|
+
#
|
2014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UnauthorizedClientException AWS API Documentation
|
2015
|
+
#
|
2016
|
+
class UnauthorizedClientException < Struct.new(
|
2017
|
+
:code,
|
2018
|
+
:message)
|
2019
|
+
SENSITIVE = []
|
2020
|
+
include Aws::Structure
|
2021
|
+
end
|
2022
|
+
|
2023
|
+
# @note When making an API call, you may pass UpdateChannelMessageRequest
|
2024
|
+
# data as a hash:
|
2025
|
+
#
|
2026
|
+
# {
|
2027
|
+
# channel_arn: "ChimeArn", # required
|
2028
|
+
# message_id: "MessageId", # required
|
2029
|
+
# content: "Content",
|
2030
|
+
# metadata: "Metadata",
|
2031
|
+
# chime_bearer: "ChimeArn", # required
|
2032
|
+
# }
|
2033
|
+
#
|
2034
|
+
# @!attribute [rw] channel_arn
|
2035
|
+
# The ARN of the channel.
|
2036
|
+
# @return [String]
|
2037
|
+
#
|
2038
|
+
# @!attribute [rw] message_id
|
2039
|
+
# The ID string of the message being updated.
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] content
|
2043
|
+
# The content of the message being updated.
|
2044
|
+
# @return [String]
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] metadata
|
2047
|
+
# The metadata of the message being updated.
|
2048
|
+
# @return [String]
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] chime_bearer
|
2051
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2052
|
+
# @return [String]
|
2053
|
+
#
|
2054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageRequest AWS API Documentation
|
2055
|
+
#
|
2056
|
+
class UpdateChannelMessageRequest < Struct.new(
|
2057
|
+
:channel_arn,
|
2058
|
+
:message_id,
|
2059
|
+
:content,
|
2060
|
+
:metadata,
|
2061
|
+
:chime_bearer)
|
2062
|
+
SENSITIVE = [:content, :metadata]
|
2063
|
+
include Aws::Structure
|
2064
|
+
end
|
2065
|
+
|
2066
|
+
# @!attribute [rw] channel_arn
|
2067
|
+
# The ARN of the channel.
|
2068
|
+
# @return [String]
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] message_id
|
2071
|
+
# The ID string of the message being updated.
|
2072
|
+
# @return [String]
|
2073
|
+
#
|
2074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageResponse AWS API Documentation
|
2075
|
+
#
|
2076
|
+
class UpdateChannelMessageResponse < Struct.new(
|
2077
|
+
:channel_arn,
|
2078
|
+
:message_id)
|
2079
|
+
SENSITIVE = []
|
2080
|
+
include Aws::Structure
|
2081
|
+
end
|
2082
|
+
|
2083
|
+
# @note When making an API call, you may pass UpdateChannelReadMarkerRequest
|
2084
|
+
# data as a hash:
|
2085
|
+
#
|
2086
|
+
# {
|
2087
|
+
# channel_arn: "ChimeArn", # required
|
2088
|
+
# chime_bearer: "ChimeArn", # required
|
2089
|
+
# }
|
2090
|
+
#
|
2091
|
+
# @!attribute [rw] channel_arn
|
2092
|
+
# The ARN of the channel.
|
2093
|
+
# @return [String]
|
2094
|
+
#
|
2095
|
+
# @!attribute [rw] chime_bearer
|
2096
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2097
|
+
# @return [String]
|
2098
|
+
#
|
2099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarkerRequest AWS API Documentation
|
2100
|
+
#
|
2101
|
+
class UpdateChannelReadMarkerRequest < Struct.new(
|
2102
|
+
:channel_arn,
|
2103
|
+
:chime_bearer)
|
2104
|
+
SENSITIVE = []
|
2105
|
+
include Aws::Structure
|
2106
|
+
end
|
2107
|
+
|
2108
|
+
# @!attribute [rw] channel_arn
|
2109
|
+
# The ARN of the channel.
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarkerResponse AWS API Documentation
|
2113
|
+
#
|
2114
|
+
class UpdateChannelReadMarkerResponse < Struct.new(
|
2115
|
+
:channel_arn)
|
2116
|
+
SENSITIVE = []
|
2117
|
+
include Aws::Structure
|
2118
|
+
end
|
2119
|
+
|
2120
|
+
# @note When making an API call, you may pass UpdateChannelRequest
|
2121
|
+
# data as a hash:
|
2122
|
+
#
|
2123
|
+
# {
|
2124
|
+
# channel_arn: "ChimeArn", # required
|
2125
|
+
# name: "NonEmptyResourceName", # required
|
2126
|
+
# mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
|
2127
|
+
# metadata: "Metadata",
|
2128
|
+
# chime_bearer: "ChimeArn", # required
|
2129
|
+
# }
|
2130
|
+
#
|
2131
|
+
# @!attribute [rw] channel_arn
|
2132
|
+
# The ARN of the channel.
|
2133
|
+
# @return [String]
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] name
|
2136
|
+
# The name of the channel.
|
2137
|
+
# @return [String]
|
2138
|
+
#
|
2139
|
+
# @!attribute [rw] mode
|
2140
|
+
# The mode of the update request.
|
2141
|
+
# @return [String]
|
2142
|
+
#
|
2143
|
+
# @!attribute [rw] metadata
|
2144
|
+
# The metadata for the update request.
|
2145
|
+
# @return [String]
|
2146
|
+
#
|
2147
|
+
# @!attribute [rw] chime_bearer
|
2148
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2149
|
+
# @return [String]
|
2150
|
+
#
|
2151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelRequest AWS API Documentation
|
2152
|
+
#
|
2153
|
+
class UpdateChannelRequest < Struct.new(
|
2154
|
+
:channel_arn,
|
2155
|
+
:name,
|
2156
|
+
:mode,
|
2157
|
+
:metadata,
|
2158
|
+
:chime_bearer)
|
2159
|
+
SENSITIVE = [:name, :metadata]
|
2160
|
+
include Aws::Structure
|
2161
|
+
end
|
2162
|
+
|
2163
|
+
# @!attribute [rw] channel_arn
|
2164
|
+
# The ARN of the channel.
|
2165
|
+
# @return [String]
|
2166
|
+
#
|
2167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelResponse AWS API Documentation
|
2168
|
+
#
|
2169
|
+
class UpdateChannelResponse < Struct.new(
|
2170
|
+
:channel_arn)
|
2171
|
+
SENSITIVE = []
|
2172
|
+
include Aws::Structure
|
2173
|
+
end
|
2174
|
+
|
2175
|
+
end
|
2176
|
+
end
|