aws-sdk-chimesdkidentity 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 13e7ae6a222f5c691e79efac91e423a8e3db5326621c585a804af828a317df2f
4
+ data.tar.gz: 9aca154c86fe70a42d55eaf11c423e495d001524b2e21e7c5f819c6064e8e1b8
5
+ SHA512:
6
+ metadata.gz: 05ded1e8f5931e1992259f59a4dc627a82fbeacf5aa15306d02f23519c504a456ecc76afcddece56cd351eae375a6dd0ba50673a5e9be34d202c0aad07d56425
7
+ data.tar.gz: 39020d582fdba8063b158ab6129ee6d5484d54a874366a2dcf7ada109aeafe19c10dee1e41fb062cbc179f84410a757e688ebe321ac0f9e266b5295e5a004b43
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-chimesdkidentity`.
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-chimesdkidentity/types'
15
+ require_relative 'aws-sdk-chimesdkidentity/client_api'
16
+ require_relative 'aws-sdk-chimesdkidentity/client'
17
+ require_relative 'aws-sdk-chimesdkidentity/errors'
18
+ require_relative 'aws-sdk-chimesdkidentity/resource'
19
+ require_relative 'aws-sdk-chimesdkidentity/customizations'
20
+
21
+ # This module provides support for Amazon Chime SDK Identity. This module is available in the
22
+ # `aws-sdk-chimesdkidentity` 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_identity = Aws::ChimeSDKIdentity::Client.new
31
+ # resp = chime_sdk_identity.create_app_instance(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon Chime SDK Identity are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::ChimeSDKIdentity::Errors::ServiceError
43
+ # # rescues all Amazon Chime SDK Identity API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::ChimeSDKIdentity
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,962 @@
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(:chimesdkidentity)
34
+
35
+ module Aws::ChimeSDKIdentity
36
+ # An API client for ChimeSDKIdentity. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::ChimeSDKIdentity::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 = :chimesdkidentity
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
+ # Creates an Amazon Chime SDK messaging `AppInstance` under an AWS
331
+ # account. Only SDK messaging customers use this API.
332
+ # `CreateAppInstance` supports idempotency behavior as described in the
333
+ # AWS API Standard.
334
+ #
335
+ # identity
336
+ #
337
+ # @option params [required, String] :name
338
+ # The name of the `AppInstance`.
339
+ #
340
+ # @option params [String] :metadata
341
+ # The metadata of the `AppInstance`. Limited to a 1KB string in UTF-8.
342
+ #
343
+ # @option params [required, String] :client_request_token
344
+ # The `ClientRequestToken` of the `AppInstance`.
345
+ #
346
+ # **A suitable default value is auto-generated.** You should normally
347
+ # not need to pass this option.**
348
+ #
349
+ # @option params [Array<Types::Tag>] :tags
350
+ # Tags assigned to the `AppInstanceUser`.
351
+ #
352
+ # @return [Types::CreateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
353
+ #
354
+ # * {Types::CreateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
355
+ #
356
+ # @example Request syntax with placeholder values
357
+ #
358
+ # resp = client.create_app_instance({
359
+ # name: "NonEmptyResourceName", # required
360
+ # metadata: "Metadata",
361
+ # client_request_token: "ClientRequestToken", # required
362
+ # tags: [
363
+ # {
364
+ # key: "TagKey", # required
365
+ # value: "TagValue", # required
366
+ # },
367
+ # ],
368
+ # })
369
+ #
370
+ # @example Response structure
371
+ #
372
+ # resp.app_instance_arn #=> String
373
+ #
374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstance AWS API Documentation
375
+ #
376
+ # @overload create_app_instance(params = {})
377
+ # @param [Hash] params ({})
378
+ def create_app_instance(params = {}, options = {})
379
+ req = build_request(:create_app_instance, params)
380
+ req.send_request(options)
381
+ end
382
+
383
+ # Promotes an `AppInstanceUser` to an `AppInstanceAdmin`. The promoted
384
+ # user can perform the following actions.
385
+ #
386
+ # * `ChannelModerator` actions across all channels in the `AppInstance`.
387
+ #
388
+ # * `DeleteChannelMessage` actions.
389
+ #
390
+ # Only an `AppInstanceUser` can be promoted to an `AppInstanceAdmin`
391
+ # role.
392
+ #
393
+ # @option params [required, String] :app_instance_admin_arn
394
+ # The ARN of the administrator of the current `AppInstance`.
395
+ #
396
+ # @option params [required, String] :app_instance_arn
397
+ # The ARN of the `AppInstance`.
398
+ #
399
+ # @return [Types::CreateAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
400
+ #
401
+ # * {Types::CreateAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::Identity
402
+ # * {Types::CreateAppInstanceAdminResponse#app_instance_arn #app_instance_arn} => String
403
+ #
404
+ # @example Request syntax with placeholder values
405
+ #
406
+ # resp = client.create_app_instance_admin({
407
+ # app_instance_admin_arn: "ChimeArn", # required
408
+ # app_instance_arn: "ChimeArn", # required
409
+ # })
410
+ #
411
+ # @example Response structure
412
+ #
413
+ # resp.app_instance_admin.arn #=> String
414
+ # resp.app_instance_admin.name #=> String
415
+ # resp.app_instance_arn #=> String
416
+ #
417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceAdmin AWS API Documentation
418
+ #
419
+ # @overload create_app_instance_admin(params = {})
420
+ # @param [Hash] params ({})
421
+ def create_app_instance_admin(params = {}, options = {})
422
+ req = build_request(:create_app_instance_admin, params)
423
+ req.send_request(options)
424
+ end
425
+
426
+ # Creates a user under an Amazon Chime `AppInstance`. The request
427
+ # consists of a unique `appInstanceUserId` and `Name` for that user.
428
+ #
429
+ # @option params [required, String] :app_instance_arn
430
+ # The ARN of the `AppInstance` request.
431
+ #
432
+ # @option params [required, String] :app_instance_user_id
433
+ # The user ID of the `AppInstance`.
434
+ #
435
+ # @option params [required, String] :name
436
+ # The user's name.
437
+ #
438
+ # @option params [String] :metadata
439
+ # The request's metadata. Limited to a 1KB string in UTF-8.
440
+ #
441
+ # @option params [required, String] :client_request_token
442
+ # The token assigned to the user requesting an `AppInstance`.
443
+ #
444
+ # **A suitable default value is auto-generated.** You should normally
445
+ # not need to pass this option.**
446
+ #
447
+ # @option params [Array<Types::Tag>] :tags
448
+ # Tags assigned to the `AppInstanceUser`.
449
+ #
450
+ # @return [Types::CreateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
451
+ #
452
+ # * {Types::CreateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
453
+ #
454
+ # @example Request syntax with placeholder values
455
+ #
456
+ # resp = client.create_app_instance_user({
457
+ # app_instance_arn: "ChimeArn", # required
458
+ # app_instance_user_id: "UserId", # required
459
+ # name: "UserName", # required
460
+ # metadata: "Metadata",
461
+ # client_request_token: "ClientRequestToken", # required
462
+ # tags: [
463
+ # {
464
+ # key: "TagKey", # required
465
+ # value: "TagValue", # required
466
+ # },
467
+ # ],
468
+ # })
469
+ #
470
+ # @example Response structure
471
+ #
472
+ # resp.app_instance_user_arn #=> String
473
+ #
474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceUser AWS API Documentation
475
+ #
476
+ # @overload create_app_instance_user(params = {})
477
+ # @param [Hash] params ({})
478
+ def create_app_instance_user(params = {}, options = {})
479
+ req = build_request(:create_app_instance_user, params)
480
+ req.send_request(options)
481
+ end
482
+
483
+ # Deletes an `AppInstance` and all associated data asynchronously.
484
+ #
485
+ # @option params [required, String] :app_instance_arn
486
+ # The ARN of the `AppInstance`.
487
+ #
488
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
489
+ #
490
+ # @example Request syntax with placeholder values
491
+ #
492
+ # resp = client.delete_app_instance({
493
+ # app_instance_arn: "ChimeArn", # required
494
+ # })
495
+ #
496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstance AWS API Documentation
497
+ #
498
+ # @overload delete_app_instance(params = {})
499
+ # @param [Hash] params ({})
500
+ def delete_app_instance(params = {}, options = {})
501
+ req = build_request(:delete_app_instance, params)
502
+ req.send_request(options)
503
+ end
504
+
505
+ # Demotes an `AppInstanceAdmin` to an `AppInstanceUser`. This action
506
+ # does not delete the user.
507
+ #
508
+ # @option params [required, String] :app_instance_admin_arn
509
+ # The ARN of the `AppInstance`'s administrator.
510
+ #
511
+ # @option params [required, String] :app_instance_arn
512
+ # The ARN of the `AppInstance`.
513
+ #
514
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
515
+ #
516
+ # @example Request syntax with placeholder values
517
+ #
518
+ # resp = client.delete_app_instance_admin({
519
+ # app_instance_admin_arn: "ChimeArn", # required
520
+ # app_instance_arn: "ChimeArn", # required
521
+ # })
522
+ #
523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceAdmin AWS API Documentation
524
+ #
525
+ # @overload delete_app_instance_admin(params = {})
526
+ # @param [Hash] params ({})
527
+ def delete_app_instance_admin(params = {}, options = {})
528
+ req = build_request(:delete_app_instance_admin, params)
529
+ req.send_request(options)
530
+ end
531
+
532
+ # Deletes an `AppInstanceUser`.
533
+ #
534
+ # @option params [required, String] :app_instance_user_arn
535
+ # The ARN of the user request being deleted.
536
+ #
537
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
538
+ #
539
+ # @example Request syntax with placeholder values
540
+ #
541
+ # resp = client.delete_app_instance_user({
542
+ # app_instance_user_arn: "ChimeArn", # required
543
+ # })
544
+ #
545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DeleteAppInstanceUser AWS API Documentation
546
+ #
547
+ # @overload delete_app_instance_user(params = {})
548
+ # @param [Hash] params ({})
549
+ def delete_app_instance_user(params = {}, options = {})
550
+ req = build_request(:delete_app_instance_user, params)
551
+ req.send_request(options)
552
+ end
553
+
554
+ # Returns the full details of an `AppInstance`.
555
+ #
556
+ # @option params [required, String] :app_instance_arn
557
+ # The ARN of the `AppInstance`.
558
+ #
559
+ # @return [Types::DescribeAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
560
+ #
561
+ # * {Types::DescribeAppInstanceResponse#app_instance #app_instance} => Types::AppInstance
562
+ #
563
+ # @example Request syntax with placeholder values
564
+ #
565
+ # resp = client.describe_app_instance({
566
+ # app_instance_arn: "ChimeArn", # required
567
+ # })
568
+ #
569
+ # @example Response structure
570
+ #
571
+ # resp.app_instance.app_instance_arn #=> String
572
+ # resp.app_instance.name #=> String
573
+ # resp.app_instance.created_timestamp #=> Time
574
+ # resp.app_instance.last_updated_timestamp #=> Time
575
+ # resp.app_instance.metadata #=> String
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstance AWS API Documentation
578
+ #
579
+ # @overload describe_app_instance(params = {})
580
+ # @param [Hash] params ({})
581
+ def describe_app_instance(params = {}, options = {})
582
+ req = build_request(:describe_app_instance, params)
583
+ req.send_request(options)
584
+ end
585
+
586
+ # Returns the full details of an `AppInstanceAdmin`.
587
+ #
588
+ # @option params [required, String] :app_instance_admin_arn
589
+ # The ARN of the `AppInstanceAdmin`.
590
+ #
591
+ # @option params [required, String] :app_instance_arn
592
+ # The ARN of the `AppInstance`.
593
+ #
594
+ # @return [Types::DescribeAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
595
+ #
596
+ # * {Types::DescribeAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::AppInstanceAdmin
597
+ #
598
+ # @example Request syntax with placeholder values
599
+ #
600
+ # resp = client.describe_app_instance_admin({
601
+ # app_instance_admin_arn: "ChimeArn", # required
602
+ # app_instance_arn: "ChimeArn", # required
603
+ # })
604
+ #
605
+ # @example Response structure
606
+ #
607
+ # resp.app_instance_admin.admin.arn #=> String
608
+ # resp.app_instance_admin.admin.name #=> String
609
+ # resp.app_instance_admin.app_instance_arn #=> String
610
+ # resp.app_instance_admin.created_timestamp #=> Time
611
+ #
612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceAdmin AWS API Documentation
613
+ #
614
+ # @overload describe_app_instance_admin(params = {})
615
+ # @param [Hash] params ({})
616
+ def describe_app_instance_admin(params = {}, options = {})
617
+ req = build_request(:describe_app_instance_admin, params)
618
+ req.send_request(options)
619
+ end
620
+
621
+ # Returns the full details of an `AppInstanceUser`.
622
+ #
623
+ # @option params [required, String] :app_instance_user_arn
624
+ # The ARN of the `AppInstanceUser`.
625
+ #
626
+ # @return [Types::DescribeAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
627
+ #
628
+ # * {Types::DescribeAppInstanceUserResponse#app_instance_user #app_instance_user} => Types::AppInstanceUser
629
+ #
630
+ # @example Request syntax with placeholder values
631
+ #
632
+ # resp = client.describe_app_instance_user({
633
+ # app_instance_user_arn: "ChimeArn", # required
634
+ # })
635
+ #
636
+ # @example Response structure
637
+ #
638
+ # resp.app_instance_user.app_instance_user_arn #=> String
639
+ # resp.app_instance_user.name #=> String
640
+ # resp.app_instance_user.metadata #=> String
641
+ # resp.app_instance_user.created_timestamp #=> Time
642
+ # resp.app_instance_user.last_updated_timestamp #=> Time
643
+ #
644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/DescribeAppInstanceUser AWS API Documentation
645
+ #
646
+ # @overload describe_app_instance_user(params = {})
647
+ # @param [Hash] params ({})
648
+ def describe_app_instance_user(params = {}, options = {})
649
+ req = build_request(:describe_app_instance_user, params)
650
+ req.send_request(options)
651
+ end
652
+
653
+ # Gets the retention settings for an `AppInstance`.
654
+ #
655
+ # @option params [required, String] :app_instance_arn
656
+ # The ARN of the `AppInstance`.
657
+ #
658
+ # @return [Types::GetAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
659
+ #
660
+ # * {Types::GetAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
661
+ # * {Types::GetAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
662
+ #
663
+ # @example Request syntax with placeholder values
664
+ #
665
+ # resp = client.get_app_instance_retention_settings({
666
+ # app_instance_arn: "ChimeArn", # required
667
+ # })
668
+ #
669
+ # @example Response structure
670
+ #
671
+ # resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
672
+ # resp.initiate_deletion_timestamp #=> Time
673
+ #
674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/GetAppInstanceRetentionSettings AWS API Documentation
675
+ #
676
+ # @overload get_app_instance_retention_settings(params = {})
677
+ # @param [Hash] params ({})
678
+ def get_app_instance_retention_settings(params = {}, options = {})
679
+ req = build_request(:get_app_instance_retention_settings, params)
680
+ req.send_request(options)
681
+ end
682
+
683
+ # Returns a list of the administrators in the `AppInstance`.
684
+ #
685
+ # @option params [required, String] :app_instance_arn
686
+ # The ARN of the `AppInstance`.
687
+ #
688
+ # @option params [Integer] :max_results
689
+ # The maximum number of administrators that you want to return.
690
+ #
691
+ # @option params [String] :next_token
692
+ # The token returned from previous API requests until the number of
693
+ # administrators is reached.
694
+ #
695
+ # @return [Types::ListAppInstanceAdminsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
696
+ #
697
+ # * {Types::ListAppInstanceAdminsResponse#app_instance_arn #app_instance_arn} => String
698
+ # * {Types::ListAppInstanceAdminsResponse#app_instance_admins #app_instance_admins} => Array&lt;Types::AppInstanceAdminSummary&gt;
699
+ # * {Types::ListAppInstanceAdminsResponse#next_token #next_token} => String
700
+ #
701
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
702
+ #
703
+ # @example Request syntax with placeholder values
704
+ #
705
+ # resp = client.list_app_instance_admins({
706
+ # app_instance_arn: "ChimeArn", # required
707
+ # max_results: 1,
708
+ # next_token: "NextToken",
709
+ # })
710
+ #
711
+ # @example Response structure
712
+ #
713
+ # resp.app_instance_arn #=> String
714
+ # resp.app_instance_admins #=> Array
715
+ # resp.app_instance_admins[0].admin.arn #=> String
716
+ # resp.app_instance_admins[0].admin.name #=> String
717
+ # resp.next_token #=> String
718
+ #
719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceAdmins AWS API Documentation
720
+ #
721
+ # @overload list_app_instance_admins(params = {})
722
+ # @param [Hash] params ({})
723
+ def list_app_instance_admins(params = {}, options = {})
724
+ req = build_request(:list_app_instance_admins, params)
725
+ req.send_request(options)
726
+ end
727
+
728
+ # List all `AppInstanceUsers` created under a single `AppInstance`.
729
+ #
730
+ # @option params [required, String] :app_instance_arn
731
+ # The ARN of the `AppInstance`.
732
+ #
733
+ # @option params [Integer] :max_results
734
+ # The maximum number of requests that you want returned.
735
+ #
736
+ # @option params [String] :next_token
737
+ # The token passed by previous API calls until all requested users are
738
+ # returned.
739
+ #
740
+ # @return [Types::ListAppInstanceUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
741
+ #
742
+ # * {Types::ListAppInstanceUsersResponse#app_instance_arn #app_instance_arn} => String
743
+ # * {Types::ListAppInstanceUsersResponse#app_instance_users #app_instance_users} => Array&lt;Types::AppInstanceUserSummary&gt;
744
+ # * {Types::ListAppInstanceUsersResponse#next_token #next_token} => String
745
+ #
746
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
747
+ #
748
+ # @example Request syntax with placeholder values
749
+ #
750
+ # resp = client.list_app_instance_users({
751
+ # app_instance_arn: "ChimeArn", # required
752
+ # max_results: 1,
753
+ # next_token: "NextToken",
754
+ # })
755
+ #
756
+ # @example Response structure
757
+ #
758
+ # resp.app_instance_arn #=> String
759
+ # resp.app_instance_users #=> Array
760
+ # resp.app_instance_users[0].app_instance_user_arn #=> String
761
+ # resp.app_instance_users[0].name #=> String
762
+ # resp.app_instance_users[0].metadata #=> String
763
+ # resp.next_token #=> String
764
+ #
765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceUsers AWS API Documentation
766
+ #
767
+ # @overload list_app_instance_users(params = {})
768
+ # @param [Hash] params ({})
769
+ def list_app_instance_users(params = {}, options = {})
770
+ req = build_request(:list_app_instance_users, params)
771
+ req.send_request(options)
772
+ end
773
+
774
+ # Lists all Amazon Chime `AppInstance`s created under a single AWS
775
+ # account.
776
+ #
777
+ # @option params [Integer] :max_results
778
+ # The maximum number of `AppInstance`s that you want to return.
779
+ #
780
+ # @option params [String] :next_token
781
+ # The token passed by previous API requests until you reach the maximum
782
+ # number of `AppInstances`.
783
+ #
784
+ # @return [Types::ListAppInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
785
+ #
786
+ # * {Types::ListAppInstancesResponse#app_instances #app_instances} => Array&lt;Types::AppInstanceSummary&gt;
787
+ # * {Types::ListAppInstancesResponse#next_token #next_token} => String
788
+ #
789
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
790
+ #
791
+ # @example Request syntax with placeholder values
792
+ #
793
+ # resp = client.list_app_instances({
794
+ # max_results: 1,
795
+ # next_token: "NextToken",
796
+ # })
797
+ #
798
+ # @example Response structure
799
+ #
800
+ # resp.app_instances #=> Array
801
+ # resp.app_instances[0].app_instance_arn #=> String
802
+ # resp.app_instances[0].name #=> String
803
+ # resp.app_instances[0].metadata #=> String
804
+ # resp.next_token #=> String
805
+ #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstances AWS API Documentation
807
+ #
808
+ # @overload list_app_instances(params = {})
809
+ # @param [Hash] params ({})
810
+ def list_app_instances(params = {}, options = {})
811
+ req = build_request(:list_app_instances, params)
812
+ req.send_request(options)
813
+ end
814
+
815
+ # Sets the amount of time in days that a given `AppInstance` retains
816
+ # data.
817
+ #
818
+ # @option params [required, String] :app_instance_arn
819
+ # The ARN of the `AppInstance`.
820
+ #
821
+ # @option params [required, Types::AppInstanceRetentionSettings] :app_instance_retention_settings
822
+ # The time in days to retain data. Data type: number.
823
+ #
824
+ # @return [Types::PutAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
825
+ #
826
+ # * {Types::PutAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
827
+ # * {Types::PutAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
828
+ #
829
+ # @example Request syntax with placeholder values
830
+ #
831
+ # resp = client.put_app_instance_retention_settings({
832
+ # app_instance_arn: "ChimeArn", # required
833
+ # app_instance_retention_settings: { # required
834
+ # channel_retention_settings: {
835
+ # retention_days: 1,
836
+ # },
837
+ # },
838
+ # })
839
+ #
840
+ # @example Response structure
841
+ #
842
+ # resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
843
+ # resp.initiate_deletion_timestamp #=> Time
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/PutAppInstanceRetentionSettings AWS API Documentation
846
+ #
847
+ # @overload put_app_instance_retention_settings(params = {})
848
+ # @param [Hash] params ({})
849
+ def put_app_instance_retention_settings(params = {}, options = {})
850
+ req = build_request(:put_app_instance_retention_settings, params)
851
+ req.send_request(options)
852
+ end
853
+
854
+ # Updates `AppInstance` metadata.
855
+ #
856
+ # @option params [required, String] :app_instance_arn
857
+ # The ARN of the `AppInstance`.
858
+ #
859
+ # @option params [required, String] :name
860
+ # The name that you want to change.
861
+ #
862
+ # @option params [required, String] :metadata
863
+ # The metadata that you want to change.
864
+ #
865
+ # @return [Types::UpdateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
866
+ #
867
+ # * {Types::UpdateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
868
+ #
869
+ # @example Request syntax with placeholder values
870
+ #
871
+ # resp = client.update_app_instance({
872
+ # app_instance_arn: "ChimeArn", # required
873
+ # name: "NonEmptyResourceName", # required
874
+ # metadata: "Metadata", # required
875
+ # })
876
+ #
877
+ # @example Response structure
878
+ #
879
+ # resp.app_instance_arn #=> String
880
+ #
881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstance AWS API Documentation
882
+ #
883
+ # @overload update_app_instance(params = {})
884
+ # @param [Hash] params ({})
885
+ def update_app_instance(params = {}, options = {})
886
+ req = build_request(:update_app_instance, params)
887
+ req.send_request(options)
888
+ end
889
+
890
+ # Updates the details of an `AppInstanceUser`. You can update names and
891
+ # metadata.
892
+ #
893
+ # @option params [required, String] :app_instance_user_arn
894
+ # The ARN of the `AppInstanceUser`.
895
+ #
896
+ # @option params [required, String] :name
897
+ # The name of the `AppInstanceUser`.
898
+ #
899
+ # @option params [required, String] :metadata
900
+ # The metadata of the `AppInstanceUser`.
901
+ #
902
+ # @return [Types::UpdateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
903
+ #
904
+ # * {Types::UpdateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
905
+ #
906
+ # @example Request syntax with placeholder values
907
+ #
908
+ # resp = client.update_app_instance_user({
909
+ # app_instance_user_arn: "ChimeArn", # required
910
+ # name: "UserName", # required
911
+ # metadata: "Metadata", # required
912
+ # })
913
+ #
914
+ # @example Response structure
915
+ #
916
+ # resp.app_instance_user_arn #=> String
917
+ #
918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/UpdateAppInstanceUser AWS API Documentation
919
+ #
920
+ # @overload update_app_instance_user(params = {})
921
+ # @param [Hash] params ({})
922
+ def update_app_instance_user(params = {}, options = {})
923
+ req = build_request(:update_app_instance_user, params)
924
+ req.send_request(options)
925
+ end
926
+
927
+ # @!endgroup
928
+
929
+ # @param params ({})
930
+ # @api private
931
+ def build_request(operation_name, params = {})
932
+ handlers = @handlers.for(operation_name)
933
+ context = Seahorse::Client::RequestContext.new(
934
+ operation_name: operation_name,
935
+ operation: config.api.operation(operation_name),
936
+ client: self,
937
+ params: params,
938
+ config: config)
939
+ context[:gem_name] = 'aws-sdk-chimesdkidentity'
940
+ context[:gem_version] = '1.0.0'
941
+ Seahorse::Client::Request.new(handlers, context)
942
+ end
943
+
944
+ # @api private
945
+ # @deprecated
946
+ def waiter_names
947
+ []
948
+ end
949
+
950
+ class << self
951
+
952
+ # @api private
953
+ attr_reader :identifier
954
+
955
+ # @api private
956
+ def errors_module
957
+ Errors
958
+ end
959
+
960
+ end
961
+ end
962
+ end