aws-sdk-lookoutequipment 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: bccc7b2558c53772b649b66d5d3af068104c66b85636d2356f6e1b02137f2e84
4
+ data.tar.gz: d51cae04883d4af43962df65cf6347f85054559e99f6020f69fc2d0fe12a6fb4
5
+ SHA512:
6
+ metadata.gz: 22c5121116742e15ac391f0f1dbd0b4a7e992323b86a55d4f009401d568adfa4f848d48209e539bda7fbed8f5392557823f374cc7bae88dffc33309d2ea4cdad
7
+ data.tar.gz: 5b553528703214c5a9b33ae14ef0d8c5059326c164767379278421b6fce94af0e925e40af90c2df724a75915c91549d4b8a32ad26d5808c614bb850638b81612
data/CHANGELOG.md ADDED
@@ -0,0 +1,8 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.0.0 (2021-04-08)
5
+ ------------------
6
+
7
+ * Feature - Initial release of `aws-sdk-lookoutequipment`.
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-lookoutequipment/types'
15
+ require_relative 'aws-sdk-lookoutequipment/client_api'
16
+ require_relative 'aws-sdk-lookoutequipment/client'
17
+ require_relative 'aws-sdk-lookoutequipment/errors'
18
+ require_relative 'aws-sdk-lookoutequipment/resource'
19
+ require_relative 'aws-sdk-lookoutequipment/customizations'
20
+
21
+ # This module provides support for Amazon Lookout for Equipment. This module is available in the
22
+ # `aws-sdk-lookoutequipment` 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
+ # lookout_equipment = Aws::LookoutEquipment::Client.new
31
+ # resp = lookout_equipment.create_dataset(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon Lookout for Equipment are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::LookoutEquipment::Errors::ServiceError
43
+ # # rescues all Amazon Lookout for Equipment API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::LookoutEquipment
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,1554 @@
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/json_rpc.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:lookoutequipment)
34
+
35
+ module Aws::LookoutEquipment
36
+ # An API client for LookoutEquipment. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::LookoutEquipment::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 = :lookoutequipment
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::JsonRpc)
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] :simple_json (false)
270
+ # Disables request parameter conversion, validation, and formatting.
271
+ # Also disable response data type conversions. This option is useful
272
+ # when you want to ensure the highest level of performance by
273
+ # avoiding overhead of walking request parameters and response data
274
+ # structures.
275
+ #
276
+ # When `:simple_json` is enabled, the request parameters hash must
277
+ # be formatted exactly as the DynamoDB API expects.
278
+ #
279
+ # @option options [Boolean] :stub_responses (false)
280
+ # Causes the client to return stubbed responses. By default
281
+ # fake responses are generated and returned. You can specify
282
+ # the response data to return or errors to raise by calling
283
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
284
+ #
285
+ # ** Please note ** When response stubbing is enabled, no HTTP
286
+ # requests are made, and retries are disabled.
287
+ #
288
+ # @option options [Boolean] :validate_params (true)
289
+ # When `true`, request parameters are validated before
290
+ # sending the request.
291
+ #
292
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
293
+ # requests through. Formatted like 'http://proxy.com:123'.
294
+ #
295
+ # @option options [Float] :http_open_timeout (15) The number of
296
+ # seconds to wait when opening a HTTP session before raising a
297
+ # `Timeout::Error`.
298
+ #
299
+ # @option options [Integer] :http_read_timeout (60) The default
300
+ # number of seconds to wait for response data. This value can
301
+ # safely be set per-request on the session.
302
+ #
303
+ # @option options [Float] :http_idle_timeout (5) The number of
304
+ # seconds a connection is allowed to sit idle before it is
305
+ # considered stale. Stale connections are closed and removed
306
+ # from the pool before making a request.
307
+ #
308
+ # @option options [Float] :http_continue_timeout (1) The number of
309
+ # seconds to wait for a 100-continue response before sending the
310
+ # request body. This option has no effect unless the request has
311
+ # "Expect" header set to "100-continue". Defaults to `nil` which
312
+ # disables this behaviour. This value can safely be set per
313
+ # request on the session.
314
+ #
315
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
316
+ # HTTP debug output will be sent to the `:logger`.
317
+ #
318
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
319
+ # SSL peer certificates are verified when establishing a
320
+ # connection.
321
+ #
322
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
323
+ # certificate authority bundle file that should be used when
324
+ # verifying peer certificates. If you do not pass
325
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
326
+ # will be used if available.
327
+ #
328
+ # @option options [String] :ssl_ca_directory Full path of the
329
+ # directory that contains the unbundled SSL certificate
330
+ # authority files for verifying peer certificates. If you do
331
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
332
+ # system default will be used if available.
333
+ #
334
+ def initialize(*args)
335
+ super
336
+ end
337
+
338
+ # @!group API Operations
339
+
340
+ # Creates a container for a collection of data being ingested for
341
+ # analysis. The dataset contains the metadata describing where the data
342
+ # is and what the data actually looks like. In other words, it contains
343
+ # the location of the data source, the data schema, and other
344
+ # information. A dataset also contains any tags associated with the
345
+ # ingested data.
346
+ #
347
+ # @option params [required, String] :dataset_name
348
+ # The name of the dataset being created.
349
+ #
350
+ # @option params [required, Types::DatasetSchema] :dataset_schema
351
+ # A JSON description of the data that is in each time series dataset,
352
+ # including names, column names, and data types.
353
+ #
354
+ # @option params [String] :server_side_kms_key_id
355
+ # Provides the identifier of the AWS KMS customer master key (CMK) used
356
+ # to encrypt dataset data by Amazon Lookout for Equipment.
357
+ #
358
+ # @option params [required, String] :client_token
359
+ # A unique identifier for the request. If you do not set the client
360
+ # request token, Amazon Lookout for Equipment generates one.
361
+ #
362
+ # **A suitable default value is auto-generated.** You should normally
363
+ # not need to pass this option.**
364
+ #
365
+ # @option params [Array<Types::Tag>] :tags
366
+ # Any tags associated with the ingested data described in the dataset.
367
+ #
368
+ # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
369
+ #
370
+ # * {Types::CreateDatasetResponse#dataset_name #dataset_name} => String
371
+ # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
372
+ # * {Types::CreateDatasetResponse#status #status} => String
373
+ #
374
+ # @example Request syntax with placeholder values
375
+ #
376
+ # resp = client.create_dataset({
377
+ # dataset_name: "DatasetName", # required
378
+ # dataset_schema: { # required
379
+ # inline_data_schema: "InlineDataSchema",
380
+ # },
381
+ # server_side_kms_key_id: "NameOrArn",
382
+ # client_token: "IdempotenceToken", # required
383
+ # tags: [
384
+ # {
385
+ # key: "TagKey", # required
386
+ # value: "TagValue", # required
387
+ # },
388
+ # ],
389
+ # })
390
+ #
391
+ # @example Response structure
392
+ #
393
+ # resp.dataset_name #=> String
394
+ # resp.dataset_arn #=> String
395
+ # resp.status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE"
396
+ #
397
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateDataset AWS API Documentation
398
+ #
399
+ # @overload create_dataset(params = {})
400
+ # @param [Hash] params ({})
401
+ def create_dataset(params = {}, options = {})
402
+ req = build_request(:create_dataset, params)
403
+ req.send_request(options)
404
+ end
405
+
406
+ # Creates a scheduled inference. Scheduling an inference is setting up a
407
+ # continuous real-time inference plan to analyze new measurement data.
408
+ # When setting up the schedule, you provide an S3 bucket location for
409
+ # the input data, assign it a delimiter between separate entries in the
410
+ # data, set an offset delay if desired, and set the frequency of
411
+ # inferencing. You must also provide an S3 bucket location for the
412
+ # output data.
413
+ #
414
+ # @option params [required, String] :model_name
415
+ # The name of the previously trained ML model being used to create the
416
+ # inference scheduler.
417
+ #
418
+ # @option params [required, String] :inference_scheduler_name
419
+ # The name of the inference scheduler being created.
420
+ #
421
+ # @option params [Integer] :data_delay_offset_in_minutes
422
+ # A period of time (in minutes) by which inference on the data is
423
+ # delayed after the data starts. For instance, if you select an offset
424
+ # delay time of five minutes, inference will not begin on the data until
425
+ # the first data measurement after the five minute mark. For example, if
426
+ # five minutes is selected, the inference scheduler will wake up at the
427
+ # configured frequency with the additional five minute delay time to
428
+ # check the customer S3 bucket. The customer can upload data at the same
429
+ # frequency and they don't need to stop and restart the scheduler when
430
+ # uploading new data.
431
+ #
432
+ # @option params [required, String] :data_upload_frequency
433
+ # How often data is uploaded to the source S3 bucket for the input data.
434
+ # The value chosen is the length of time between data uploads. For
435
+ # instance, if you select 5 minutes, Amazon Lookout for Equipment will
436
+ # upload the real-time data to the source bucket once every 5 minutes.
437
+ # This frequency also determines how often Amazon Lookout for Equipment
438
+ # starts a scheduled inference on your data. In this example, it starts
439
+ # once every 5 minutes.
440
+ #
441
+ # @option params [required, Types::InferenceInputConfiguration] :data_input_configuration
442
+ # Specifies configuration information for the input data for the
443
+ # inference scheduler, including delimiter, format, and dataset
444
+ # location.
445
+ #
446
+ # @option params [required, Types::InferenceOutputConfiguration] :data_output_configuration
447
+ # Specifies configuration information for the output results for the
448
+ # inference scheduler, including the S3 location for the output.
449
+ #
450
+ # @option params [required, String] :role_arn
451
+ # The Amazon Resource Name (ARN) of a role with permission to access the
452
+ # data source being used for the inference.
453
+ #
454
+ # @option params [String] :server_side_kms_key_id
455
+ # Provides the identifier of the AWS KMS customer master key (CMK) used
456
+ # to encrypt inference scheduler data by Amazon Lookout for Equipment.
457
+ #
458
+ # @option params [required, String] :client_token
459
+ # A unique identifier for the request. If you do not set the client
460
+ # request token, Amazon Lookout for Equipment generates one.
461
+ #
462
+ # **A suitable default value is auto-generated.** You should normally
463
+ # not need to pass this option.**
464
+ #
465
+ # @option params [Array<Types::Tag>] :tags
466
+ # Any tags associated with the inference scheduler.
467
+ #
468
+ # @return [Types::CreateInferenceSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
469
+ #
470
+ # * {Types::CreateInferenceSchedulerResponse#inference_scheduler_arn #inference_scheduler_arn} => String
471
+ # * {Types::CreateInferenceSchedulerResponse#inference_scheduler_name #inference_scheduler_name} => String
472
+ # * {Types::CreateInferenceSchedulerResponse#status #status} => String
473
+ #
474
+ # @example Request syntax with placeholder values
475
+ #
476
+ # resp = client.create_inference_scheduler({
477
+ # model_name: "ModelName", # required
478
+ # inference_scheduler_name: "InferenceSchedulerName", # required
479
+ # data_delay_offset_in_minutes: 1,
480
+ # data_upload_frequency: "PT5M", # required, accepts PT5M, PT10M, PT15M, PT30M, PT1H
481
+ # data_input_configuration: { # required
482
+ # s3_input_configuration: {
483
+ # bucket: "S3Bucket", # required
484
+ # prefix: "S3Prefix",
485
+ # },
486
+ # input_time_zone_offset: "TimeZoneOffset",
487
+ # inference_input_name_configuration: {
488
+ # timestamp_format: "FileNameTimestampFormat",
489
+ # component_timestamp_delimiter: "ComponentTimestampDelimiter",
490
+ # },
491
+ # },
492
+ # data_output_configuration: { # required
493
+ # s3_output_configuration: { # required
494
+ # bucket: "S3Bucket", # required
495
+ # prefix: "S3Prefix",
496
+ # },
497
+ # kms_key_id: "NameOrArn",
498
+ # },
499
+ # role_arn: "IamRoleArn", # required
500
+ # server_side_kms_key_id: "NameOrArn",
501
+ # client_token: "IdempotenceToken", # required
502
+ # tags: [
503
+ # {
504
+ # key: "TagKey", # required
505
+ # value: "TagValue", # required
506
+ # },
507
+ # ],
508
+ # })
509
+ #
510
+ # @example Response structure
511
+ #
512
+ # resp.inference_scheduler_arn #=> String
513
+ # resp.inference_scheduler_name #=> String
514
+ # resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
515
+ #
516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateInferenceScheduler AWS API Documentation
517
+ #
518
+ # @overload create_inference_scheduler(params = {})
519
+ # @param [Hash] params ({})
520
+ def create_inference_scheduler(params = {}, options = {})
521
+ req = build_request(:create_inference_scheduler, params)
522
+ req.send_request(options)
523
+ end
524
+
525
+ # Creates an ML model for data inference.
526
+ #
527
+ # A machine-learning (ML) model is a mathematical model that finds
528
+ # patterns in your data. In Amazon Lookout for Equipment, the model
529
+ # learns the patterns of normal behavior and detects abnormal behavior
530
+ # that could be potential equipment failure (or maintenance events). The
531
+ # models are made by analyzing normal data and abnormalities in machine
532
+ # behavior that have already occurred.
533
+ #
534
+ # Your model is trained using a portion of the data from your dataset
535
+ # and uses that data to learn patterns of normal behavior and abnormal
536
+ # patterns that lead to equipment failure. Another portion of the data
537
+ # is used to evaluate the model's accuracy.
538
+ #
539
+ # @option params [required, String] :model_name
540
+ # The name for the ML model to be created.
541
+ #
542
+ # @option params [required, String] :dataset_name
543
+ # The name of the dataset for the ML model being created.
544
+ #
545
+ # @option params [Types::DatasetSchema] :dataset_schema
546
+ # The data schema for the ML model being created.
547
+ #
548
+ # @option params [Types::LabelsInputConfiguration] :labels_input_configuration
549
+ # The input configuration for the labels being used for the ML model
550
+ # that's being created.
551
+ #
552
+ # @option params [required, String] :client_token
553
+ # A unique identifier for the request. If you do not set the client
554
+ # request token, Amazon Lookout for Equipment generates one.
555
+ #
556
+ # **A suitable default value is auto-generated.** You should normally
557
+ # not need to pass this option.**
558
+ #
559
+ # @option params [Time,DateTime,Date,Integer,String] :training_data_start_time
560
+ # Indicates the time reference in the dataset that should be used to
561
+ # begin the subset of training data for the ML model.
562
+ #
563
+ # @option params [Time,DateTime,Date,Integer,String] :training_data_end_time
564
+ # Indicates the time reference in the dataset that should be used to end
565
+ # the subset of training data for the ML model.
566
+ #
567
+ # @option params [Time,DateTime,Date,Integer,String] :evaluation_data_start_time
568
+ # Indicates the time reference in the dataset that should be used to
569
+ # begin the subset of evaluation data for the ML model.
570
+ #
571
+ # @option params [Time,DateTime,Date,Integer,String] :evaluation_data_end_time
572
+ # Indicates the time reference in the dataset that should be used to end
573
+ # the subset of evaluation data for the ML model.
574
+ #
575
+ # @option params [String] :role_arn
576
+ # The Amazon Resource Name (ARN) of a role with permission to access the
577
+ # data source being used to create the ML model.
578
+ #
579
+ # @option params [Types::DataPreProcessingConfiguration] :data_pre_processing_configuration
580
+ # The configuration is the `TargetSamplingRate`, which is the sampling
581
+ # rate of the data after post processing by Amazon Lookout for
582
+ # Equipment. For example, if you provide data that has been collected at
583
+ # a 1 second level and you want the system to resample the data at a 1
584
+ # minute rate before training, the `TargetSamplingRate` is 1 minute.
585
+ #
586
+ # When providing a value for the `TargetSamplingRate`, you must attach
587
+ # the prefix "PT" to the rate you want. The value for a 1 second rate
588
+ # is therefore *PT1S*, the value for a 15 minute rate is *PT15M*, and
589
+ # the value for a 1 hour rate is *PT1H*
590
+ #
591
+ # @option params [String] :server_side_kms_key_id
592
+ # Provides the identifier of the AWS KMS customer master key (CMK) used
593
+ # to encrypt model data by Amazon Lookout for Equipment.
594
+ #
595
+ # @option params [Array<Types::Tag>] :tags
596
+ # Any tags associated with the ML model being created.
597
+ #
598
+ # @return [Types::CreateModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
599
+ #
600
+ # * {Types::CreateModelResponse#model_arn #model_arn} => String
601
+ # * {Types::CreateModelResponse#status #status} => String
602
+ #
603
+ # @example Request syntax with placeholder values
604
+ #
605
+ # resp = client.create_model({
606
+ # model_name: "ModelName", # required
607
+ # dataset_name: "DatasetIdentifier", # required
608
+ # dataset_schema: {
609
+ # inline_data_schema: "InlineDataSchema",
610
+ # },
611
+ # labels_input_configuration: {
612
+ # s3_input_configuration: { # required
613
+ # bucket: "S3Bucket", # required
614
+ # prefix: "S3Prefix",
615
+ # },
616
+ # },
617
+ # client_token: "IdempotenceToken", # required
618
+ # training_data_start_time: Time.now,
619
+ # training_data_end_time: Time.now,
620
+ # evaluation_data_start_time: Time.now,
621
+ # evaluation_data_end_time: Time.now,
622
+ # role_arn: "IamRoleArn",
623
+ # data_pre_processing_configuration: {
624
+ # target_sampling_rate: "PT1S", # accepts PT1S, PT5S, PT10S, PT15S, PT30S, PT1M, PT5M, PT10M, PT15M, PT30M, PT1H
625
+ # },
626
+ # server_side_kms_key_id: "NameOrArn",
627
+ # tags: [
628
+ # {
629
+ # key: "TagKey", # required
630
+ # value: "TagValue", # required
631
+ # },
632
+ # ],
633
+ # })
634
+ #
635
+ # @example Response structure
636
+ #
637
+ # resp.model_arn #=> String
638
+ # resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
639
+ #
640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateModel AWS API Documentation
641
+ #
642
+ # @overload create_model(params = {})
643
+ # @param [Hash] params ({})
644
+ def create_model(params = {}, options = {})
645
+ req = build_request(:create_model, params)
646
+ req.send_request(options)
647
+ end
648
+
649
+ # Deletes a dataset and associated artifacts. The operation will check
650
+ # to see if any inference scheduler or data ingestion job is currently
651
+ # using the dataset, and if there isn't, the dataset, its metadata, and
652
+ # any associated data stored in S3 will be deleted. This does not affect
653
+ # any models that used this dataset for training and evaluation, but
654
+ # does prevent it from being used in the future.
655
+ #
656
+ # @option params [required, String] :dataset_name
657
+ # The name of the dataset to be deleted.
658
+ #
659
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
660
+ #
661
+ # @example Request syntax with placeholder values
662
+ #
663
+ # resp = client.delete_dataset({
664
+ # dataset_name: "DatasetIdentifier", # required
665
+ # })
666
+ #
667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteDataset AWS API Documentation
668
+ #
669
+ # @overload delete_dataset(params = {})
670
+ # @param [Hash] params ({})
671
+ def delete_dataset(params = {}, options = {})
672
+ req = build_request(:delete_dataset, params)
673
+ req.send_request(options)
674
+ end
675
+
676
+ # Deletes an inference scheduler that has been set up. Already processed
677
+ # output results are not affected.
678
+ #
679
+ # @option params [required, String] :inference_scheduler_name
680
+ # The name of the inference scheduler to be deleted.
681
+ #
682
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
683
+ #
684
+ # @example Request syntax with placeholder values
685
+ #
686
+ # resp = client.delete_inference_scheduler({
687
+ # inference_scheduler_name: "InferenceSchedulerIdentifier", # required
688
+ # })
689
+ #
690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteInferenceScheduler AWS API Documentation
691
+ #
692
+ # @overload delete_inference_scheduler(params = {})
693
+ # @param [Hash] params ({})
694
+ def delete_inference_scheduler(params = {}, options = {})
695
+ req = build_request(:delete_inference_scheduler, params)
696
+ req.send_request(options)
697
+ end
698
+
699
+ # Deletes an ML model currently available for Amazon Lookout for
700
+ # Equipment. This will prevent it from being used with an inference
701
+ # scheduler, even one that is already set up.
702
+ #
703
+ # @option params [required, String] :model_name
704
+ # The name of the ML model to be deleted.
705
+ #
706
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
707
+ #
708
+ # @example Request syntax with placeholder values
709
+ #
710
+ # resp = client.delete_model({
711
+ # model_name: "ModelName", # required
712
+ # })
713
+ #
714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteModel AWS API Documentation
715
+ #
716
+ # @overload delete_model(params = {})
717
+ # @param [Hash] params ({})
718
+ def delete_model(params = {}, options = {})
719
+ req = build_request(:delete_model, params)
720
+ req.send_request(options)
721
+ end
722
+
723
+ # Provides information on a specific data ingestion job such as creation
724
+ # time, dataset ARN, status, and so on.
725
+ #
726
+ # @option params [required, String] :job_id
727
+ # The job ID of the data ingestion job.
728
+ #
729
+ # @return [Types::DescribeDataIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
730
+ #
731
+ # * {Types::DescribeDataIngestionJobResponse#job_id #job_id} => String
732
+ # * {Types::DescribeDataIngestionJobResponse#dataset_arn #dataset_arn} => String
733
+ # * {Types::DescribeDataIngestionJobResponse#ingestion_input_configuration #ingestion_input_configuration} => Types::IngestionInputConfiguration
734
+ # * {Types::DescribeDataIngestionJobResponse#role_arn #role_arn} => String
735
+ # * {Types::DescribeDataIngestionJobResponse#created_at #created_at} => Time
736
+ # * {Types::DescribeDataIngestionJobResponse#status #status} => String
737
+ # * {Types::DescribeDataIngestionJobResponse#failed_reason #failed_reason} => String
738
+ #
739
+ # @example Request syntax with placeholder values
740
+ #
741
+ # resp = client.describe_data_ingestion_job({
742
+ # job_id: "IngestionJobId", # required
743
+ # })
744
+ #
745
+ # @example Response structure
746
+ #
747
+ # resp.job_id #=> String
748
+ # resp.dataset_arn #=> String
749
+ # resp.ingestion_input_configuration.s3_input_configuration.bucket #=> String
750
+ # resp.ingestion_input_configuration.s3_input_configuration.prefix #=> String
751
+ # resp.role_arn #=> String
752
+ # resp.created_at #=> Time
753
+ # resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
754
+ # resp.failed_reason #=> String
755
+ #
756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataIngestionJob AWS API Documentation
757
+ #
758
+ # @overload describe_data_ingestion_job(params = {})
759
+ # @param [Hash] params ({})
760
+ def describe_data_ingestion_job(params = {}, options = {})
761
+ req = build_request(:describe_data_ingestion_job, params)
762
+ req.send_request(options)
763
+ end
764
+
765
+ # Provides information on a specified dataset such as the schema
766
+ # location, status, and so on.
767
+ #
768
+ # @option params [required, String] :dataset_name
769
+ # The name of the dataset to be described.
770
+ #
771
+ # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
772
+ #
773
+ # * {Types::DescribeDatasetResponse#dataset_name #dataset_name} => String
774
+ # * {Types::DescribeDatasetResponse#dataset_arn #dataset_arn} => String
775
+ # * {Types::DescribeDatasetResponse#created_at #created_at} => Time
776
+ # * {Types::DescribeDatasetResponse#last_updated_at #last_updated_at} => Time
777
+ # * {Types::DescribeDatasetResponse#status #status} => String
778
+ # * {Types::DescribeDatasetResponse#schema #schema} => String
779
+ # * {Types::DescribeDatasetResponse#server_side_kms_key_id #server_side_kms_key_id} => String
780
+ # * {Types::DescribeDatasetResponse#ingestion_input_configuration #ingestion_input_configuration} => Types::IngestionInputConfiguration
781
+ #
782
+ # @example Request syntax with placeholder values
783
+ #
784
+ # resp = client.describe_dataset({
785
+ # dataset_name: "DatasetIdentifier", # required
786
+ # })
787
+ #
788
+ # @example Response structure
789
+ #
790
+ # resp.dataset_name #=> String
791
+ # resp.dataset_arn #=> String
792
+ # resp.created_at #=> Time
793
+ # resp.last_updated_at #=> Time
794
+ # resp.status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE"
795
+ # resp.schema #=> String
796
+ # resp.server_side_kms_key_id #=> String
797
+ # resp.ingestion_input_configuration.s3_input_configuration.bucket #=> String
798
+ # resp.ingestion_input_configuration.s3_input_configuration.prefix #=> String
799
+ #
800
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataset AWS API Documentation
801
+ #
802
+ # @overload describe_dataset(params = {})
803
+ # @param [Hash] params ({})
804
+ def describe_dataset(params = {}, options = {})
805
+ req = build_request(:describe_dataset, params)
806
+ req.send_request(options)
807
+ end
808
+
809
+ # Specifies information about the inference scheduler being used,
810
+ # including name, model, status, and associated metadata
811
+ #
812
+ # @option params [required, String] :inference_scheduler_name
813
+ # The name of the inference scheduler being described.
814
+ #
815
+ # @return [Types::DescribeInferenceSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
816
+ #
817
+ # * {Types::DescribeInferenceSchedulerResponse#model_arn #model_arn} => String
818
+ # * {Types::DescribeInferenceSchedulerResponse#model_name #model_name} => String
819
+ # * {Types::DescribeInferenceSchedulerResponse#inference_scheduler_name #inference_scheduler_name} => String
820
+ # * {Types::DescribeInferenceSchedulerResponse#inference_scheduler_arn #inference_scheduler_arn} => String
821
+ # * {Types::DescribeInferenceSchedulerResponse#status #status} => String
822
+ # * {Types::DescribeInferenceSchedulerResponse#data_delay_offset_in_minutes #data_delay_offset_in_minutes} => Integer
823
+ # * {Types::DescribeInferenceSchedulerResponse#data_upload_frequency #data_upload_frequency} => String
824
+ # * {Types::DescribeInferenceSchedulerResponse#created_at #created_at} => Time
825
+ # * {Types::DescribeInferenceSchedulerResponse#updated_at #updated_at} => Time
826
+ # * {Types::DescribeInferenceSchedulerResponse#data_input_configuration #data_input_configuration} => Types::InferenceInputConfiguration
827
+ # * {Types::DescribeInferenceSchedulerResponse#data_output_configuration #data_output_configuration} => Types::InferenceOutputConfiguration
828
+ # * {Types::DescribeInferenceSchedulerResponse#role_arn #role_arn} => String
829
+ # * {Types::DescribeInferenceSchedulerResponse#server_side_kms_key_id #server_side_kms_key_id} => String
830
+ #
831
+ # @example Request syntax with placeholder values
832
+ #
833
+ # resp = client.describe_inference_scheduler({
834
+ # inference_scheduler_name: "InferenceSchedulerIdentifier", # required
835
+ # })
836
+ #
837
+ # @example Response structure
838
+ #
839
+ # resp.model_arn #=> String
840
+ # resp.model_name #=> String
841
+ # resp.inference_scheduler_name #=> String
842
+ # resp.inference_scheduler_arn #=> String
843
+ # resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
844
+ # resp.data_delay_offset_in_minutes #=> Integer
845
+ # resp.data_upload_frequency #=> String, one of "PT5M", "PT10M", "PT15M", "PT30M", "PT1H"
846
+ # resp.created_at #=> Time
847
+ # resp.updated_at #=> Time
848
+ # resp.data_input_configuration.s3_input_configuration.bucket #=> String
849
+ # resp.data_input_configuration.s3_input_configuration.prefix #=> String
850
+ # resp.data_input_configuration.input_time_zone_offset #=> String
851
+ # resp.data_input_configuration.inference_input_name_configuration.timestamp_format #=> String
852
+ # resp.data_input_configuration.inference_input_name_configuration.component_timestamp_delimiter #=> String
853
+ # resp.data_output_configuration.s3_output_configuration.bucket #=> String
854
+ # resp.data_output_configuration.s3_output_configuration.prefix #=> String
855
+ # resp.data_output_configuration.kms_key_id #=> String
856
+ # resp.role_arn #=> String
857
+ # resp.server_side_kms_key_id #=> String
858
+ #
859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeInferenceScheduler AWS API Documentation
860
+ #
861
+ # @overload describe_inference_scheduler(params = {})
862
+ # @param [Hash] params ({})
863
+ def describe_inference_scheduler(params = {}, options = {})
864
+ req = build_request(:describe_inference_scheduler, params)
865
+ req.send_request(options)
866
+ end
867
+
868
+ # Provides overall information about a specific ML model, including
869
+ # model name and ARN, dataset, training and evaluation information,
870
+ # status, and so on.
871
+ #
872
+ # @option params [required, String] :model_name
873
+ # The name of the ML model to be described.
874
+ #
875
+ # @return [Types::DescribeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
876
+ #
877
+ # * {Types::DescribeModelResponse#model_name #model_name} => String
878
+ # * {Types::DescribeModelResponse#model_arn #model_arn} => String
879
+ # * {Types::DescribeModelResponse#dataset_name #dataset_name} => String
880
+ # * {Types::DescribeModelResponse#dataset_arn #dataset_arn} => String
881
+ # * {Types::DescribeModelResponse#schema #schema} => String
882
+ # * {Types::DescribeModelResponse#labels_input_configuration #labels_input_configuration} => Types::LabelsInputConfiguration
883
+ # * {Types::DescribeModelResponse#training_data_start_time #training_data_start_time} => Time
884
+ # * {Types::DescribeModelResponse#training_data_end_time #training_data_end_time} => Time
885
+ # * {Types::DescribeModelResponse#evaluation_data_start_time #evaluation_data_start_time} => Time
886
+ # * {Types::DescribeModelResponse#evaluation_data_end_time #evaluation_data_end_time} => Time
887
+ # * {Types::DescribeModelResponse#role_arn #role_arn} => String
888
+ # * {Types::DescribeModelResponse#data_pre_processing_configuration #data_pre_processing_configuration} => Types::DataPreProcessingConfiguration
889
+ # * {Types::DescribeModelResponse#status #status} => String
890
+ # * {Types::DescribeModelResponse#training_execution_start_time #training_execution_start_time} => Time
891
+ # * {Types::DescribeModelResponse#training_execution_end_time #training_execution_end_time} => Time
892
+ # * {Types::DescribeModelResponse#failed_reason #failed_reason} => String
893
+ # * {Types::DescribeModelResponse#model_metrics #model_metrics} => String
894
+ # * {Types::DescribeModelResponse#last_updated_time #last_updated_time} => Time
895
+ # * {Types::DescribeModelResponse#created_at #created_at} => Time
896
+ # * {Types::DescribeModelResponse#server_side_kms_key_id #server_side_kms_key_id} => String
897
+ #
898
+ # @example Request syntax with placeholder values
899
+ #
900
+ # resp = client.describe_model({
901
+ # model_name: "ModelName", # required
902
+ # })
903
+ #
904
+ # @example Response structure
905
+ #
906
+ # resp.model_name #=> String
907
+ # resp.model_arn #=> String
908
+ # resp.dataset_name #=> String
909
+ # resp.dataset_arn #=> String
910
+ # resp.schema #=> String
911
+ # resp.labels_input_configuration.s3_input_configuration.bucket #=> String
912
+ # resp.labels_input_configuration.s3_input_configuration.prefix #=> String
913
+ # resp.training_data_start_time #=> Time
914
+ # resp.training_data_end_time #=> Time
915
+ # resp.evaluation_data_start_time #=> Time
916
+ # resp.evaluation_data_end_time #=> Time
917
+ # resp.role_arn #=> String
918
+ # resp.data_pre_processing_configuration.target_sampling_rate #=> String, one of "PT1S", "PT5S", "PT10S", "PT15S", "PT30S", "PT1M", "PT5M", "PT10M", "PT15M", "PT30M", "PT1H"
919
+ # resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
920
+ # resp.training_execution_start_time #=> Time
921
+ # resp.training_execution_end_time #=> Time
922
+ # resp.failed_reason #=> String
923
+ # resp.model_metrics #=> String
924
+ # resp.last_updated_time #=> Time
925
+ # resp.created_at #=> Time
926
+ # resp.server_side_kms_key_id #=> String
927
+ #
928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModel AWS API Documentation
929
+ #
930
+ # @overload describe_model(params = {})
931
+ # @param [Hash] params ({})
932
+ def describe_model(params = {}, options = {})
933
+ req = build_request(:describe_model, params)
934
+ req.send_request(options)
935
+ end
936
+
937
+ # Provides a list of all data ingestion jobs, including dataset name and
938
+ # ARN, S3 location of the input data, status, and so on.
939
+ #
940
+ # @option params [String] :dataset_name
941
+ # The name of the dataset being used for the data ingestion job.
942
+ #
943
+ # @option params [String] :next_token
944
+ # An opaque pagination token indicating where to continue the listing of
945
+ # data ingestion jobs.
946
+ #
947
+ # @option params [Integer] :max_results
948
+ # Specifies the maximum number of data ingestion jobs to list.
949
+ #
950
+ # @option params [String] :status
951
+ # Indicates the status of the data ingestion job.
952
+ #
953
+ # @return [Types::ListDataIngestionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
954
+ #
955
+ # * {Types::ListDataIngestionJobsResponse#next_token #next_token} => String
956
+ # * {Types::ListDataIngestionJobsResponse#data_ingestion_job_summaries #data_ingestion_job_summaries} => Array&lt;Types::DataIngestionJobSummary&gt;
957
+ #
958
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
959
+ #
960
+ # @example Request syntax with placeholder values
961
+ #
962
+ # resp = client.list_data_ingestion_jobs({
963
+ # dataset_name: "DatasetName",
964
+ # next_token: "NextToken",
965
+ # max_results: 1,
966
+ # status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED
967
+ # })
968
+ #
969
+ # @example Response structure
970
+ #
971
+ # resp.next_token #=> String
972
+ # resp.data_ingestion_job_summaries #=> Array
973
+ # resp.data_ingestion_job_summaries[0].job_id #=> String
974
+ # resp.data_ingestion_job_summaries[0].dataset_name #=> String
975
+ # resp.data_ingestion_job_summaries[0].dataset_arn #=> String
976
+ # resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.bucket #=> String
977
+ # resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.prefix #=> String
978
+ # resp.data_ingestion_job_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
979
+ #
980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListDataIngestionJobs AWS API Documentation
981
+ #
982
+ # @overload list_data_ingestion_jobs(params = {})
983
+ # @param [Hash] params ({})
984
+ def list_data_ingestion_jobs(params = {}, options = {})
985
+ req = build_request(:list_data_ingestion_jobs, params)
986
+ req.send_request(options)
987
+ end
988
+
989
+ # Lists all datasets currently available in your account, filtering on
990
+ # the dataset name.
991
+ #
992
+ # @option params [String] :next_token
993
+ # An opaque pagination token indicating where to continue the listing of
994
+ # datasets.
995
+ #
996
+ # @option params [Integer] :max_results
997
+ # Specifies the maximum number of datasets to list.
998
+ #
999
+ # @option params [String] :dataset_name_begins_with
1000
+ # The beginning of the name of the datasets to be listed.
1001
+ #
1002
+ # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1003
+ #
1004
+ # * {Types::ListDatasetsResponse#next_token #next_token} => String
1005
+ # * {Types::ListDatasetsResponse#dataset_summaries #dataset_summaries} => Array&lt;Types::DatasetSummary&gt;
1006
+ #
1007
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1008
+ #
1009
+ # @example Request syntax with placeholder values
1010
+ #
1011
+ # resp = client.list_datasets({
1012
+ # next_token: "NextToken",
1013
+ # max_results: 1,
1014
+ # dataset_name_begins_with: "DatasetName",
1015
+ # })
1016
+ #
1017
+ # @example Response structure
1018
+ #
1019
+ # resp.next_token #=> String
1020
+ # resp.dataset_summaries #=> Array
1021
+ # resp.dataset_summaries[0].dataset_name #=> String
1022
+ # resp.dataset_summaries[0].dataset_arn #=> String
1023
+ # resp.dataset_summaries[0].status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE"
1024
+ # resp.dataset_summaries[0].created_at #=> Time
1025
+ #
1026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListDatasets AWS API Documentation
1027
+ #
1028
+ # @overload list_datasets(params = {})
1029
+ # @param [Hash] params ({})
1030
+ def list_datasets(params = {}, options = {})
1031
+ req = build_request(:list_datasets, params)
1032
+ req.send_request(options)
1033
+ end
1034
+
1035
+ # Lists all inference executions that have been performed by the
1036
+ # specified inference scheduler.
1037
+ #
1038
+ # @option params [String] :next_token
1039
+ # An opaque pagination token indicating where to continue the listing of
1040
+ # inference executions.
1041
+ #
1042
+ # @option params [Integer] :max_results
1043
+ # Specifies the maximum number of inference executions to list.
1044
+ #
1045
+ # @option params [required, String] :inference_scheduler_name
1046
+ # The name of the inference scheduler for the inference execution
1047
+ # listed.
1048
+ #
1049
+ # @option params [Time,DateTime,Date,Integer,String] :data_start_time_after
1050
+ # The time reference in the inferenced dataset after which Amazon
1051
+ # Lookout for Equipment started the inference execution.
1052
+ #
1053
+ # @option params [Time,DateTime,Date,Integer,String] :data_end_time_before
1054
+ # The time reference in the inferenced dataset before which Amazon
1055
+ # Lookout for Equipment stopped the inference execution.
1056
+ #
1057
+ # @option params [String] :status
1058
+ # The status of the inference execution.
1059
+ #
1060
+ # @return [Types::ListInferenceExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1061
+ #
1062
+ # * {Types::ListInferenceExecutionsResponse#next_token #next_token} => String
1063
+ # * {Types::ListInferenceExecutionsResponse#inference_execution_summaries #inference_execution_summaries} => Array&lt;Types::InferenceExecutionSummary&gt;
1064
+ #
1065
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1066
+ #
1067
+ # @example Request syntax with placeholder values
1068
+ #
1069
+ # resp = client.list_inference_executions({
1070
+ # next_token: "NextToken",
1071
+ # max_results: 1,
1072
+ # inference_scheduler_name: "InferenceSchedulerIdentifier", # required
1073
+ # data_start_time_after: Time.now,
1074
+ # data_end_time_before: Time.now,
1075
+ # status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED
1076
+ # })
1077
+ #
1078
+ # @example Response structure
1079
+ #
1080
+ # resp.next_token #=> String
1081
+ # resp.inference_execution_summaries #=> Array
1082
+ # resp.inference_execution_summaries[0].model_name #=> String
1083
+ # resp.inference_execution_summaries[0].model_arn #=> String
1084
+ # resp.inference_execution_summaries[0].inference_scheduler_name #=> String
1085
+ # resp.inference_execution_summaries[0].inference_scheduler_arn #=> String
1086
+ # resp.inference_execution_summaries[0].scheduled_start_time #=> Time
1087
+ # resp.inference_execution_summaries[0].data_start_time #=> Time
1088
+ # resp.inference_execution_summaries[0].data_end_time #=> Time
1089
+ # resp.inference_execution_summaries[0].data_input_configuration.s3_input_configuration.bucket #=> String
1090
+ # resp.inference_execution_summaries[0].data_input_configuration.s3_input_configuration.prefix #=> String
1091
+ # resp.inference_execution_summaries[0].data_input_configuration.input_time_zone_offset #=> String
1092
+ # resp.inference_execution_summaries[0].data_input_configuration.inference_input_name_configuration.timestamp_format #=> String
1093
+ # resp.inference_execution_summaries[0].data_input_configuration.inference_input_name_configuration.component_timestamp_delimiter #=> String
1094
+ # resp.inference_execution_summaries[0].data_output_configuration.s3_output_configuration.bucket #=> String
1095
+ # resp.inference_execution_summaries[0].data_output_configuration.s3_output_configuration.prefix #=> String
1096
+ # resp.inference_execution_summaries[0].data_output_configuration.kms_key_id #=> String
1097
+ # resp.inference_execution_summaries[0].customer_result_object.bucket #=> String
1098
+ # resp.inference_execution_summaries[0].customer_result_object.key #=> String
1099
+ # resp.inference_execution_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
1100
+ # resp.inference_execution_summaries[0].failed_reason #=> String
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceExecutions AWS API Documentation
1103
+ #
1104
+ # @overload list_inference_executions(params = {})
1105
+ # @param [Hash] params ({})
1106
+ def list_inference_executions(params = {}, options = {})
1107
+ req = build_request(:list_inference_executions, params)
1108
+ req.send_request(options)
1109
+ end
1110
+
1111
+ # Retrieves a list of all inference schedulers currently available for
1112
+ # your account.
1113
+ #
1114
+ # @option params [String] :next_token
1115
+ # An opaque pagination token indicating where to continue the listing of
1116
+ # inference schedulers.
1117
+ #
1118
+ # @option params [Integer] :max_results
1119
+ # Specifies the maximum number of inference schedulers to list.
1120
+ #
1121
+ # @option params [String] :inference_scheduler_name_begins_with
1122
+ # The beginning of the name of the inference schedulers to be listed.
1123
+ #
1124
+ # @option params [String] :model_name
1125
+ # The name of the ML model used by the inference scheduler to be listed.
1126
+ #
1127
+ # @return [Types::ListInferenceSchedulersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1128
+ #
1129
+ # * {Types::ListInferenceSchedulersResponse#next_token #next_token} => String
1130
+ # * {Types::ListInferenceSchedulersResponse#inference_scheduler_summaries #inference_scheduler_summaries} => Array&lt;Types::InferenceSchedulerSummary&gt;
1131
+ #
1132
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1133
+ #
1134
+ # @example Request syntax with placeholder values
1135
+ #
1136
+ # resp = client.list_inference_schedulers({
1137
+ # next_token: "NextToken",
1138
+ # max_results: 1,
1139
+ # inference_scheduler_name_begins_with: "InferenceSchedulerIdentifier",
1140
+ # model_name: "ModelName",
1141
+ # })
1142
+ #
1143
+ # @example Response structure
1144
+ #
1145
+ # resp.next_token #=> String
1146
+ # resp.inference_scheduler_summaries #=> Array
1147
+ # resp.inference_scheduler_summaries[0].model_name #=> String
1148
+ # resp.inference_scheduler_summaries[0].model_arn #=> String
1149
+ # resp.inference_scheduler_summaries[0].inference_scheduler_name #=> String
1150
+ # resp.inference_scheduler_summaries[0].inference_scheduler_arn #=> String
1151
+ # resp.inference_scheduler_summaries[0].status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
1152
+ # resp.inference_scheduler_summaries[0].data_delay_offset_in_minutes #=> Integer
1153
+ # resp.inference_scheduler_summaries[0].data_upload_frequency #=> String, one of "PT5M", "PT10M", "PT15M", "PT30M", "PT1H"
1154
+ #
1155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceSchedulers AWS API Documentation
1156
+ #
1157
+ # @overload list_inference_schedulers(params = {})
1158
+ # @param [Hash] params ({})
1159
+ def list_inference_schedulers(params = {}, options = {})
1160
+ req = build_request(:list_inference_schedulers, params)
1161
+ req.send_request(options)
1162
+ end
1163
+
1164
+ # Generates a list of all models in the account, including model name
1165
+ # and ARN, dataset, and status.
1166
+ #
1167
+ # @option params [String] :next_token
1168
+ # An opaque pagination token indicating where to continue the listing of
1169
+ # ML models.
1170
+ #
1171
+ # @option params [Integer] :max_results
1172
+ # Specifies the maximum number of ML models to list.
1173
+ #
1174
+ # @option params [String] :status
1175
+ # The status of the ML model.
1176
+ #
1177
+ # @option params [String] :model_name_begins_with
1178
+ # The beginning of the name of the ML models being listed.
1179
+ #
1180
+ # @option params [String] :dataset_name_begins_with
1181
+ # The beginning of the name of the dataset of the ML models to be
1182
+ # listed.
1183
+ #
1184
+ # @return [Types::ListModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1185
+ #
1186
+ # * {Types::ListModelsResponse#next_token #next_token} => String
1187
+ # * {Types::ListModelsResponse#model_summaries #model_summaries} => Array&lt;Types::ModelSummary&gt;
1188
+ #
1189
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1190
+ #
1191
+ # @example Request syntax with placeholder values
1192
+ #
1193
+ # resp = client.list_models({
1194
+ # next_token: "NextToken",
1195
+ # max_results: 1,
1196
+ # status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED
1197
+ # model_name_begins_with: "ModelName",
1198
+ # dataset_name_begins_with: "DatasetName",
1199
+ # })
1200
+ #
1201
+ # @example Response structure
1202
+ #
1203
+ # resp.next_token #=> String
1204
+ # resp.model_summaries #=> Array
1205
+ # resp.model_summaries[0].model_name #=> String
1206
+ # resp.model_summaries[0].model_arn #=> String
1207
+ # resp.model_summaries[0].dataset_name #=> String
1208
+ # resp.model_summaries[0].dataset_arn #=> String
1209
+ # resp.model_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
1210
+ # resp.model_summaries[0].created_at #=> Time
1211
+ #
1212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModels AWS API Documentation
1213
+ #
1214
+ # @overload list_models(params = {})
1215
+ # @param [Hash] params ({})
1216
+ def list_models(params = {}, options = {})
1217
+ req = build_request(:list_models, params)
1218
+ req.send_request(options)
1219
+ end
1220
+
1221
+ # Lists all the tags for a specified resource, including key and value.
1222
+ #
1223
+ # @option params [required, String] :resource_arn
1224
+ # The Amazon Resource Name (ARN) of the resource (such as the dataset or
1225
+ # model) that is the focus of the `ListTagsForResource` operation.
1226
+ #
1227
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1228
+ #
1229
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
1230
+ #
1231
+ # @example Request syntax with placeholder values
1232
+ #
1233
+ # resp = client.list_tags_for_resource({
1234
+ # resource_arn: "AmazonResourceArn", # required
1235
+ # })
1236
+ #
1237
+ # @example Response structure
1238
+ #
1239
+ # resp.tags #=> Array
1240
+ # resp.tags[0].key #=> String
1241
+ # resp.tags[0].value #=> String
1242
+ #
1243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListTagsForResource AWS API Documentation
1244
+ #
1245
+ # @overload list_tags_for_resource(params = {})
1246
+ # @param [Hash] params ({})
1247
+ def list_tags_for_resource(params = {}, options = {})
1248
+ req = build_request(:list_tags_for_resource, params)
1249
+ req.send_request(options)
1250
+ end
1251
+
1252
+ # Starts a data ingestion job. Amazon Lookout for Equipment returns the
1253
+ # job status.
1254
+ #
1255
+ # @option params [required, String] :dataset_name
1256
+ # The name of the dataset being used by the data ingestion job.
1257
+ #
1258
+ # @option params [required, Types::IngestionInputConfiguration] :ingestion_input_configuration
1259
+ # Specifies information for the input data for the data ingestion job,
1260
+ # including dataset S3 location.
1261
+ #
1262
+ # @option params [required, String] :role_arn
1263
+ # The Amazon Resource Name (ARN) of a role with permission to access the
1264
+ # data source for the data ingestion job.
1265
+ #
1266
+ # @option params [required, String] :client_token
1267
+ # A unique identifier for the request. If you do not set the client
1268
+ # request token, Amazon Lookout for Equipment generates one.
1269
+ #
1270
+ # **A suitable default value is auto-generated.** You should normally
1271
+ # not need to pass this option.**
1272
+ #
1273
+ # @return [Types::StartDataIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1274
+ #
1275
+ # * {Types::StartDataIngestionJobResponse#job_id #job_id} => String
1276
+ # * {Types::StartDataIngestionJobResponse#status #status} => String
1277
+ #
1278
+ # @example Request syntax with placeholder values
1279
+ #
1280
+ # resp = client.start_data_ingestion_job({
1281
+ # dataset_name: "DatasetIdentifier", # required
1282
+ # ingestion_input_configuration: { # required
1283
+ # s3_input_configuration: { # required
1284
+ # bucket: "S3Bucket", # required
1285
+ # prefix: "S3Prefix",
1286
+ # },
1287
+ # },
1288
+ # role_arn: "IamRoleArn", # required
1289
+ # client_token: "IdempotenceToken", # required
1290
+ # })
1291
+ #
1292
+ # @example Response structure
1293
+ #
1294
+ # resp.job_id #=> String
1295
+ # resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
1296
+ #
1297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartDataIngestionJob AWS API Documentation
1298
+ #
1299
+ # @overload start_data_ingestion_job(params = {})
1300
+ # @param [Hash] params ({})
1301
+ def start_data_ingestion_job(params = {}, options = {})
1302
+ req = build_request(:start_data_ingestion_job, params)
1303
+ req.send_request(options)
1304
+ end
1305
+
1306
+ # Starts an inference scheduler.
1307
+ #
1308
+ # @option params [required, String] :inference_scheduler_name
1309
+ # The name of the inference scheduler to be started.
1310
+ #
1311
+ # @return [Types::StartInferenceSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1312
+ #
1313
+ # * {Types::StartInferenceSchedulerResponse#model_arn #model_arn} => String
1314
+ # * {Types::StartInferenceSchedulerResponse#model_name #model_name} => String
1315
+ # * {Types::StartInferenceSchedulerResponse#inference_scheduler_name #inference_scheduler_name} => String
1316
+ # * {Types::StartInferenceSchedulerResponse#inference_scheduler_arn #inference_scheduler_arn} => String
1317
+ # * {Types::StartInferenceSchedulerResponse#status #status} => String
1318
+ #
1319
+ # @example Request syntax with placeholder values
1320
+ #
1321
+ # resp = client.start_inference_scheduler({
1322
+ # inference_scheduler_name: "InferenceSchedulerIdentifier", # required
1323
+ # })
1324
+ #
1325
+ # @example Response structure
1326
+ #
1327
+ # resp.model_arn #=> String
1328
+ # resp.model_name #=> String
1329
+ # resp.inference_scheduler_name #=> String
1330
+ # resp.inference_scheduler_arn #=> String
1331
+ # resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
1332
+ #
1333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartInferenceScheduler AWS API Documentation
1334
+ #
1335
+ # @overload start_inference_scheduler(params = {})
1336
+ # @param [Hash] params ({})
1337
+ def start_inference_scheduler(params = {}, options = {})
1338
+ req = build_request(:start_inference_scheduler, params)
1339
+ req.send_request(options)
1340
+ end
1341
+
1342
+ # Stops an inference scheduler.
1343
+ #
1344
+ # @option params [required, String] :inference_scheduler_name
1345
+ # The name of the inference scheduler to be stopped.
1346
+ #
1347
+ # @return [Types::StopInferenceSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1348
+ #
1349
+ # * {Types::StopInferenceSchedulerResponse#model_arn #model_arn} => String
1350
+ # * {Types::StopInferenceSchedulerResponse#model_name #model_name} => String
1351
+ # * {Types::StopInferenceSchedulerResponse#inference_scheduler_name #inference_scheduler_name} => String
1352
+ # * {Types::StopInferenceSchedulerResponse#inference_scheduler_arn #inference_scheduler_arn} => String
1353
+ # * {Types::StopInferenceSchedulerResponse#status #status} => String
1354
+ #
1355
+ # @example Request syntax with placeholder values
1356
+ #
1357
+ # resp = client.stop_inference_scheduler({
1358
+ # inference_scheduler_name: "InferenceSchedulerIdentifier", # required
1359
+ # })
1360
+ #
1361
+ # @example Response structure
1362
+ #
1363
+ # resp.model_arn #=> String
1364
+ # resp.model_name #=> String
1365
+ # resp.inference_scheduler_name #=> String
1366
+ # resp.inference_scheduler_arn #=> String
1367
+ # resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
1368
+ #
1369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StopInferenceScheduler AWS API Documentation
1370
+ #
1371
+ # @overload stop_inference_scheduler(params = {})
1372
+ # @param [Hash] params ({})
1373
+ def stop_inference_scheduler(params = {}, options = {})
1374
+ req = build_request(:stop_inference_scheduler, params)
1375
+ req.send_request(options)
1376
+ end
1377
+
1378
+ # Associates a given tag to a resource in your account. A tag is a
1379
+ # key-value pair which can be added to an Amazon Lookout for Equipment
1380
+ # resource as metadata. Tags can be used for organizing your resources
1381
+ # as well as helping you to search and filter by tag. Multiple tags can
1382
+ # be added to a resource, either when you create it, or later. Up to 50
1383
+ # tags can be associated with each resource.
1384
+ #
1385
+ # @option params [required, String] :resource_arn
1386
+ # The Amazon Resource Name (ARN) of the specific resource to which the
1387
+ # tag should be associated.
1388
+ #
1389
+ # @option params [required, Array<Types::Tag>] :tags
1390
+ # The tag or tags to be associated with a specific resource. Both the
1391
+ # tag key and value are specified.
1392
+ #
1393
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1394
+ #
1395
+ # @example Request syntax with placeholder values
1396
+ #
1397
+ # resp = client.tag_resource({
1398
+ # resource_arn: "AmazonResourceArn", # required
1399
+ # tags: [ # required
1400
+ # {
1401
+ # key: "TagKey", # required
1402
+ # value: "TagValue", # required
1403
+ # },
1404
+ # ],
1405
+ # })
1406
+ #
1407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/TagResource AWS API Documentation
1408
+ #
1409
+ # @overload tag_resource(params = {})
1410
+ # @param [Hash] params ({})
1411
+ def tag_resource(params = {}, options = {})
1412
+ req = build_request(:tag_resource, params)
1413
+ req.send_request(options)
1414
+ end
1415
+
1416
+ # Removes a specific tag from a given resource. The tag is specified by
1417
+ # its key.
1418
+ #
1419
+ # @option params [required, String] :resource_arn
1420
+ # The Amazon Resource Name (ARN) of the resource to which the tag is
1421
+ # currently associated.
1422
+ #
1423
+ # @option params [required, Array<String>] :tag_keys
1424
+ # Specifies the key of the tag to be removed from a specified resource.
1425
+ #
1426
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1427
+ #
1428
+ # @example Request syntax with placeholder values
1429
+ #
1430
+ # resp = client.untag_resource({
1431
+ # resource_arn: "AmazonResourceArn", # required
1432
+ # tag_keys: ["TagKey"], # required
1433
+ # })
1434
+ #
1435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UntagResource AWS API Documentation
1436
+ #
1437
+ # @overload untag_resource(params = {})
1438
+ # @param [Hash] params ({})
1439
+ def untag_resource(params = {}, options = {})
1440
+ req = build_request(:untag_resource, params)
1441
+ req.send_request(options)
1442
+ end
1443
+
1444
+ # Updates an inference scheduler.
1445
+ #
1446
+ # @option params [required, String] :inference_scheduler_name
1447
+ # The name of the inference scheduler to be updated.
1448
+ #
1449
+ # @option params [Integer] :data_delay_offset_in_minutes
1450
+ # &gt; A period of time (in minutes) by which inference on the data is
1451
+ # delayed after the data starts. For instance, if you select an offset
1452
+ # delay time of five minutes, inference will not begin on the data until
1453
+ # the first data measurement after the five minute mark. For example, if
1454
+ # five minutes is selected, the inference scheduler will wake up at the
1455
+ # configured frequency with the additional five minute delay time to
1456
+ # check the customer S3 bucket. The customer can upload data at the same
1457
+ # frequency and they don't need to stop and restart the scheduler when
1458
+ # uploading new data.
1459
+ #
1460
+ # @option params [String] :data_upload_frequency
1461
+ # How often data is uploaded to the source S3 bucket for the input data.
1462
+ # The value chosen is the length of time between data uploads. For
1463
+ # instance, if you select 5 minutes, Amazon Lookout for Equipment will
1464
+ # upload the real-time data to the source bucket once every 5 minutes.
1465
+ # This frequency also determines how often Amazon Lookout for Equipment
1466
+ # starts a scheduled inference on your data. In this example, it starts
1467
+ # once every 5 minutes.
1468
+ #
1469
+ # @option params [Types::InferenceInputConfiguration] :data_input_configuration
1470
+ # Specifies information for the input data for the inference scheduler,
1471
+ # including delimiter, format, and dataset location.
1472
+ #
1473
+ # @option params [Types::InferenceOutputConfiguration] :data_output_configuration
1474
+ # Specifies information for the output results from the inference
1475
+ # scheduler, including the output S3 location.
1476
+ #
1477
+ # @option params [String] :role_arn
1478
+ # The Amazon Resource Name (ARN) of a role with permission to access the
1479
+ # data source for the inference scheduler.
1480
+ #
1481
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1482
+ #
1483
+ # @example Request syntax with placeholder values
1484
+ #
1485
+ # resp = client.update_inference_scheduler({
1486
+ # inference_scheduler_name: "InferenceSchedulerIdentifier", # required
1487
+ # data_delay_offset_in_minutes: 1,
1488
+ # data_upload_frequency: "PT5M", # accepts PT5M, PT10M, PT15M, PT30M, PT1H
1489
+ # data_input_configuration: {
1490
+ # s3_input_configuration: {
1491
+ # bucket: "S3Bucket", # required
1492
+ # prefix: "S3Prefix",
1493
+ # },
1494
+ # input_time_zone_offset: "TimeZoneOffset",
1495
+ # inference_input_name_configuration: {
1496
+ # timestamp_format: "FileNameTimestampFormat",
1497
+ # component_timestamp_delimiter: "ComponentTimestampDelimiter",
1498
+ # },
1499
+ # },
1500
+ # data_output_configuration: {
1501
+ # s3_output_configuration: { # required
1502
+ # bucket: "S3Bucket", # required
1503
+ # prefix: "S3Prefix",
1504
+ # },
1505
+ # kms_key_id: "NameOrArn",
1506
+ # },
1507
+ # role_arn: "IamRoleArn",
1508
+ # })
1509
+ #
1510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateInferenceScheduler AWS API Documentation
1511
+ #
1512
+ # @overload update_inference_scheduler(params = {})
1513
+ # @param [Hash] params ({})
1514
+ def update_inference_scheduler(params = {}, options = {})
1515
+ req = build_request(:update_inference_scheduler, params)
1516
+ req.send_request(options)
1517
+ end
1518
+
1519
+ # @!endgroup
1520
+
1521
+ # @param params ({})
1522
+ # @api private
1523
+ def build_request(operation_name, params = {})
1524
+ handlers = @handlers.for(operation_name)
1525
+ context = Seahorse::Client::RequestContext.new(
1526
+ operation_name: operation_name,
1527
+ operation: config.api.operation(operation_name),
1528
+ client: self,
1529
+ params: params,
1530
+ config: config)
1531
+ context[:gem_name] = 'aws-sdk-lookoutequipment'
1532
+ context[:gem_version] = '1.0.0'
1533
+ Seahorse::Client::Request.new(handlers, context)
1534
+ end
1535
+
1536
+ # @api private
1537
+ # @deprecated
1538
+ def waiter_names
1539
+ []
1540
+ end
1541
+
1542
+ class << self
1543
+
1544
+ # @api private
1545
+ attr_reader :identifier
1546
+
1547
+ # @api private
1548
+ def errors_module
1549
+ Errors
1550
+ end
1551
+
1552
+ end
1553
+ end
1554
+ end