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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 65305df6e51fda2fdfc37388ac5e0189bb3519e1e3c2c0bb9fae03eb1c2ad41d
4
+ data.tar.gz: c3551c4f3017d941b36a973f5a047863370029bc9dd749546bafa62ea542af9c
5
+ SHA512:
6
+ metadata.gz: c0dcc72cc51810edcf0eef50699ad63035e1382b219526353a4adf88ce7e5e4b81ebce46286279991e9987f64060850cb24f6c57b9cf5b025a6481b4f03e67e2
7
+ data.tar.gz: 6892462ee10375fb21dfdd8fdf30f6ecd5d85c54aeb0f2728b59ff3ad2acc236d8e2cf5912947ed3b39d41600ad1a411bac40c0a1262975b6ee097c2d9b3600e
data/CHANGELOG.md ADDED
@@ -0,0 +1,8 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.0.0 (2021-08-06)
5
+ ------------------
6
+
7
+ * Feature - Initial release of `aws-sdk-chimesdkmessaging`.
8
+
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.0.0
@@ -0,0 +1,53 @@
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
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-chimesdkmessaging/types'
15
+ require_relative 'aws-sdk-chimesdkmessaging/client_api'
16
+ require_relative 'aws-sdk-chimesdkmessaging/client'
17
+ require_relative 'aws-sdk-chimesdkmessaging/errors'
18
+ require_relative 'aws-sdk-chimesdkmessaging/resource'
19
+ require_relative 'aws-sdk-chimesdkmessaging/customizations'
20
+
21
+ # This module provides support for Amazon Chime SDK Messaging. This module is available in the
22
+ # `aws-sdk-chimesdkmessaging` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # chime_sdk_messaging = Aws::ChimeSDKMessaging::Client.new
31
+ # resp = chime_sdk_messaging.batch_create_channel_membership(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon Chime SDK Messaging are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::ChimeSDKMessaging::Errors::ServiceError
43
+ # # rescues all Amazon Chime SDK Messaging API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::ChimeSDKMessaging
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,1916 @@
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
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:chimesdkmessaging)
34
+
35
+ module Aws::ChimeSDKMessaging
36
+ # An API client for ChimeSDKMessaging. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::ChimeSDKMessaging::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :chimesdkmessaging
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
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
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
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.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Adds a specified number of users to a channel.
331
+ #
332
+ # @option params [required, String] :channel_arn
333
+ # The ARN of the channel to which you're adding users.
334
+ #
335
+ # @option params [String] :type
336
+ # The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
337
+ # are always returned as part of `ListChannelMemberships`. Hidden
338
+ # members are only returned if the type filter in
339
+ # `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
340
+ # not returned. This is only supported by moderators.
341
+ #
342
+ # @option params [required, Array<String>] :member_arns
343
+ # The ARNs of the members you want to add to the channel.
344
+ #
345
+ # @option params [required, String] :chime_bearer
346
+ # The `AppInstanceUserArn` of the user that makes the API call.
347
+ #
348
+ # @return [Types::BatchCreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
349
+ #
350
+ # * {Types::BatchCreateChannelMembershipResponse#batch_channel_memberships #batch_channel_memberships} => Types::BatchChannelMemberships
351
+ # * {Types::BatchCreateChannelMembershipResponse#errors #errors} => Array&lt;Types::BatchCreateChannelMembershipError&gt;
352
+ #
353
+ # @example Request syntax with placeholder values
354
+ #
355
+ # resp = client.batch_create_channel_membership({
356
+ # channel_arn: "ChimeArn", # required
357
+ # type: "DEFAULT", # accepts DEFAULT, HIDDEN
358
+ # member_arns: ["ChimeArn"], # required
359
+ # chime_bearer: "ChimeArn", # required
360
+ # })
361
+ #
362
+ # @example Response structure
363
+ #
364
+ # resp.batch_channel_memberships.invited_by.arn #=> String
365
+ # resp.batch_channel_memberships.invited_by.name #=> String
366
+ # resp.batch_channel_memberships.type #=> String, one of "DEFAULT", "HIDDEN"
367
+ # resp.batch_channel_memberships.members #=> Array
368
+ # resp.batch_channel_memberships.members[0].arn #=> String
369
+ # resp.batch_channel_memberships.members[0].name #=> String
370
+ # resp.batch_channel_memberships.channel_arn #=> String
371
+ # resp.errors #=> Array
372
+ # resp.errors[0].member_arn #=> String
373
+ # resp.errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
374
+ # resp.errors[0].error_message #=> String
375
+ #
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembership AWS API Documentation
377
+ #
378
+ # @overload batch_create_channel_membership(params = {})
379
+ # @param [Hash] params ({})
380
+ def batch_create_channel_membership(params = {}, options = {})
381
+ req = build_request(:batch_create_channel_membership, params)
382
+ req.send_request(options)
383
+ end
384
+
385
+ # Creates a channel to which you can add users and send messages.
386
+ #
387
+ # **Restriction**\: You can't change a channel's privacy.
388
+ #
389
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
390
+ # `AppInstanceUserArn` of the user that makes the API call as the value
391
+ # in the header.
392
+ #
393
+ # </note>
394
+ #
395
+ # @option params [required, String] :app_instance_arn
396
+ # The ARN of the channel request.
397
+ #
398
+ # @option params [required, String] :name
399
+ # The name of the channel.
400
+ #
401
+ # @option params [String] :mode
402
+ # The channel mode: `UNRESTRICTED` or `RESTRICTED`. Administrators,
403
+ # moderators, and channel members can add themselves and other members
404
+ # to unrestricted channels. Only administrators and moderators can add
405
+ # members to restricted channels.
406
+ #
407
+ # @option params [String] :privacy
408
+ # The channel's privacy level: `PUBLIC` or `PRIVATE`. Private channels
409
+ # aren't discoverable by users outside the channel. Public channels are
410
+ # discoverable by anyone in the `AppInstance`.
411
+ #
412
+ # @option params [String] :metadata
413
+ # The metadata of the creation request. Limited to 1KB and UTF-8.
414
+ #
415
+ # @option params [required, String] :client_request_token
416
+ # The client token for the request. An `Idempotency` token.
417
+ #
418
+ # **A suitable default value is auto-generated.** You should normally
419
+ # not need to pass this option.**
420
+ #
421
+ # @option params [Array<Types::Tag>] :tags
422
+ # The tags for the creation request.
423
+ #
424
+ # @option params [required, String] :chime_bearer
425
+ # The `AppInstanceUserArn` of the user that makes the API call.
426
+ #
427
+ # @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
428
+ #
429
+ # * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
430
+ #
431
+ # @example Request syntax with placeholder values
432
+ #
433
+ # resp = client.create_channel({
434
+ # app_instance_arn: "ChimeArn", # required
435
+ # name: "NonEmptyResourceName", # required
436
+ # mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
437
+ # privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
438
+ # metadata: "Metadata",
439
+ # client_request_token: "ClientRequestToken", # required
440
+ # tags: [
441
+ # {
442
+ # key: "TagKey", # required
443
+ # value: "TagValue", # required
444
+ # },
445
+ # ],
446
+ # chime_bearer: "ChimeArn", # required
447
+ # })
448
+ #
449
+ # @example Response structure
450
+ #
451
+ # resp.channel_arn #=> String
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannel AWS API Documentation
454
+ #
455
+ # @overload create_channel(params = {})
456
+ # @param [Hash] params ({})
457
+ def create_channel(params = {}, options = {})
458
+ req = build_request(:create_channel, params)
459
+ req.send_request(options)
460
+ end
461
+
462
+ # Permanently bans a member from a channel. Moderators can't add banned
463
+ # members to a channel. To undo a ban, you first have to
464
+ # `DeleteChannelBan`, and then `CreateChannelMembership`. Bans are
465
+ # cleaned up when you delete users or channels.
466
+ #
467
+ # If you ban a user who is already part of a channel, that user is
468
+ # automatically kicked from the channel.
469
+ #
470
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
471
+ # `AppInstanceUserArn` of the user that makes the API call as the value
472
+ # in the header.
473
+ #
474
+ # </note>
475
+ #
476
+ # @option params [required, String] :channel_arn
477
+ # The ARN of the ban request.
478
+ #
479
+ # @option params [required, String] :member_arn
480
+ # The ARN of the member being banned.
481
+ #
482
+ # @option params [required, String] :chime_bearer
483
+ # The `AppInstanceUserArn` of the user that makes the API call.
484
+ #
485
+ # @return [Types::CreateChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
486
+ #
487
+ # * {Types::CreateChannelBanResponse#channel_arn #channel_arn} => String
488
+ # * {Types::CreateChannelBanResponse#member #member} => Types::Identity
489
+ #
490
+ # @example Request syntax with placeholder values
491
+ #
492
+ # resp = client.create_channel_ban({
493
+ # channel_arn: "ChimeArn", # required
494
+ # member_arn: "ChimeArn", # required
495
+ # chime_bearer: "ChimeArn", # required
496
+ # })
497
+ #
498
+ # @example Response structure
499
+ #
500
+ # resp.channel_arn #=> String
501
+ # resp.member.arn #=> String
502
+ # resp.member.name #=> String
503
+ #
504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelBan AWS API Documentation
505
+ #
506
+ # @overload create_channel_ban(params = {})
507
+ # @param [Hash] params ({})
508
+ def create_channel_ban(params = {}, options = {})
509
+ req = build_request(:create_channel_ban, params)
510
+ req.send_request(options)
511
+ end
512
+
513
+ # Adds a user to a channel. The `InvitedBy` response field is derived
514
+ # from the request header. A channel member can:
515
+ #
516
+ # * List messages
517
+ #
518
+ # * Send messages
519
+ #
520
+ # * Receive messages
521
+ #
522
+ # * Edit their own messages
523
+ #
524
+ # * Leave the channel
525
+ #
526
+ # Privacy settings impact this action as follows:
527
+ #
528
+ # * Public Channels: You do not need to be a member to list messages,
529
+ # but you must be a member to send messages.
530
+ #
531
+ # * Private Channels: You must be a member to list or send messages.
532
+ #
533
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
534
+ # `AppInstanceUserArn` of the user that makes the API call as the value
535
+ # in the header.
536
+ #
537
+ # </note>
538
+ #
539
+ # @option params [required, String] :channel_arn
540
+ # The ARN of the channel to which you're adding users.
541
+ #
542
+ # @option params [required, String] :member_arn
543
+ # The ARN of the member you want to add to the channel.
544
+ #
545
+ # @option params [required, String] :type
546
+ # The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
547
+ # are always returned as part of `ListChannelMemberships`. Hidden
548
+ # members are only returned if the type filter in
549
+ # `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
550
+ # not returned. This is only supported by moderators.
551
+ #
552
+ # @option params [required, String] :chime_bearer
553
+ # The `AppInstanceUserArn` of the user that makes the API call.
554
+ #
555
+ # @return [Types::CreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
556
+ #
557
+ # * {Types::CreateChannelMembershipResponse#channel_arn #channel_arn} => String
558
+ # * {Types::CreateChannelMembershipResponse#member #member} => Types::Identity
559
+ #
560
+ # @example Request syntax with placeholder values
561
+ #
562
+ # resp = client.create_channel_membership({
563
+ # channel_arn: "ChimeArn", # required
564
+ # member_arn: "ChimeArn", # required
565
+ # type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
566
+ # chime_bearer: "ChimeArn", # required
567
+ # })
568
+ #
569
+ # @example Response structure
570
+ #
571
+ # resp.channel_arn #=> String
572
+ # resp.member.arn #=> String
573
+ # resp.member.name #=> String
574
+ #
575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembership AWS API Documentation
576
+ #
577
+ # @overload create_channel_membership(params = {})
578
+ # @param [Hash] params ({})
579
+ def create_channel_membership(params = {}, options = {})
580
+ req = build_request(:create_channel_membership, params)
581
+ req.send_request(options)
582
+ end
583
+
584
+ # Creates a new `ChannelModerator`. A channel moderator can:
585
+ #
586
+ # * Add and remove other members of the channel.
587
+ #
588
+ # * Add and remove other moderators of the channel.
589
+ #
590
+ # * Add and remove user bans for the channel.
591
+ #
592
+ # * Redact messages in the channel.
593
+ #
594
+ # * List messages in the channel.
595
+ #
596
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
597
+ # `AppInstanceUserArn` of the user that makes the API call as the value
598
+ # in the header.
599
+ #
600
+ # </note>
601
+ #
602
+ # @option params [required, String] :channel_arn
603
+ # The ARN of the channel.
604
+ #
605
+ # @option params [required, String] :channel_moderator_arn
606
+ # The ARN of the moderator.
607
+ #
608
+ # @option params [required, String] :chime_bearer
609
+ # The `AppInstanceUserArn` of the user that makes the API call.
610
+ #
611
+ # @return [Types::CreateChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
612
+ #
613
+ # * {Types::CreateChannelModeratorResponse#channel_arn #channel_arn} => String
614
+ # * {Types::CreateChannelModeratorResponse#channel_moderator #channel_moderator} => Types::Identity
615
+ #
616
+ # @example Request syntax with placeholder values
617
+ #
618
+ # resp = client.create_channel_moderator({
619
+ # channel_arn: "ChimeArn", # required
620
+ # channel_moderator_arn: "ChimeArn", # required
621
+ # chime_bearer: "ChimeArn", # required
622
+ # })
623
+ #
624
+ # @example Response structure
625
+ #
626
+ # resp.channel_arn #=> String
627
+ # resp.channel_moderator.arn #=> String
628
+ # resp.channel_moderator.name #=> String
629
+ #
630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelModerator AWS API Documentation
631
+ #
632
+ # @overload create_channel_moderator(params = {})
633
+ # @param [Hash] params ({})
634
+ def create_channel_moderator(params = {}, options = {})
635
+ req = build_request(:create_channel_moderator, params)
636
+ req.send_request(options)
637
+ end
638
+
639
+ # Immediately makes a channel and its memberships inaccessible and marks
640
+ # them for deletion. This is an irreversible process.
641
+ #
642
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
643
+ # `AppInstanceUserArn` of the user that makes the API call as the value
644
+ # in the header.
645
+ #
646
+ # </note>
647
+ #
648
+ # @option params [required, String] :channel_arn
649
+ # The ARN of the channel being deleted.
650
+ #
651
+ # @option params [required, String] :chime_bearer
652
+ # The `AppInstanceUserArn` of the user that makes the API call.
653
+ #
654
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
655
+ #
656
+ # @example Request syntax with placeholder values
657
+ #
658
+ # resp = client.delete_channel({
659
+ # channel_arn: "ChimeArn", # required
660
+ # chime_bearer: "ChimeArn", # required
661
+ # })
662
+ #
663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannel AWS API Documentation
664
+ #
665
+ # @overload delete_channel(params = {})
666
+ # @param [Hash] params ({})
667
+ def delete_channel(params = {}, options = {})
668
+ req = build_request(:delete_channel, params)
669
+ req.send_request(options)
670
+ end
671
+
672
+ # Removes a user from a channel's ban list.
673
+ #
674
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
675
+ # `AppInstanceUserArn` of the user that makes the API call as the value
676
+ # in the header.
677
+ #
678
+ # </note>
679
+ #
680
+ # @option params [required, String] :channel_arn
681
+ # The ARN of the channel from which the `AppInstanceUser` was banned.
682
+ #
683
+ # @option params [required, String] :member_arn
684
+ # The ARN of the `AppInstanceUser` that you want to reinstate.
685
+ #
686
+ # @option params [required, String] :chime_bearer
687
+ # The `AppInstanceUserArn` of the user that makes the API call.
688
+ #
689
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
690
+ #
691
+ # @example Request syntax with placeholder values
692
+ #
693
+ # resp = client.delete_channel_ban({
694
+ # channel_arn: "ChimeArn", # required
695
+ # member_arn: "ChimeArn", # required
696
+ # chime_bearer: "ChimeArn", # required
697
+ # })
698
+ #
699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelBan AWS API Documentation
700
+ #
701
+ # @overload delete_channel_ban(params = {})
702
+ # @param [Hash] params ({})
703
+ def delete_channel_ban(params = {}, options = {})
704
+ req = build_request(:delete_channel_ban, params)
705
+ req.send_request(options)
706
+ end
707
+
708
+ # Removes a member from a channel.
709
+ #
710
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
711
+ # `AppInstanceUserArn` of the user that makes the API call as the value
712
+ # in the header.
713
+ #
714
+ # </note>
715
+ #
716
+ # @option params [required, String] :channel_arn
717
+ # The ARN of the channel from which you want to remove the user.
718
+ #
719
+ # @option params [required, String] :member_arn
720
+ # The ARN of the member that you're removing from the channel.
721
+ #
722
+ # @option params [required, String] :chime_bearer
723
+ # The `AppInstanceUserArn` of the user that makes the API call.
724
+ #
725
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
726
+ #
727
+ # @example Request syntax with placeholder values
728
+ #
729
+ # resp = client.delete_channel_membership({
730
+ # channel_arn: "ChimeArn", # required
731
+ # member_arn: "ChimeArn", # required
732
+ # chime_bearer: "ChimeArn", # required
733
+ # })
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembership AWS API Documentation
736
+ #
737
+ # @overload delete_channel_membership(params = {})
738
+ # @param [Hash] params ({})
739
+ def delete_channel_membership(params = {}, options = {})
740
+ req = build_request(:delete_channel_membership, params)
741
+ req.send_request(options)
742
+ end
743
+
744
+ # Deletes a channel message. Only admins can perform this action.
745
+ # Deletion makes messages inaccessible immediately. A background process
746
+ # deletes any revisions created by `UpdateChannelMessage`.
747
+ #
748
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
749
+ # `AppInstanceUserArn` of the user that makes the API call as the value
750
+ # in the header.
751
+ #
752
+ # </note>
753
+ #
754
+ # @option params [required, String] :channel_arn
755
+ # The ARN of the channel.
756
+ #
757
+ # @option params [required, String] :message_id
758
+ # The ID of the message being deleted.
759
+ #
760
+ # @option params [required, String] :chime_bearer
761
+ # The `AppInstanceUserArn` of the user that makes the API call.
762
+ #
763
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
764
+ #
765
+ # @example Request syntax with placeholder values
766
+ #
767
+ # resp = client.delete_channel_message({
768
+ # channel_arn: "ChimeArn", # required
769
+ # message_id: "MessageId", # required
770
+ # chime_bearer: "ChimeArn", # required
771
+ # })
772
+ #
773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessage AWS API Documentation
774
+ #
775
+ # @overload delete_channel_message(params = {})
776
+ # @param [Hash] params ({})
777
+ def delete_channel_message(params = {}, options = {})
778
+ req = build_request(:delete_channel_message, params)
779
+ req.send_request(options)
780
+ end
781
+
782
+ # Deletes a channel moderator.
783
+ #
784
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
785
+ # `AppInstanceUserArn` of the user that makes the API call as the value
786
+ # in the header.
787
+ #
788
+ # </note>
789
+ #
790
+ # @option params [required, String] :channel_arn
791
+ # The ARN of the channel.
792
+ #
793
+ # @option params [required, String] :channel_moderator_arn
794
+ # The ARN of the moderator being deleted.
795
+ #
796
+ # @option params [required, String] :chime_bearer
797
+ # The `AppInstanceUserArn` of the user that makes the API call.
798
+ #
799
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
800
+ #
801
+ # @example Request syntax with placeholder values
802
+ #
803
+ # resp = client.delete_channel_moderator({
804
+ # channel_arn: "ChimeArn", # required
805
+ # channel_moderator_arn: "ChimeArn", # required
806
+ # chime_bearer: "ChimeArn", # required
807
+ # })
808
+ #
809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelModerator AWS API Documentation
810
+ #
811
+ # @overload delete_channel_moderator(params = {})
812
+ # @param [Hash] params ({})
813
+ def delete_channel_moderator(params = {}, options = {})
814
+ req = build_request(:delete_channel_moderator, params)
815
+ req.send_request(options)
816
+ end
817
+
818
+ # Returns the full details of a channel in an Amazon Chime
819
+ # `AppInstance`.
820
+ #
821
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
822
+ # `AppInstanceUserArn` of the user that makes the API call as the value
823
+ # in the header.
824
+ #
825
+ # </note>
826
+ #
827
+ # @option params [required, String] :channel_arn
828
+ # The ARN of the channel.
829
+ #
830
+ # @option params [required, String] :chime_bearer
831
+ # The `AppInstanceUserArn` of the user that makes the API call.
832
+ #
833
+ # @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
834
+ #
835
+ # * {Types::DescribeChannelResponse#channel #channel} => Types::Channel
836
+ #
837
+ # @example Request syntax with placeholder values
838
+ #
839
+ # resp = client.describe_channel({
840
+ # channel_arn: "ChimeArn", # required
841
+ # chime_bearer: "ChimeArn", # required
842
+ # })
843
+ #
844
+ # @example Response structure
845
+ #
846
+ # resp.channel.name #=> String
847
+ # resp.channel.channel_arn #=> String
848
+ # resp.channel.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
849
+ # resp.channel.privacy #=> String, one of "PUBLIC", "PRIVATE"
850
+ # resp.channel.metadata #=> String
851
+ # resp.channel.created_by.arn #=> String
852
+ # resp.channel.created_by.name #=> String
853
+ # resp.channel.created_timestamp #=> Time
854
+ # resp.channel.last_message_timestamp #=> Time
855
+ # resp.channel.last_updated_timestamp #=> Time
856
+ #
857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel AWS API Documentation
858
+ #
859
+ # @overload describe_channel(params = {})
860
+ # @param [Hash] params ({})
861
+ def describe_channel(params = {}, options = {})
862
+ req = build_request(:describe_channel, params)
863
+ req.send_request(options)
864
+ end
865
+
866
+ # Returns the full details of a channel ban.
867
+ #
868
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
869
+ # `AppInstanceUserArn` of the user that makes the API call as the value
870
+ # in the header.
871
+ #
872
+ # </note>
873
+ #
874
+ # @option params [required, String] :channel_arn
875
+ # The ARN of the channel from which the user is banned.
876
+ #
877
+ # @option params [required, String] :member_arn
878
+ # The ARN of the member being banned.
879
+ #
880
+ # @option params [required, String] :chime_bearer
881
+ # The `AppInstanceUserArn` of the user that makes the API call.
882
+ #
883
+ # @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
884
+ #
885
+ # * {Types::DescribeChannelBanResponse#channel_ban #channel_ban} => Types::ChannelBan
886
+ #
887
+ # @example Request syntax with placeholder values
888
+ #
889
+ # resp = client.describe_channel_ban({
890
+ # channel_arn: "ChimeArn", # required
891
+ # member_arn: "ChimeArn", # required
892
+ # chime_bearer: "ChimeArn", # required
893
+ # })
894
+ #
895
+ # @example Response structure
896
+ #
897
+ # resp.channel_ban.member.arn #=> String
898
+ # resp.channel_ban.member.name #=> String
899
+ # resp.channel_ban.channel_arn #=> String
900
+ # resp.channel_ban.created_timestamp #=> Time
901
+ # resp.channel_ban.created_by.arn #=> String
902
+ # resp.channel_ban.created_by.name #=> String
903
+ #
904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelBan AWS API Documentation
905
+ #
906
+ # @overload describe_channel_ban(params = {})
907
+ # @param [Hash] params ({})
908
+ def describe_channel_ban(params = {}, options = {})
909
+ req = build_request(:describe_channel_ban, params)
910
+ req.send_request(options)
911
+ end
912
+
913
+ # Returns the full details of a user's channel membership.
914
+ #
915
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
916
+ # `AppInstanceUserArn` of the user that makes the API call as the value
917
+ # in the header.
918
+ #
919
+ # </note>
920
+ #
921
+ # @option params [required, String] :channel_arn
922
+ # The ARN of the channel.
923
+ #
924
+ # @option params [required, String] :member_arn
925
+ # The ARN of the member.
926
+ #
927
+ # @option params [required, String] :chime_bearer
928
+ # The `AppInstanceUserArn` of the user that makes the API call.
929
+ #
930
+ # @return [Types::DescribeChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
931
+ #
932
+ # * {Types::DescribeChannelMembershipResponse#channel_membership #channel_membership} => Types::ChannelMembership
933
+ #
934
+ # @example Request syntax with placeholder values
935
+ #
936
+ # resp = client.describe_channel_membership({
937
+ # channel_arn: "ChimeArn", # required
938
+ # member_arn: "ChimeArn", # required
939
+ # chime_bearer: "ChimeArn", # required
940
+ # })
941
+ #
942
+ # @example Response structure
943
+ #
944
+ # resp.channel_membership.invited_by.arn #=> String
945
+ # resp.channel_membership.invited_by.name #=> String
946
+ # resp.channel_membership.type #=> String, one of "DEFAULT", "HIDDEN"
947
+ # resp.channel_membership.member.arn #=> String
948
+ # resp.channel_membership.member.name #=> String
949
+ # resp.channel_membership.channel_arn #=> String
950
+ # resp.channel_membership.created_timestamp #=> Time
951
+ # resp.channel_membership.last_updated_timestamp #=> Time
952
+ #
953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembership AWS API Documentation
954
+ #
955
+ # @overload describe_channel_membership(params = {})
956
+ # @param [Hash] params ({})
957
+ def describe_channel_membership(params = {}, options = {})
958
+ req = build_request(:describe_channel_membership, params)
959
+ req.send_request(options)
960
+ end
961
+
962
+ # Returns the details of a channel based on the membership of the
963
+ # specified `AppInstanceUser`.
964
+ #
965
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
966
+ # `AppInstanceUserArn` of the user that makes the API call as the value
967
+ # in the header.
968
+ #
969
+ # </note>
970
+ #
971
+ # @option params [required, String] :channel_arn
972
+ # The ARN of the channel to which the user belongs.
973
+ #
974
+ # @option params [required, String] :app_instance_user_arn
975
+ # The ARN of the user in a channel.
976
+ #
977
+ # @option params [required, String] :chime_bearer
978
+ # The `AppInstanceUserArn` of the user that makes the API call.
979
+ #
980
+ # @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
981
+ #
982
+ # * {Types::DescribeChannelMembershipForAppInstanceUserResponse#channel_membership #channel_membership} => Types::ChannelMembershipForAppInstanceUserSummary
983
+ #
984
+ # @example Request syntax with placeholder values
985
+ #
986
+ # resp = client.describe_channel_membership_for_app_instance_user({
987
+ # channel_arn: "ChimeArn", # required
988
+ # app_instance_user_arn: "ChimeArn", # required
989
+ # chime_bearer: "ChimeArn", # required
990
+ # })
991
+ #
992
+ # @example Response structure
993
+ #
994
+ # resp.channel_membership.channel_summary.name #=> String
995
+ # resp.channel_membership.channel_summary.channel_arn #=> String
996
+ # resp.channel_membership.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
997
+ # resp.channel_membership.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
998
+ # resp.channel_membership.channel_summary.metadata #=> String
999
+ # resp.channel_membership.channel_summary.last_message_timestamp #=> Time
1000
+ # resp.channel_membership.app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
1001
+ # resp.channel_membership.app_instance_user_membership_summary.read_marker_timestamp #=> Time
1002
+ #
1003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser AWS API Documentation
1004
+ #
1005
+ # @overload describe_channel_membership_for_app_instance_user(params = {})
1006
+ # @param [Hash] params ({})
1007
+ def describe_channel_membership_for_app_instance_user(params = {}, options = {})
1008
+ req = build_request(:describe_channel_membership_for_app_instance_user, params)
1009
+ req.send_request(options)
1010
+ end
1011
+
1012
+ # Returns the full details of a channel moderated by the specified
1013
+ # `AppInstanceUser`.
1014
+ #
1015
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1016
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1017
+ # in the header.
1018
+ #
1019
+ # </note>
1020
+ #
1021
+ # @option params [required, String] :channel_arn
1022
+ # The ARN of the moderated channel.
1023
+ #
1024
+ # @option params [required, String] :app_instance_user_arn
1025
+ # The ARN of the `AppInstanceUser` in the moderated channel.
1026
+ #
1027
+ # @option params [required, String] :chime_bearer
1028
+ # The `AppInstanceUserArn` of the user that makes the API call.
1029
+ #
1030
+ # @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1031
+ #
1032
+ # * {Types::DescribeChannelModeratedByAppInstanceUserResponse#channel #channel} => Types::ChannelModeratedByAppInstanceUserSummary
1033
+ #
1034
+ # @example Request syntax with placeholder values
1035
+ #
1036
+ # resp = client.describe_channel_moderated_by_app_instance_user({
1037
+ # channel_arn: "ChimeArn", # required
1038
+ # app_instance_user_arn: "ChimeArn", # required
1039
+ # chime_bearer: "ChimeArn", # required
1040
+ # })
1041
+ #
1042
+ # @example Response structure
1043
+ #
1044
+ # resp.channel.channel_summary.name #=> String
1045
+ # resp.channel.channel_summary.channel_arn #=> String
1046
+ # resp.channel.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
1047
+ # resp.channel.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
1048
+ # resp.channel.channel_summary.metadata #=> String
1049
+ # resp.channel.channel_summary.last_message_timestamp #=> Time
1050
+ #
1051
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModeratedByAppInstanceUser AWS API Documentation
1052
+ #
1053
+ # @overload describe_channel_moderated_by_app_instance_user(params = {})
1054
+ # @param [Hash] params ({})
1055
+ def describe_channel_moderated_by_app_instance_user(params = {}, options = {})
1056
+ req = build_request(:describe_channel_moderated_by_app_instance_user, params)
1057
+ req.send_request(options)
1058
+ end
1059
+
1060
+ # Returns the full details of a single ChannelModerator.
1061
+ #
1062
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1063
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1064
+ # in the header.
1065
+ #
1066
+ # </note>
1067
+ #
1068
+ # @option params [required, String] :channel_arn
1069
+ # The ARN of the channel.
1070
+ #
1071
+ # @option params [required, String] :channel_moderator_arn
1072
+ # The ARN of the channel moderator.
1073
+ #
1074
+ # @option params [required, String] :chime_bearer
1075
+ # The `AppInstanceUserArn` of the user that makes the API call.
1076
+ #
1077
+ # @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1078
+ #
1079
+ # * {Types::DescribeChannelModeratorResponse#channel_moderator #channel_moderator} => Types::ChannelModerator
1080
+ #
1081
+ # @example Request syntax with placeholder values
1082
+ #
1083
+ # resp = client.describe_channel_moderator({
1084
+ # channel_arn: "ChimeArn", # required
1085
+ # channel_moderator_arn: "ChimeArn", # required
1086
+ # chime_bearer: "ChimeArn", # required
1087
+ # })
1088
+ #
1089
+ # @example Response structure
1090
+ #
1091
+ # resp.channel_moderator.moderator.arn #=> String
1092
+ # resp.channel_moderator.moderator.name #=> String
1093
+ # resp.channel_moderator.channel_arn #=> String
1094
+ # resp.channel_moderator.created_timestamp #=> Time
1095
+ # resp.channel_moderator.created_by.arn #=> String
1096
+ # resp.channel_moderator.created_by.name #=> String
1097
+ #
1098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelModerator AWS API Documentation
1099
+ #
1100
+ # @overload describe_channel_moderator(params = {})
1101
+ # @param [Hash] params ({})
1102
+ def describe_channel_moderator(params = {}, options = {})
1103
+ req = build_request(:describe_channel_moderator, params)
1104
+ req.send_request(options)
1105
+ end
1106
+
1107
+ # Gets the full details of a channel message.
1108
+ #
1109
+ # <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
1110
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1111
+ # in the header.
1112
+ #
1113
+ # </note>
1114
+ #
1115
+ # @option params [required, String] :channel_arn
1116
+ # The ARN of the channel.
1117
+ #
1118
+ # @option params [required, String] :message_id
1119
+ # The ID of the message.
1120
+ #
1121
+ # @option params [required, String] :chime_bearer
1122
+ # The `AppInstanceUserArn` of the user that makes the API call.
1123
+ #
1124
+ # @return [Types::GetChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1125
+ #
1126
+ # * {Types::GetChannelMessageResponse#channel_message #channel_message} => Types::ChannelMessage
1127
+ #
1128
+ # @example Request syntax with placeholder values
1129
+ #
1130
+ # resp = client.get_channel_message({
1131
+ # channel_arn: "ChimeArn", # required
1132
+ # message_id: "MessageId", # required
1133
+ # chime_bearer: "ChimeArn", # required
1134
+ # })
1135
+ #
1136
+ # @example Response structure
1137
+ #
1138
+ # resp.channel_message.channel_arn #=> String
1139
+ # resp.channel_message.message_id #=> String
1140
+ # resp.channel_message.content #=> String
1141
+ # resp.channel_message.metadata #=> String
1142
+ # resp.channel_message.type #=> String, one of "STANDARD", "CONTROL"
1143
+ # resp.channel_message.created_timestamp #=> Time
1144
+ # resp.channel_message.last_edited_timestamp #=> Time
1145
+ # resp.channel_message.last_updated_timestamp #=> Time
1146
+ # resp.channel_message.sender.arn #=> String
1147
+ # resp.channel_message.sender.name #=> String
1148
+ # resp.channel_message.redacted #=> Boolean
1149
+ # resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"
1150
+ #
1151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
1152
+ #
1153
+ # @overload get_channel_message(params = {})
1154
+ # @param [Hash] params ({})
1155
+ def get_channel_message(params = {}, options = {})
1156
+ req = build_request(:get_channel_message, params)
1157
+ req.send_request(options)
1158
+ end
1159
+
1160
+ # The details of the endpoint for the messaging session.
1161
+ #
1162
+ # @return [Types::GetMessagingSessionEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1163
+ #
1164
+ # * {Types::GetMessagingSessionEndpointResponse#endpoint #endpoint} => Types::MessagingSessionEndpoint
1165
+ #
1166
+ # @example Response structure
1167
+ #
1168
+ # resp.endpoint.url #=> String
1169
+ #
1170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpoint AWS API Documentation
1171
+ #
1172
+ # @overload get_messaging_session_endpoint(params = {})
1173
+ # @param [Hash] params ({})
1174
+ def get_messaging_session_endpoint(params = {}, options = {})
1175
+ req = build_request(:get_messaging_session_endpoint, params)
1176
+ req.send_request(options)
1177
+ end
1178
+
1179
+ # Lists all the users banned from a particular channel.
1180
+ #
1181
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1182
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1183
+ # in the header.
1184
+ #
1185
+ # </note>
1186
+ #
1187
+ # @option params [required, String] :channel_arn
1188
+ # The ARN of the channel.
1189
+ #
1190
+ # @option params [Integer] :max_results
1191
+ # The maximum number of bans that you want returned.
1192
+ #
1193
+ # @option params [String] :next_token
1194
+ # The token passed by previous API calls until all requested bans are
1195
+ # returned.
1196
+ #
1197
+ # @option params [required, String] :chime_bearer
1198
+ # The `AppInstanceUserArn` of the user that makes the API call.
1199
+ #
1200
+ # @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1201
+ #
1202
+ # * {Types::ListChannelBansResponse#channel_arn #channel_arn} => String
1203
+ # * {Types::ListChannelBansResponse#next_token #next_token} => String
1204
+ # * {Types::ListChannelBansResponse#channel_bans #channel_bans} => Array&lt;Types::ChannelBanSummary&gt;
1205
+ #
1206
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1207
+ #
1208
+ # @example Request syntax with placeholder values
1209
+ #
1210
+ # resp = client.list_channel_bans({
1211
+ # channel_arn: "ChimeArn", # required
1212
+ # max_results: 1,
1213
+ # next_token: "NextToken",
1214
+ # chime_bearer: "ChimeArn", # required
1215
+ # })
1216
+ #
1217
+ # @example Response structure
1218
+ #
1219
+ # resp.channel_arn #=> String
1220
+ # resp.next_token #=> String
1221
+ # resp.channel_bans #=> Array
1222
+ # resp.channel_bans[0].member.arn #=> String
1223
+ # resp.channel_bans[0].member.name #=> String
1224
+ #
1225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelBans AWS API Documentation
1226
+ #
1227
+ # @overload list_channel_bans(params = {})
1228
+ # @param [Hash] params ({})
1229
+ def list_channel_bans(params = {}, options = {})
1230
+ req = build_request(:list_channel_bans, params)
1231
+ req.send_request(options)
1232
+ end
1233
+
1234
+ # Lists all channel memberships in a channel.
1235
+ #
1236
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1237
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1238
+ # in the header.
1239
+ #
1240
+ # </note>
1241
+ #
1242
+ # @option params [required, String] :channel_arn
1243
+ # The maximum number of channel memberships that you want returned.
1244
+ #
1245
+ # @option params [String] :type
1246
+ # The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
1247
+ # are always returned as part of `ListChannelMemberships`. Hidden
1248
+ # members are only returned if the type filter in
1249
+ # `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
1250
+ # not returned.
1251
+ #
1252
+ # @option params [Integer] :max_results
1253
+ # The maximum number of channel memberships that you want returned.
1254
+ #
1255
+ # @option params [String] :next_token
1256
+ # The token passed by previous API calls until all requested channel
1257
+ # memberships are returned.
1258
+ #
1259
+ # @option params [required, String] :chime_bearer
1260
+ # The `AppInstanceUserArn` of the user that makes the API call.
1261
+ #
1262
+ # @return [Types::ListChannelMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1263
+ #
1264
+ # * {Types::ListChannelMembershipsResponse#channel_arn #channel_arn} => String
1265
+ # * {Types::ListChannelMembershipsResponse#channel_memberships #channel_memberships} => Array&lt;Types::ChannelMembershipSummary&gt;
1266
+ # * {Types::ListChannelMembershipsResponse#next_token #next_token} => String
1267
+ #
1268
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1269
+ #
1270
+ # @example Request syntax with placeholder values
1271
+ #
1272
+ # resp = client.list_channel_memberships({
1273
+ # channel_arn: "ChimeArn", # required
1274
+ # type: "DEFAULT", # accepts DEFAULT, HIDDEN
1275
+ # max_results: 1,
1276
+ # next_token: "NextToken",
1277
+ # chime_bearer: "ChimeArn", # required
1278
+ # })
1279
+ #
1280
+ # @example Response structure
1281
+ #
1282
+ # resp.channel_arn #=> String
1283
+ # resp.channel_memberships #=> Array
1284
+ # resp.channel_memberships[0].member.arn #=> String
1285
+ # resp.channel_memberships[0].member.name #=> String
1286
+ # resp.next_token #=> String
1287
+ #
1288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMemberships AWS API Documentation
1289
+ #
1290
+ # @overload list_channel_memberships(params = {})
1291
+ # @param [Hash] params ({})
1292
+ def list_channel_memberships(params = {}, options = {})
1293
+ req = build_request(:list_channel_memberships, params)
1294
+ req.send_request(options)
1295
+ end
1296
+
1297
+ # Lists all channels that a particular `AppInstanceUser` is a part of.
1298
+ # Only an `AppInstanceAdmin` can call the API with a user ARN that is
1299
+ # not their own.
1300
+ #
1301
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1302
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1303
+ # in the header.
1304
+ #
1305
+ # </note>
1306
+ #
1307
+ # @option params [String] :app_instance_user_arn
1308
+ # The ARN of the `AppInstanceUser`s
1309
+ #
1310
+ # @option params [Integer] :max_results
1311
+ # The maximum number of users that you want returned.
1312
+ #
1313
+ # @option params [String] :next_token
1314
+ # The token returned from previous API requests until the number of
1315
+ # channel memberships is reached.
1316
+ #
1317
+ # @option params [required, String] :chime_bearer
1318
+ # The `AppInstanceUserArn` of the user that makes the API call.
1319
+ #
1320
+ # @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1321
+ #
1322
+ # * {Types::ListChannelMembershipsForAppInstanceUserResponse#channel_memberships #channel_memberships} => Array&lt;Types::ChannelMembershipForAppInstanceUserSummary&gt;
1323
+ # * {Types::ListChannelMembershipsForAppInstanceUserResponse#next_token #next_token} => String
1324
+ #
1325
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1326
+ #
1327
+ # @example Request syntax with placeholder values
1328
+ #
1329
+ # resp = client.list_channel_memberships_for_app_instance_user({
1330
+ # app_instance_user_arn: "ChimeArn",
1331
+ # max_results: 1,
1332
+ # next_token: "NextToken",
1333
+ # chime_bearer: "ChimeArn", # required
1334
+ # })
1335
+ #
1336
+ # @example Response structure
1337
+ #
1338
+ # resp.channel_memberships #=> Array
1339
+ # resp.channel_memberships[0].channel_summary.name #=> String
1340
+ # resp.channel_memberships[0].channel_summary.channel_arn #=> String
1341
+ # resp.channel_memberships[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
1342
+ # resp.channel_memberships[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
1343
+ # resp.channel_memberships[0].channel_summary.metadata #=> String
1344
+ # resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
1345
+ # resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
1346
+ # resp.channel_memberships[0].app_instance_user_membership_summary.read_marker_timestamp #=> Time
1347
+ # resp.next_token #=> String
1348
+ #
1349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser AWS API Documentation
1350
+ #
1351
+ # @overload list_channel_memberships_for_app_instance_user(params = {})
1352
+ # @param [Hash] params ({})
1353
+ def list_channel_memberships_for_app_instance_user(params = {}, options = {})
1354
+ req = build_request(:list_channel_memberships_for_app_instance_user, params)
1355
+ req.send_request(options)
1356
+ end
1357
+
1358
+ # List all the messages in a channel. Returns a paginated list of
1359
+ # `ChannelMessages`. By default, sorted by creation timestamp in
1360
+ # descending order.
1361
+ #
1362
+ # <note markdown="1"> Redacted messages appear in the results as empty, since they are only
1363
+ # redacted, not deleted. Deleted messages do not appear in the results.
1364
+ # This action always returns the latest version of an edited message.
1365
+ #
1366
+ # Also, the x-amz-chime-bearer request header is mandatory. Use the
1367
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1368
+ # in the header.
1369
+ #
1370
+ # </note>
1371
+ #
1372
+ # @option params [required, String] :channel_arn
1373
+ # The ARN of the channel.
1374
+ #
1375
+ # @option params [String] :sort_order
1376
+ # The order in which you want messages sorted. Default is Descending,
1377
+ # based on time created.
1378
+ #
1379
+ # @option params [Time,DateTime,Date,Integer,String] :not_before
1380
+ # The initial or starting time stamp for your requested messages.
1381
+ #
1382
+ # @option params [Time,DateTime,Date,Integer,String] :not_after
1383
+ # The final or ending time stamp for your requested messages.
1384
+ #
1385
+ # @option params [Integer] :max_results
1386
+ # The maximum number of messages that you want returned.
1387
+ #
1388
+ # @option params [String] :next_token
1389
+ # The token passed by previous API calls until all requested messages
1390
+ # are returned.
1391
+ #
1392
+ # @option params [required, String] :chime_bearer
1393
+ # The `AppInstanceUserArn` of the user that makes the API call.
1394
+ #
1395
+ # @return [Types::ListChannelMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1396
+ #
1397
+ # * {Types::ListChannelMessagesResponse#channel_arn #channel_arn} => String
1398
+ # * {Types::ListChannelMessagesResponse#next_token #next_token} => String
1399
+ # * {Types::ListChannelMessagesResponse#channel_messages #channel_messages} => Array&lt;Types::ChannelMessageSummary&gt;
1400
+ #
1401
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1402
+ #
1403
+ # @example Request syntax with placeholder values
1404
+ #
1405
+ # resp = client.list_channel_messages({
1406
+ # channel_arn: "ChimeArn", # required
1407
+ # sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
1408
+ # not_before: Time.now,
1409
+ # not_after: Time.now,
1410
+ # max_results: 1,
1411
+ # next_token: "NextToken",
1412
+ # chime_bearer: "ChimeArn", # required
1413
+ # })
1414
+ #
1415
+ # @example Response structure
1416
+ #
1417
+ # resp.channel_arn #=> String
1418
+ # resp.next_token #=> String
1419
+ # resp.channel_messages #=> Array
1420
+ # resp.channel_messages[0].message_id #=> String
1421
+ # resp.channel_messages[0].content #=> String
1422
+ # resp.channel_messages[0].metadata #=> String
1423
+ # resp.channel_messages[0].type #=> String, one of "STANDARD", "CONTROL"
1424
+ # resp.channel_messages[0].created_timestamp #=> Time
1425
+ # resp.channel_messages[0].last_updated_timestamp #=> Time
1426
+ # resp.channel_messages[0].last_edited_timestamp #=> Time
1427
+ # resp.channel_messages[0].sender.arn #=> String
1428
+ # resp.channel_messages[0].sender.name #=> String
1429
+ # resp.channel_messages[0].redacted #=> Boolean
1430
+ #
1431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
1432
+ #
1433
+ # @overload list_channel_messages(params = {})
1434
+ # @param [Hash] params ({})
1435
+ def list_channel_messages(params = {}, options = {})
1436
+ req = build_request(:list_channel_messages, params)
1437
+ req.send_request(options)
1438
+ end
1439
+
1440
+ # Lists all the moderators for a channel.
1441
+ #
1442
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1443
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1444
+ # in the header.
1445
+ #
1446
+ # </note>
1447
+ #
1448
+ # @option params [required, String] :channel_arn
1449
+ # The ARN of the channel.
1450
+ #
1451
+ # @option params [Integer] :max_results
1452
+ # The maximum number of moderators that you want returned.
1453
+ #
1454
+ # @option params [String] :next_token
1455
+ # The token passed by previous API calls until all requested moderators
1456
+ # are returned.
1457
+ #
1458
+ # @option params [required, String] :chime_bearer
1459
+ # The `AppInstanceUserArn` of the user that makes the API call.
1460
+ #
1461
+ # @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1462
+ #
1463
+ # * {Types::ListChannelModeratorsResponse#channel_arn #channel_arn} => String
1464
+ # * {Types::ListChannelModeratorsResponse#next_token #next_token} => String
1465
+ # * {Types::ListChannelModeratorsResponse#channel_moderators #channel_moderators} => Array&lt;Types::ChannelModeratorSummary&gt;
1466
+ #
1467
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1468
+ #
1469
+ # @example Request syntax with placeholder values
1470
+ #
1471
+ # resp = client.list_channel_moderators({
1472
+ # channel_arn: "ChimeArn", # required
1473
+ # max_results: 1,
1474
+ # next_token: "NextToken",
1475
+ # chime_bearer: "ChimeArn", # required
1476
+ # })
1477
+ #
1478
+ # @example Response structure
1479
+ #
1480
+ # resp.channel_arn #=> String
1481
+ # resp.next_token #=> String
1482
+ # resp.channel_moderators #=> Array
1483
+ # resp.channel_moderators[0].moderator.arn #=> String
1484
+ # resp.channel_moderators[0].moderator.name #=> String
1485
+ #
1486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelModerators AWS API Documentation
1487
+ #
1488
+ # @overload list_channel_moderators(params = {})
1489
+ # @param [Hash] params ({})
1490
+ def list_channel_moderators(params = {}, options = {})
1491
+ req = build_request(:list_channel_moderators, params)
1492
+ req.send_request(options)
1493
+ end
1494
+
1495
+ # Lists all Channels created under a single Chime App as a paginated
1496
+ # list. You can specify filters to narrow results.
1497
+ #
1498
+ # **Functionality &amp; restrictions**
1499
+ #
1500
+ # * Use privacy = `PUBLIC` to retrieve all public channels in the
1501
+ # account.
1502
+ #
1503
+ # * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
1504
+ # private channels in an account.
1505
+ #
1506
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1507
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1508
+ # in the header.
1509
+ #
1510
+ # </note>
1511
+ #
1512
+ # @option params [required, String] :app_instance_arn
1513
+ # The ARN of the `AppInstance`.
1514
+ #
1515
+ # @option params [String] :privacy
1516
+ # The privacy setting. `PUBLIC` retrieves all the public channels.
1517
+ # `PRIVATE` retrieves private channels. Only an `AppInstanceAdmin` can
1518
+ # retrieve private channels.
1519
+ #
1520
+ # @option params [Integer] :max_results
1521
+ # The maximum number of channels that you want to return.
1522
+ #
1523
+ # @option params [String] :next_token
1524
+ # The token passed by previous API calls until all requested channels
1525
+ # are returned.
1526
+ #
1527
+ # @option params [required, String] :chime_bearer
1528
+ # The `AppInstanceUserArn` of the user that makes the API call.
1529
+ #
1530
+ # @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1531
+ #
1532
+ # * {Types::ListChannelsResponse#channels #channels} => Array&lt;Types::ChannelSummary&gt;
1533
+ # * {Types::ListChannelsResponse#next_token #next_token} => String
1534
+ #
1535
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1536
+ #
1537
+ # @example Request syntax with placeholder values
1538
+ #
1539
+ # resp = client.list_channels({
1540
+ # app_instance_arn: "ChimeArn", # required
1541
+ # privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
1542
+ # max_results: 1,
1543
+ # next_token: "NextToken",
1544
+ # chime_bearer: "ChimeArn", # required
1545
+ # })
1546
+ #
1547
+ # @example Response structure
1548
+ #
1549
+ # resp.channels #=> Array
1550
+ # resp.channels[0].name #=> String
1551
+ # resp.channels[0].channel_arn #=> String
1552
+ # resp.channels[0].mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
1553
+ # resp.channels[0].privacy #=> String, one of "PUBLIC", "PRIVATE"
1554
+ # resp.channels[0].metadata #=> String
1555
+ # resp.channels[0].last_message_timestamp #=> Time
1556
+ # resp.next_token #=> String
1557
+ #
1558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannels AWS API Documentation
1559
+ #
1560
+ # @overload list_channels(params = {})
1561
+ # @param [Hash] params ({})
1562
+ def list_channels(params = {}, options = {})
1563
+ req = build_request(:list_channels, params)
1564
+ req.send_request(options)
1565
+ end
1566
+
1567
+ # A list of the channels moderated by an `AppInstanceUser`.
1568
+ #
1569
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1570
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1571
+ # in the header.
1572
+ #
1573
+ # </note>
1574
+ #
1575
+ # @option params [String] :app_instance_user_arn
1576
+ # The ARN of the user in the moderated channel.
1577
+ #
1578
+ # @option params [Integer] :max_results
1579
+ # The maximum number of channels in the request.
1580
+ #
1581
+ # @option params [String] :next_token
1582
+ # The token returned from previous API requests until the number of
1583
+ # channels moderated by the user is reached.
1584
+ #
1585
+ # @option params [required, String] :chime_bearer
1586
+ # The `AppInstanceUserArn` of the user that makes the API call.
1587
+ #
1588
+ # @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1589
+ #
1590
+ # * {Types::ListChannelsModeratedByAppInstanceUserResponse#channels #channels} => Array&lt;Types::ChannelModeratedByAppInstanceUserSummary&gt;
1591
+ # * {Types::ListChannelsModeratedByAppInstanceUserResponse#next_token #next_token} => String
1592
+ #
1593
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1594
+ #
1595
+ # @example Request syntax with placeholder values
1596
+ #
1597
+ # resp = client.list_channels_moderated_by_app_instance_user({
1598
+ # app_instance_user_arn: "ChimeArn",
1599
+ # max_results: 1,
1600
+ # next_token: "NextToken",
1601
+ # chime_bearer: "ChimeArn", # required
1602
+ # })
1603
+ #
1604
+ # @example Response structure
1605
+ #
1606
+ # resp.channels #=> Array
1607
+ # resp.channels[0].channel_summary.name #=> String
1608
+ # resp.channels[0].channel_summary.channel_arn #=> String
1609
+ # resp.channels[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
1610
+ # resp.channels[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
1611
+ # resp.channels[0].channel_summary.metadata #=> String
1612
+ # resp.channels[0].channel_summary.last_message_timestamp #=> Time
1613
+ # resp.next_token #=> String
1614
+ #
1615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsModeratedByAppInstanceUser AWS API Documentation
1616
+ #
1617
+ # @overload list_channels_moderated_by_app_instance_user(params = {})
1618
+ # @param [Hash] params ({})
1619
+ def list_channels_moderated_by_app_instance_user(params = {}, options = {})
1620
+ req = build_request(:list_channels_moderated_by_app_instance_user, params)
1621
+ req.send_request(options)
1622
+ end
1623
+
1624
+ # Redacts message content, but not metadata. The message exists in the
1625
+ # back end, but the action returns null content, and the state shows as
1626
+ # redacted.
1627
+ #
1628
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1629
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1630
+ # in the header.
1631
+ #
1632
+ # </note>
1633
+ #
1634
+ # @option params [required, String] :channel_arn
1635
+ # The ARN of the channel containing the messages that you want to
1636
+ # redact.
1637
+ #
1638
+ # @option params [required, String] :message_id
1639
+ # The ID of the message being redacted.
1640
+ #
1641
+ # @option params [required, String] :chime_bearer
1642
+ # The `AppInstanceUserArn` of the user that makes the API call.
1643
+ #
1644
+ # @return [Types::RedactChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1645
+ #
1646
+ # * {Types::RedactChannelMessageResponse#channel_arn #channel_arn} => String
1647
+ # * {Types::RedactChannelMessageResponse#message_id #message_id} => String
1648
+ #
1649
+ # @example Request syntax with placeholder values
1650
+ #
1651
+ # resp = client.redact_channel_message({
1652
+ # channel_arn: "ChimeArn", # required
1653
+ # message_id: "MessageId", # required
1654
+ # chime_bearer: "ChimeArn", # required
1655
+ # })
1656
+ #
1657
+ # @example Response structure
1658
+ #
1659
+ # resp.channel_arn #=> String
1660
+ # resp.message_id #=> String
1661
+ #
1662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessage AWS API Documentation
1663
+ #
1664
+ # @overload redact_channel_message(params = {})
1665
+ # @param [Hash] params ({})
1666
+ def redact_channel_message(params = {}, options = {})
1667
+ req = build_request(:redact_channel_message, params)
1668
+ req.send_request(options)
1669
+ end
1670
+
1671
+ # Sends a message to a particular channel that the member is a part of.
1672
+ #
1673
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1674
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1675
+ # in the header.
1676
+ #
1677
+ # Also, `STANDARD` messages can contain 4KB of data and the 1KB of
1678
+ # metadata. `CONTROL` messages can contain 30 bytes of data and no
1679
+ # metadata.
1680
+ #
1681
+ # </note>
1682
+ #
1683
+ # @option params [required, String] :channel_arn
1684
+ # The ARN of the channel.
1685
+ #
1686
+ # @option params [required, String] :content
1687
+ # The content of the message.
1688
+ #
1689
+ # @option params [required, String] :type
1690
+ # The type of message, `STANDARD` or `CONTROL`.
1691
+ #
1692
+ # @option params [required, String] :persistence
1693
+ # Boolean that controls whether the message is persisted on the back
1694
+ # end. Required.
1695
+ #
1696
+ # @option params [String] :metadata
1697
+ # The optional metadata for each message.
1698
+ #
1699
+ # @option params [required, String] :client_request_token
1700
+ # The `Idempotency` token for each client request.
1701
+ #
1702
+ # **A suitable default value is auto-generated.** You should normally
1703
+ # not need to pass this option.**
1704
+ #
1705
+ # @option params [required, String] :chime_bearer
1706
+ # The `AppInstanceUserArn` of the user that makes the API call.
1707
+ #
1708
+ # @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1709
+ #
1710
+ # * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
1711
+ # * {Types::SendChannelMessageResponse#message_id #message_id} => String
1712
+ #
1713
+ # @example Request syntax with placeholder values
1714
+ #
1715
+ # resp = client.send_channel_message({
1716
+ # channel_arn: "ChimeArn", # required
1717
+ # content: "NonEmptyContent", # required
1718
+ # type: "STANDARD", # required, accepts STANDARD, CONTROL
1719
+ # persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
1720
+ # metadata: "Metadata",
1721
+ # client_request_token: "ClientRequestToken", # required
1722
+ # chime_bearer: "ChimeArn", # required
1723
+ # })
1724
+ #
1725
+ # @example Response structure
1726
+ #
1727
+ # resp.channel_arn #=> String
1728
+ # resp.message_id #=> String
1729
+ #
1730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessage AWS API Documentation
1731
+ #
1732
+ # @overload send_channel_message(params = {})
1733
+ # @param [Hash] params ({})
1734
+ def send_channel_message(params = {}, options = {})
1735
+ req = build_request(:send_channel_message, params)
1736
+ req.send_request(options)
1737
+ end
1738
+
1739
+ # Update a channel's attributes.
1740
+ #
1741
+ # **Restriction**\: You can't change a channel's privacy.
1742
+ #
1743
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1744
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1745
+ # in the header.
1746
+ #
1747
+ # </note>
1748
+ #
1749
+ # @option params [required, String] :channel_arn
1750
+ # The ARN of the channel.
1751
+ #
1752
+ # @option params [required, String] :name
1753
+ # The name of the channel.
1754
+ #
1755
+ # @option params [required, String] :mode
1756
+ # The mode of the update request.
1757
+ #
1758
+ # @option params [String] :metadata
1759
+ # The metadata for the update request.
1760
+ #
1761
+ # @option params [required, String] :chime_bearer
1762
+ # The `AppInstanceUserArn` of the user that makes the API call.
1763
+ #
1764
+ # @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1765
+ #
1766
+ # * {Types::UpdateChannelResponse#channel_arn #channel_arn} => String
1767
+ #
1768
+ # @example Request syntax with placeholder values
1769
+ #
1770
+ # resp = client.update_channel({
1771
+ # channel_arn: "ChimeArn", # required
1772
+ # name: "NonEmptyResourceName", # required
1773
+ # mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
1774
+ # metadata: "Metadata",
1775
+ # chime_bearer: "ChimeArn", # required
1776
+ # })
1777
+ #
1778
+ # @example Response structure
1779
+ #
1780
+ # resp.channel_arn #=> String
1781
+ #
1782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannel AWS API Documentation
1783
+ #
1784
+ # @overload update_channel(params = {})
1785
+ # @param [Hash] params ({})
1786
+ def update_channel(params = {}, options = {})
1787
+ req = build_request(:update_channel, params)
1788
+ req.send_request(options)
1789
+ end
1790
+
1791
+ # Updates the content of a message.
1792
+ #
1793
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1794
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1795
+ # in the header.
1796
+ #
1797
+ # </note>
1798
+ #
1799
+ # @option params [required, String] :channel_arn
1800
+ # The ARN of the channel.
1801
+ #
1802
+ # @option params [required, String] :message_id
1803
+ # The ID string of the message being updated.
1804
+ #
1805
+ # @option params [String] :content
1806
+ # The content of the message being updated.
1807
+ #
1808
+ # @option params [String] :metadata
1809
+ # The metadata of the message being updated.
1810
+ #
1811
+ # @option params [required, String] :chime_bearer
1812
+ # The `AppInstanceUserArn` of the user that makes the API call.
1813
+ #
1814
+ # @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1815
+ #
1816
+ # * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
1817
+ # * {Types::UpdateChannelMessageResponse#message_id #message_id} => String
1818
+ #
1819
+ # @example Request syntax with placeholder values
1820
+ #
1821
+ # resp = client.update_channel_message({
1822
+ # channel_arn: "ChimeArn", # required
1823
+ # message_id: "MessageId", # required
1824
+ # content: "Content",
1825
+ # metadata: "Metadata",
1826
+ # chime_bearer: "ChimeArn", # required
1827
+ # })
1828
+ #
1829
+ # @example Response structure
1830
+ #
1831
+ # resp.channel_arn #=> String
1832
+ # resp.message_id #=> String
1833
+ #
1834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessage AWS API Documentation
1835
+ #
1836
+ # @overload update_channel_message(params = {})
1837
+ # @param [Hash] params ({})
1838
+ def update_channel_message(params = {}, options = {})
1839
+ req = build_request(:update_channel_message, params)
1840
+ req.send_request(options)
1841
+ end
1842
+
1843
+ # The details of the time when a user last read messages in a channel.
1844
+ #
1845
+ # <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
1846
+ # `AppInstanceUserArn` of the user that makes the API call as the value
1847
+ # in the header.
1848
+ #
1849
+ # </note>
1850
+ #
1851
+ # @option params [required, String] :channel_arn
1852
+ # The ARN of the channel.
1853
+ #
1854
+ # @option params [required, String] :chime_bearer
1855
+ # The `AppInstanceUserArn` of the user that makes the API call.
1856
+ #
1857
+ # @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1858
+ #
1859
+ # * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
1860
+ #
1861
+ # @example Request syntax with placeholder values
1862
+ #
1863
+ # resp = client.update_channel_read_marker({
1864
+ # channel_arn: "ChimeArn", # required
1865
+ # chime_bearer: "ChimeArn", # required
1866
+ # })
1867
+ #
1868
+ # @example Response structure
1869
+ #
1870
+ # resp.channel_arn #=> String
1871
+ #
1872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker AWS API Documentation
1873
+ #
1874
+ # @overload update_channel_read_marker(params = {})
1875
+ # @param [Hash] params ({})
1876
+ def update_channel_read_marker(params = {}, options = {})
1877
+ req = build_request(:update_channel_read_marker, params)
1878
+ req.send_request(options)
1879
+ end
1880
+
1881
+ # @!endgroup
1882
+
1883
+ # @param params ({})
1884
+ # @api private
1885
+ def build_request(operation_name, params = {})
1886
+ handlers = @handlers.for(operation_name)
1887
+ context = Seahorse::Client::RequestContext.new(
1888
+ operation_name: operation_name,
1889
+ operation: config.api.operation(operation_name),
1890
+ client: self,
1891
+ params: params,
1892
+ config: config)
1893
+ context[:gem_name] = 'aws-sdk-chimesdkmessaging'
1894
+ context[:gem_version] = '1.0.0'
1895
+ Seahorse::Client::Request.new(handlers, context)
1896
+ end
1897
+
1898
+ # @api private
1899
+ # @deprecated
1900
+ def waiter_names
1901
+ []
1902
+ end
1903
+
1904
+ class << self
1905
+
1906
+ # @api private
1907
+ attr_reader :identifier
1908
+
1909
+ # @api private
1910
+ def errors_module
1911
+ Errors
1912
+ end
1913
+
1914
+ end
1915
+ end
1916
+ end