aws-sdk-finspace 1.1.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: 8eabe014007e9054ddb644692c507a7c630d757086e56ccbd0fcca2baa73ef63
4
+ data.tar.gz: b294f1308fec41b2030e9aeb34b943db2858c97c8b9e249ac2ad865461be7990
5
+ SHA512:
6
+ metadata.gz: 76a94aced14c8bc46c8c04565f3e4dabad69a98e43db12a7c2709651ff5f0895a0bb7c516d40de68eec8e59452adc2d7e683c815171980db967c5881c0196221
7
+ data.tar.gz: e3b531ecef658c3a7184f1a353ff04b6d343dc65a7ab6b180736bb54b12fa09aaa3b69a70d78ae86984645fbbde1baa73c828eaf9e248c640c07d940e8abd8bc
data/CHANGELOG.md ADDED
@@ -0,0 +1,13 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.1.0 (2021-05-03)
5
+ ------------------
6
+
7
+ * Feature - This is the initial SDK release for the management APIs for Amazon FinSpace. Amazon FinSpace is a data management and analytics service for the financial services industry (FSI).
8
+
9
+ 1.0.0 (2021-05-03)
10
+ ------------------
11
+
12
+ * Feature - Initial release of `aws-sdk-finspace`.
13
+
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.1.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-finspace/types'
15
+ require_relative 'aws-sdk-finspace/client_api'
16
+ require_relative 'aws-sdk-finspace/client'
17
+ require_relative 'aws-sdk-finspace/errors'
18
+ require_relative 'aws-sdk-finspace/resource'
19
+ require_relative 'aws-sdk-finspace/customizations'
20
+
21
+ # This module provides support for FinSpace User Environment Management service. This module is available in the
22
+ # `aws-sdk-finspace` 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
+ # finspace = Aws::Finspace::Client.new
31
+ # resp = finspace.create_environment(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from FinSpace User Environment Management service are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::Finspace::Errors::ServiceError
43
+ # # rescues all FinSpace User Environment Management service API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::Finspace
50
+
51
+ GEM_VERSION = '1.1.0'
52
+
53
+ end
@@ -0,0 +1,716 @@
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(:finspace)
34
+
35
+ module Aws::Finspace
36
+ # An API client for Finspace. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::Finspace::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 = :finspace
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
+ # Create a new FinSpace environment.
331
+ #
332
+ # @option params [required, String] :name
333
+ # The name of the FinSpace environment to be created.
334
+ #
335
+ # @option params [String] :description
336
+ # The description of the FinSpace environment to be created.
337
+ #
338
+ # @option params [String] :kms_key_id
339
+ # The KMS key id to encrypt your data in the FinSpace environment.
340
+ #
341
+ # @option params [Hash<String,String>] :tags
342
+ # Add tags to your FinSpace environment.
343
+ #
344
+ # @option params [String] :federation_mode
345
+ # Authentication mode for the environment.
346
+ #
347
+ # * `FEDERATED` - Users access FinSpace through Single Sign On (SSO) via
348
+ # your Identity provider.
349
+ #
350
+ # * `LOCAL` - Users access FinSpace via email and password managed
351
+ # within the FinSpace environment.
352
+ #
353
+ # @option params [Types::FederationParameters] :federation_parameters
354
+ # Configuration information when authentication mode is FEDERATED.
355
+ #
356
+ # @return [Types::CreateEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
357
+ #
358
+ # * {Types::CreateEnvironmentResponse#environment_id #environment_id} => String
359
+ # * {Types::CreateEnvironmentResponse#environment_arn #environment_arn} => String
360
+ # * {Types::CreateEnvironmentResponse#environment_url #environment_url} => String
361
+ #
362
+ # @example Request syntax with placeholder values
363
+ #
364
+ # resp = client.create_environment({
365
+ # name: "EnvironmentName", # required
366
+ # description: "Description",
367
+ # kms_key_id: "KmsKeyId",
368
+ # tags: {
369
+ # "TagKey" => "TagValue",
370
+ # },
371
+ # federation_mode: "FEDERATED", # accepts FEDERATED, LOCAL
372
+ # federation_parameters: {
373
+ # saml_metadata_document: "SamlMetadataDocument",
374
+ # saml_metadata_url: "url",
375
+ # application_call_back_url: "url",
376
+ # federation_urn: "urn",
377
+ # federation_provider_name: "FederationProviderName",
378
+ # attribute_map: {
379
+ # "FederationAttributeKey" => "url",
380
+ # },
381
+ # },
382
+ # })
383
+ #
384
+ # @example Response structure
385
+ #
386
+ # resp.environment_id #=> String
387
+ # resp.environment_arn #=> String
388
+ # resp.environment_url #=> String
389
+ #
390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateEnvironment AWS API Documentation
391
+ #
392
+ # @overload create_environment(params = {})
393
+ # @param [Hash] params ({})
394
+ def create_environment(params = {}, options = {})
395
+ req = build_request(:create_environment, params)
396
+ req.send_request(options)
397
+ end
398
+
399
+ # Delete an FinSpace environment.
400
+ #
401
+ # @option params [required, String] :environment_id
402
+ # The identifier for the FinSpace environment.
403
+ #
404
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
405
+ #
406
+ # @example Request syntax with placeholder values
407
+ #
408
+ # resp = client.delete_environment({
409
+ # environment_id: "IdType", # required
410
+ # })
411
+ #
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironment AWS API Documentation
413
+ #
414
+ # @overload delete_environment(params = {})
415
+ # @param [Hash] params ({})
416
+ def delete_environment(params = {}, options = {})
417
+ req = build_request(:delete_environment, params)
418
+ req.send_request(options)
419
+ end
420
+
421
+ # Returns the FinSpace environment object.
422
+ #
423
+ # @option params [required, String] :environment_id
424
+ # The identifier of the FinSpace environment.
425
+ #
426
+ # @return [Types::GetEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
427
+ #
428
+ # * {Types::GetEnvironmentResponse#environment #environment} => Types::Environment
429
+ #
430
+ # @example Request syntax with placeholder values
431
+ #
432
+ # resp = client.get_environment({
433
+ # environment_id: "IdType", # required
434
+ # })
435
+ #
436
+ # @example Response structure
437
+ #
438
+ # resp.environment.name #=> String
439
+ # resp.environment.environment_id #=> String
440
+ # resp.environment.aws_account_id #=> String
441
+ # resp.environment.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "SUSPENDED"
442
+ # resp.environment.environment_url #=> String
443
+ # resp.environment.description #=> String
444
+ # resp.environment.environment_arn #=> String
445
+ # resp.environment.sage_maker_studio_domain_url #=> String
446
+ # resp.environment.kms_key_id #=> String
447
+ # resp.environment.dedicated_service_account_id #=> String
448
+ # resp.environment.federation_mode #=> String, one of "FEDERATED", "LOCAL"
449
+ # resp.environment.federation_parameters.saml_metadata_document #=> String
450
+ # resp.environment.federation_parameters.saml_metadata_url #=> String
451
+ # resp.environment.federation_parameters.application_call_back_url #=> String
452
+ # resp.environment.federation_parameters.federation_urn #=> String
453
+ # resp.environment.federation_parameters.federation_provider_name #=> String
454
+ # resp.environment.federation_parameters.attribute_map #=> Hash
455
+ # resp.environment.federation_parameters.attribute_map["FederationAttributeKey"] #=> String
456
+ #
457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironment AWS API Documentation
458
+ #
459
+ # @overload get_environment(params = {})
460
+ # @param [Hash] params ({})
461
+ def get_environment(params = {}, options = {})
462
+ req = build_request(:get_environment, params)
463
+ req.send_request(options)
464
+ end
465
+
466
+ # A list of all of your FinSpace environments.
467
+ #
468
+ # @option params [String] :next_token
469
+ # A token generated by FinSpace that specifies where to continue
470
+ # pagination if a previous request was truncated. To get the next set of
471
+ # pages, pass in the nextToken value from the response object of the
472
+ # previous page call.
473
+ #
474
+ # @option params [Integer] :max_results
475
+ # The maximum number of results to return in this request.
476
+ #
477
+ # @return [Types::ListEnvironmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
478
+ #
479
+ # * {Types::ListEnvironmentsResponse#environments #environments} => Array&lt;Types::Environment&gt;
480
+ # * {Types::ListEnvironmentsResponse#next_token #next_token} => String
481
+ #
482
+ # @example Request syntax with placeholder values
483
+ #
484
+ # resp = client.list_environments({
485
+ # next_token: "PaginationToken",
486
+ # max_results: 1,
487
+ # })
488
+ #
489
+ # @example Response structure
490
+ #
491
+ # resp.environments #=> Array
492
+ # resp.environments[0].name #=> String
493
+ # resp.environments[0].environment_id #=> String
494
+ # resp.environments[0].aws_account_id #=> String
495
+ # resp.environments[0].status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "SUSPENDED"
496
+ # resp.environments[0].environment_url #=> String
497
+ # resp.environments[0].description #=> String
498
+ # resp.environments[0].environment_arn #=> String
499
+ # resp.environments[0].sage_maker_studio_domain_url #=> String
500
+ # resp.environments[0].kms_key_id #=> String
501
+ # resp.environments[0].dedicated_service_account_id #=> String
502
+ # resp.environments[0].federation_mode #=> String, one of "FEDERATED", "LOCAL"
503
+ # resp.environments[0].federation_parameters.saml_metadata_document #=> String
504
+ # resp.environments[0].federation_parameters.saml_metadata_url #=> String
505
+ # resp.environments[0].federation_parameters.application_call_back_url #=> String
506
+ # resp.environments[0].federation_parameters.federation_urn #=> String
507
+ # resp.environments[0].federation_parameters.federation_provider_name #=> String
508
+ # resp.environments[0].federation_parameters.attribute_map #=> Hash
509
+ # resp.environments[0].federation_parameters.attribute_map["FederationAttributeKey"] #=> String
510
+ # resp.next_token #=> String
511
+ #
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments AWS API Documentation
513
+ #
514
+ # @overload list_environments(params = {})
515
+ # @param [Hash] params ({})
516
+ def list_environments(params = {}, options = {})
517
+ req = build_request(:list_environments, params)
518
+ req.send_request(options)
519
+ end
520
+
521
+ # A list of all tags for a resource.
522
+ #
523
+ # @option params [required, String] :resource_arn
524
+ # The Amazon Resource Name of the resource.
525
+ #
526
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
527
+ #
528
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
529
+ #
530
+ # @example Request syntax with placeholder values
531
+ #
532
+ # resp = client.list_tags_for_resource({
533
+ # resource_arn: "EnvironmentArn", # required
534
+ # })
535
+ #
536
+ # @example Response structure
537
+ #
538
+ # resp.tags #=> Hash
539
+ # resp.tags["TagKey"] #=> String
540
+ #
541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListTagsForResource AWS API Documentation
542
+ #
543
+ # @overload list_tags_for_resource(params = {})
544
+ # @param [Hash] params ({})
545
+ def list_tags_for_resource(params = {}, options = {})
546
+ req = build_request(:list_tags_for_resource, params)
547
+ req.send_request(options)
548
+ end
549
+
550
+ # Adds metadata tags to a FinSpace resource.
551
+ #
552
+ # @option params [required, String] :resource_arn
553
+ # The Amazon Resource Name (ARN) for the resource.
554
+ #
555
+ # @option params [required, Hash<String,String>] :tags
556
+ # One or more tags to be assigned to the resource.
557
+ #
558
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
559
+ #
560
+ # @example Request syntax with placeholder values
561
+ #
562
+ # resp = client.tag_resource({
563
+ # resource_arn: "EnvironmentArn", # required
564
+ # tags: { # required
565
+ # "TagKey" => "TagValue",
566
+ # },
567
+ # })
568
+ #
569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TagResource AWS API Documentation
570
+ #
571
+ # @overload tag_resource(params = {})
572
+ # @param [Hash] params ({})
573
+ def tag_resource(params = {}, options = {})
574
+ req = build_request(:tag_resource, params)
575
+ req.send_request(options)
576
+ end
577
+
578
+ # Removes metadata tags from a FinSpace resource.
579
+ #
580
+ # @option params [required, String] :resource_arn
581
+ # A FinSpace resource from which you want to remove a tag or tags. The
582
+ # value for this parameter is an Amazon Resource Name (ARN).
583
+ #
584
+ # @option params [required, Array<String>] :tag_keys
585
+ # The tag keys (names) of one or more tags to be removed.
586
+ #
587
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
588
+ #
589
+ # @example Request syntax with placeholder values
590
+ #
591
+ # resp = client.untag_resource({
592
+ # resource_arn: "EnvironmentArn", # required
593
+ # tag_keys: ["TagKey"], # required
594
+ # })
595
+ #
596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UntagResource AWS API Documentation
597
+ #
598
+ # @overload untag_resource(params = {})
599
+ # @param [Hash] params ({})
600
+ def untag_resource(params = {}, options = {})
601
+ req = build_request(:untag_resource, params)
602
+ req.send_request(options)
603
+ end
604
+
605
+ # Update your FinSpace environment.
606
+ #
607
+ # @option params [required, String] :environment_id
608
+ # The identifier of the FinSpace environment.
609
+ #
610
+ # @option params [String] :name
611
+ # The name of the environment.
612
+ #
613
+ # @option params [String] :description
614
+ # The description of the environment.
615
+ #
616
+ # @option params [String] :federation_mode
617
+ # Authentication mode for the environment.
618
+ #
619
+ # * `FEDERATED` - Users access FinSpace through Single Sign On (SSO) via
620
+ # your Identity provider.
621
+ #
622
+ # * `LOCAL` - Users access FinSpace via email and password managed
623
+ # within the FinSpace environment.
624
+ #
625
+ # @option params [Types::FederationParameters] :federation_parameters
626
+ # Configuration information when authentication mode is FEDERATED.
627
+ #
628
+ # @return [Types::UpdateEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
629
+ #
630
+ # * {Types::UpdateEnvironmentResponse#environment #environment} => Types::Environment
631
+ #
632
+ # @example Request syntax with placeholder values
633
+ #
634
+ # resp = client.update_environment({
635
+ # environment_id: "IdType", # required
636
+ # name: "EnvironmentName",
637
+ # description: "Description",
638
+ # federation_mode: "FEDERATED", # accepts FEDERATED, LOCAL
639
+ # federation_parameters: {
640
+ # saml_metadata_document: "SamlMetadataDocument",
641
+ # saml_metadata_url: "url",
642
+ # application_call_back_url: "url",
643
+ # federation_urn: "urn",
644
+ # federation_provider_name: "FederationProviderName",
645
+ # attribute_map: {
646
+ # "FederationAttributeKey" => "url",
647
+ # },
648
+ # },
649
+ # })
650
+ #
651
+ # @example Response structure
652
+ #
653
+ # resp.environment.name #=> String
654
+ # resp.environment.environment_id #=> String
655
+ # resp.environment.aws_account_id #=> String
656
+ # resp.environment.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "SUSPENDED"
657
+ # resp.environment.environment_url #=> String
658
+ # resp.environment.description #=> String
659
+ # resp.environment.environment_arn #=> String
660
+ # resp.environment.sage_maker_studio_domain_url #=> String
661
+ # resp.environment.kms_key_id #=> String
662
+ # resp.environment.dedicated_service_account_id #=> String
663
+ # resp.environment.federation_mode #=> String, one of "FEDERATED", "LOCAL"
664
+ # resp.environment.federation_parameters.saml_metadata_document #=> String
665
+ # resp.environment.federation_parameters.saml_metadata_url #=> String
666
+ # resp.environment.federation_parameters.application_call_back_url #=> String
667
+ # resp.environment.federation_parameters.federation_urn #=> String
668
+ # resp.environment.federation_parameters.federation_provider_name #=> String
669
+ # resp.environment.federation_parameters.attribute_map #=> Hash
670
+ # resp.environment.federation_parameters.attribute_map["FederationAttributeKey"] #=> String
671
+ #
672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateEnvironment AWS API Documentation
673
+ #
674
+ # @overload update_environment(params = {})
675
+ # @param [Hash] params ({})
676
+ def update_environment(params = {}, options = {})
677
+ req = build_request(:update_environment, params)
678
+ req.send_request(options)
679
+ end
680
+
681
+ # @!endgroup
682
+
683
+ # @param params ({})
684
+ # @api private
685
+ def build_request(operation_name, params = {})
686
+ handlers = @handlers.for(operation_name)
687
+ context = Seahorse::Client::RequestContext.new(
688
+ operation_name: operation_name,
689
+ operation: config.api.operation(operation_name),
690
+ client: self,
691
+ params: params,
692
+ config: config)
693
+ context[:gem_name] = 'aws-sdk-finspace'
694
+ context[:gem_version] = '1.1.0'
695
+ Seahorse::Client::Request.new(handlers, context)
696
+ end
697
+
698
+ # @api private
699
+ # @deprecated
700
+ def waiter_names
701
+ []
702
+ end
703
+
704
+ class << self
705
+
706
+ # @api private
707
+ attr_reader :identifier
708
+
709
+ # @api private
710
+ def errors_module
711
+ Errors
712
+ end
713
+
714
+ end
715
+ end
716
+ end