aws-sdk-iotmanagedintegrations 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2964 @@
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'
11
+ require 'aws-sdk-core/plugins/credentials_configuration'
12
+ require 'aws-sdk-core/plugins/logging'
13
+ require 'aws-sdk-core/plugins/param_converter'
14
+ require 'aws-sdk-core/plugins/param_validator'
15
+ require 'aws-sdk-core/plugins/user_agent'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors'
17
+ require 'aws-sdk-core/plugins/retry_errors'
18
+ require 'aws-sdk-core/plugins/global_configuration'
19
+ require 'aws-sdk-core/plugins/regional_endpoint'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern'
22
+ require 'aws-sdk-core/plugins/response_paging'
23
+ require 'aws-sdk-core/plugins/stub_responses'
24
+ require 'aws-sdk-core/plugins/idempotency_token'
25
+ require 'aws-sdk-core/plugins/invocation_id'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin'
29
+ require 'aws-sdk-core/plugins/transfer_encoding'
30
+ require 'aws-sdk-core/plugins/http_checksum'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm'
32
+ require 'aws-sdk-core/plugins/request_compression'
33
+ require 'aws-sdk-core/plugins/defaults_mode'
34
+ require 'aws-sdk-core/plugins/recursion_detection'
35
+ require 'aws-sdk-core/plugins/telemetry'
36
+ require 'aws-sdk-core/plugins/sign'
37
+ require 'aws-sdk-core/plugins/protocols/rest_json'
38
+
39
+ module Aws::IoTManagedIntegrations
40
+ # An API client for IoTManagedIntegrations. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::IoTManagedIntegrations::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :iotmanagedintegrations
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::InvocationId)
76
+ add_plugin(Aws::Plugins::JsonvalueConverter)
77
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
79
+ add_plugin(Aws::Plugins::TransferEncoding)
80
+ add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::IoTManagedIntegrations::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials. This can be an instance of any one of the
99
+ # following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following
128
+ # locations will be searched for credentials:
129
+ #
130
+ # * `Aws.config[:credentials]`
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
+ # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
135
+ # * `~/.aws/credentials`
136
+ # * `~/.aws/config`
137
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
+ # are very aggressive. Construct and pass an instance of
139
+ # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
+ # enable retries and extended timeouts. Instance profile credential
141
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
+ # to true.
143
+ #
144
+ # @option options [required, String] :region
145
+ # The AWS region to connect to. The configured `:region` is
146
+ # used to determine the service `:endpoint`. When not passed,
147
+ # a default `:region` is searched for in the following locations:
148
+ #
149
+ # * `Aws.config[:region]`
150
+ # * `ENV['AWS_REGION']`
151
+ # * `ENV['AMAZON_REGION']`
152
+ # * `ENV['AWS_DEFAULT_REGION']`
153
+ # * `~/.aws/credentials`
154
+ # * `~/.aws/config`
155
+ #
156
+ # @option options [String] :access_key_id
157
+ #
158
+ # @option options [String] :account_id
159
+ #
160
+ # @option options [Boolean] :active_endpoint_cache (false)
161
+ # When set to `true`, a thread polling for endpoints will be running in
162
+ # the background every 60 secs (default). Defaults to `false`.
163
+ #
164
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
165
+ # Used only in `adaptive` retry mode. When true, the request will sleep
166
+ # until there is sufficent client side capacity to retry the request.
167
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
+ # not retry instead of sleeping.
169
+ #
170
+ # @option options [Boolean] :client_side_monitoring (false)
171
+ # When `true`, client-side metrics will be collected for all API requests from
172
+ # this client.
173
+ #
174
+ # @option options [String] :client_side_monitoring_client_id ("")
175
+ # Allows you to provide an identifier for this client which will be attached to
176
+ # all generated client side metrics. Defaults to an empty string.
177
+ #
178
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
179
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
180
+ # side monitoring agent is running on, where client metrics will be published via UDP.
181
+ #
182
+ # @option options [Integer] :client_side_monitoring_port (31000)
183
+ # Required for publishing client metrics. The port that the client side monitoring
184
+ # agent is running on, where client metrics will be published via UDP.
185
+ #
186
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
187
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
188
+ # will use the Client Side Monitoring Agent Publisher.
189
+ #
190
+ # @option options [Boolean] :convert_params (true)
191
+ # When `true`, an attempt is made to coerce request parameters into
192
+ # the required types.
193
+ #
194
+ # @option options [Boolean] :correct_clock_skew (true)
195
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
196
+ # a clock skew correction and retry requests with skewed client clocks.
197
+ #
198
+ # @option options [String] :defaults_mode ("legacy")
199
+ # See {Aws::DefaultsModeConfiguration} for a list of the
200
+ # accepted modes and the configuration defaults that are included.
201
+ #
202
+ # @option options [Boolean] :disable_host_prefix_injection (false)
203
+ # Set to true to disable SDK automatically adding host prefix
204
+ # to default service endpoint when available.
205
+ #
206
+ # @option options [Boolean] :disable_request_compression (false)
207
+ # When set to 'true' the request body will not be compressed
208
+ # for supported operations.
209
+ #
210
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
211
+ # Normally you should not configure the `:endpoint` option
212
+ # directly. This is normally constructed from the `:region`
213
+ # option. Configuring `:endpoint` is normally reserved for
214
+ # connecting to test or custom endpoints. The endpoint should
215
+ # be a URI formatted like:
216
+ #
217
+ # 'http://example.com'
218
+ # 'https://example.com'
219
+ # 'http://example.com:123'
220
+ #
221
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
222
+ # Used for the maximum size limit of the LRU cache storing endpoints data
223
+ # for endpoint discovery enabled operations. Defaults to 1000.
224
+ #
225
+ # @option options [Integer] :endpoint_cache_max_threads (10)
226
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
227
+ #
228
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
229
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
230
+ # Use this option to config the time interval in seconds for making
231
+ # requests fetching endpoints information. Defaults to 60 sec.
232
+ #
233
+ # @option options [Boolean] :endpoint_discovery (false)
234
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
235
+ #
236
+ # @option options [Boolean] :ignore_configured_endpoint_urls
237
+ # Setting to true disables use of endpoint URLs provided via environment
238
+ # variables and the shared configuration file.
239
+ #
240
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
241
+ # The log formatter.
242
+ #
243
+ # @option options [Symbol] :log_level (:info)
244
+ # The log level to send messages to the `:logger` at.
245
+ #
246
+ # @option options [Logger] :logger
247
+ # The Logger instance to send log messages to. If this option
248
+ # is not set, logging will be disabled.
249
+ #
250
+ # @option options [Integer] :max_attempts (3)
251
+ # An integer representing the maximum number attempts that will be made for
252
+ # a single request, including the initial attempt. For example,
253
+ # setting this value to 5 will result in a request being retried up to
254
+ # 4 times. Used in `standard` and `adaptive` retry modes.
255
+ #
256
+ # @option options [String] :profile ("default")
257
+ # Used when loading credentials from the shared credentials file
258
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
259
+ #
260
+ # @option options [String] :request_checksum_calculation ("when_supported")
261
+ # Determines when a checksum will be calculated for request payloads. Values are:
262
+ #
263
+ # * `when_supported` - (default) When set, a checksum will be
264
+ # calculated for all request payloads of operations modeled with the
265
+ # `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
266
+ # `requestAlgorithmMember` is modeled.
267
+ # * `when_required` - When set, a checksum will only be calculated for
268
+ # request payloads of operations modeled with the `httpChecksum` trait where
269
+ # `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
270
+ # is modeled and supplied.
271
+ #
272
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
273
+ # The minimum size in bytes that triggers compression for request
274
+ # bodies. The value must be non-negative integer value between 0
275
+ # and 10485780 bytes inclusive.
276
+ #
277
+ # @option options [String] :response_checksum_validation ("when_supported")
278
+ # Determines when checksum validation will be performed on response payloads. Values are:
279
+ #
280
+ # * `when_supported` - (default) When set, checksum validation is performed on all
281
+ # response payloads of operations modeled with the `httpChecksum` trait where
282
+ # `responseAlgorithms` is modeled, except when no modeled checksum algorithms
283
+ # are supported.
284
+ # * `when_required` - When set, checksum validation is not performed on
285
+ # response payloads of operations unless the checksum algorithm is supported and
286
+ # the `requestValidationModeMember` member is set to `ENABLED`.
287
+ #
288
+ # @option options [Proc] :retry_backoff
289
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
290
+ # This option is only used in the `legacy` retry mode.
291
+ #
292
+ # @option options [Float] :retry_base_delay (0.3)
293
+ # The base delay in seconds used by the default backoff function. This option
294
+ # is only used in the `legacy` retry mode.
295
+ #
296
+ # @option options [Symbol] :retry_jitter (:none)
297
+ # A delay randomiser function used by the default backoff function.
298
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
299
+ # otherwise a Proc that takes and returns a number. This option is only used
300
+ # in the `legacy` retry mode.
301
+ #
302
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
303
+ #
304
+ # @option options [Integer] :retry_limit (3)
305
+ # The maximum number of times to retry failed requests. Only
306
+ # ~ 500 level server errors and certain ~ 400 level client errors
307
+ # are retried. Generally, these are throttling errors, data
308
+ # checksum errors, networking errors, timeout errors, auth errors,
309
+ # endpoint discovery, and errors from expired credentials.
310
+ # This option is only used in the `legacy` retry mode.
311
+ #
312
+ # @option options [Integer] :retry_max_delay (0)
313
+ # The maximum number of seconds to delay between retries (0 for no limit)
314
+ # used by the default backoff function. This option is only used in the
315
+ # `legacy` retry mode.
316
+ #
317
+ # @option options [String] :retry_mode ("legacy")
318
+ # Specifies which retry algorithm to use. Values are:
319
+ #
320
+ # * `legacy` - The pre-existing retry behavior. This is default value if
321
+ # no retry mode is provided.
322
+ #
323
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
324
+ # This includes support for retry quotas, which limit the number of
325
+ # unsuccessful retries a client can make.
326
+ #
327
+ # * `adaptive` - An experimental retry mode that includes all the
328
+ # functionality of `standard` mode along with automatic client side
329
+ # throttling. This is a provisional mode that may change behavior
330
+ # in the future.
331
+ #
332
+ # @option options [String] :sdk_ua_app_id
333
+ # A unique and opaque application ID that is appended to the
334
+ # User-Agent header as app/sdk_ua_app_id. It should have a
335
+ # maximum length of 50. This variable is sourced from environment
336
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
337
+ #
338
+ # @option options [String] :secret_access_key
339
+ #
340
+ # @option options [String] :session_token
341
+ #
342
+ # @option options [Array] :sigv4a_signing_region_set
343
+ # A list of regions that should be signed with SigV4a signing. When
344
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
345
+ # in the following locations:
346
+ #
347
+ # * `Aws.config[:sigv4a_signing_region_set]`
348
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
349
+ # * `~/.aws/config`
350
+ #
351
+ # @option options [Boolean] :stub_responses (false)
352
+ # Causes the client to return stubbed responses. By default
353
+ # fake responses are generated and returned. You can specify
354
+ # the response data to return or errors to raise by calling
355
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
356
+ #
357
+ # ** Please note ** When response stubbing is enabled, no HTTP
358
+ # requests are made, and retries are disabled.
359
+ #
360
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
361
+ # Allows you to provide a telemetry provider, which is used to
362
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
363
+ # will not record or emit any telemetry data. The SDK supports the
364
+ # following telemetry providers:
365
+ #
366
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
367
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
368
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
369
+ #
370
+ # @option options [Aws::TokenProvider] :token_provider
371
+ # A Bearer Token Provider. This can be an instance of any one of the
372
+ # following classes:
373
+ #
374
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
375
+ # tokens.
376
+ #
377
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
378
+ # access token generated from `aws login`.
379
+ #
380
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
381
+ # will be used to search for tokens configured for your profile in shared configuration files.
382
+ #
383
+ # @option options [Boolean] :use_dualstack_endpoint
384
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
385
+ # will be used if available.
386
+ #
387
+ # @option options [Boolean] :use_fips_endpoint
388
+ # When set to `true`, fips compatible endpoints will be used if available.
389
+ # When a `fips` region is used, the region is normalized and this config
390
+ # is set to `true`.
391
+ #
392
+ # @option options [Boolean] :validate_params (true)
393
+ # When `true`, request parameters are validated before
394
+ # sending the request.
395
+ #
396
+ # @option options [Aws::IoTManagedIntegrations::EndpointProvider] :endpoint_provider
397
+ # The endpoint provider used to resolve endpoints. Any object that responds to
398
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
399
+ # `Aws::IoTManagedIntegrations::EndpointParameters`.
400
+ #
401
+ # @option options [Float] :http_continue_timeout (1)
402
+ # The number of seconds to wait for a 100-continue response before sending the
403
+ # request body. This option has no effect unless the request has "Expect"
404
+ # header set to "100-continue". Defaults to `nil` which disables this
405
+ # behaviour. This value can safely be set per request on the session.
406
+ #
407
+ # @option options [Float] :http_idle_timeout (5)
408
+ # The number of seconds a connection is allowed to sit idle before it
409
+ # is considered stale. Stale connections are closed and removed from the
410
+ # pool before making a request.
411
+ #
412
+ # @option options [Float] :http_open_timeout (15)
413
+ # The default number of seconds to wait for response data.
414
+ # This value can safely be set per-request on the session.
415
+ #
416
+ # @option options [URI::HTTP,String] :http_proxy
417
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
418
+ #
419
+ # @option options [Float] :http_read_timeout (60)
420
+ # The default number of seconds to wait for response data.
421
+ # This value can safely be set per-request on the session.
422
+ #
423
+ # @option options [Boolean] :http_wire_trace (false)
424
+ # When `true`, HTTP debug output will be sent to the `:logger`.
425
+ #
426
+ # @option options [Proc] :on_chunk_received
427
+ # When a Proc object is provided, it will be used as callback when each chunk
428
+ # of the response body is received. It provides three arguments: the chunk,
429
+ # the number of bytes received, and the total number of
430
+ # bytes in the response (or nil if the server did not send a `content-length`).
431
+ #
432
+ # @option options [Proc] :on_chunk_sent
433
+ # When a Proc object is provided, it will be used as callback when each chunk
434
+ # of the request body is sent. It provides three arguments: the chunk,
435
+ # the number of bytes read from the body, and the total number of
436
+ # bytes in the body.
437
+ #
438
+ # @option options [Boolean] :raise_response_errors (true)
439
+ # When `true`, response errors are raised.
440
+ #
441
+ # @option options [String] :ssl_ca_bundle
442
+ # Full path to the SSL certificate authority bundle file that should be used when
443
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
444
+ # `:ssl_ca_directory` the the system default will be used if available.
445
+ #
446
+ # @option options [String] :ssl_ca_directory
447
+ # Full path of the directory that contains the unbundled SSL certificate
448
+ # authority files for verifying peer certificates. If you do
449
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
450
+ # default will be used if available.
451
+ #
452
+ # @option options [String] :ssl_ca_store
453
+ # Sets the X509::Store to verify peer certificate.
454
+ #
455
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
456
+ # Sets a client certificate when creating http connections.
457
+ #
458
+ # @option options [OpenSSL::PKey] :ssl_key
459
+ # Sets a client key when creating http connections.
460
+ #
461
+ # @option options [Float] :ssl_timeout
462
+ # Sets the SSL timeout in seconds
463
+ #
464
+ # @option options [Boolean] :ssl_verify_peer (true)
465
+ # When `true`, SSL peer certificates are verified when establishing a connection.
466
+ #
467
+ def initialize(*args)
468
+ super
469
+ end
470
+
471
+ # @!group API Operations
472
+
473
+ # Create a product credential locker. This operation will trigger the
474
+ # creation of all the manufacturing resources including the Wi-Fi setup
475
+ # key pair and device certificate.
476
+ #
477
+ # @option params [String] :name
478
+ # The name of the credential locker.
479
+ #
480
+ # @option params [String] :client_token
481
+ # An idempotency token. If you retry a request that completed
482
+ # successfully initially using the same client token and parameters,
483
+ # then the retry attempt will succeed without performing any further
484
+ # actions.
485
+ #
486
+ # **A suitable default value is auto-generated.** You should normally
487
+ # not need to pass this option.**
488
+ #
489
+ # @option params [Hash<String,String>] :tags
490
+ # A set of key/value pairs that are used to manage the credential
491
+ # locker.
492
+ #
493
+ # @return [Types::CreateCredentialLockerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
494
+ #
495
+ # * {Types::CreateCredentialLockerResponse#id #id} => String
496
+ # * {Types::CreateCredentialLockerResponse#arn #arn} => String
497
+ # * {Types::CreateCredentialLockerResponse#created_at #created_at} => Time
498
+ #
499
+ # @example Request syntax with placeholder values
500
+ #
501
+ # resp = client.create_credential_locker({
502
+ # name: "CredentialLockerName",
503
+ # client_token: "ClientToken",
504
+ # tags: {
505
+ # "TagKey" => "TagValue",
506
+ # },
507
+ # })
508
+ #
509
+ # @example Response structure
510
+ #
511
+ # resp.id #=> String
512
+ # resp.arn #=> String
513
+ # resp.created_at #=> Time
514
+ #
515
+ # @overload create_credential_locker(params = {})
516
+ # @param [Hash] params ({})
517
+ def create_credential_locker(params = {}, options = {})
518
+ req = build_request(:create_credential_locker, params)
519
+ req.send_request(options)
520
+ end
521
+
522
+ # Create a destination. IoT managed integrations uses the destination to
523
+ # determine where to deliver notifications for a device.
524
+ #
525
+ # @option params [required, String] :delivery_destination_arn
526
+ # The Amazon Resource Name (ARN) of the customer-managed destination.
527
+ #
528
+ # @option params [required, String] :delivery_destination_type
529
+ # The destination type for the customer-managed destination.
530
+ #
531
+ # @option params [required, String] :name
532
+ # The name of the customer-managed destination.
533
+ #
534
+ # @option params [required, String] :role_arn
535
+ # The Amazon Resource Name (ARN) of the delivery destination role.
536
+ #
537
+ # @option params [String] :client_token
538
+ # An idempotency token. If you retry a request that completed
539
+ # successfully initially using the same client token and parameters,
540
+ # then the retry attempt will succeed without performing any further
541
+ # actions.
542
+ #
543
+ # **A suitable default value is auto-generated.** You should normally
544
+ # not need to pass this option.**
545
+ #
546
+ # @option params [String] :description
547
+ # The description of the customer-managed destination.
548
+ #
549
+ # @option params [Hash<String,String>] :tags
550
+ # A set of key/value pairs that are used to manage the destination.
551
+ #
552
+ # @return [Types::CreateDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
553
+ #
554
+ # * {Types::CreateDestinationResponse#name #name} => String
555
+ #
556
+ # @example Request syntax with placeholder values
557
+ #
558
+ # resp = client.create_destination({
559
+ # delivery_destination_arn: "DeliveryDestinationArn", # required
560
+ # delivery_destination_type: "KINESIS", # required, accepts KINESIS
561
+ # name: "DestinationName", # required
562
+ # role_arn: "DeliveryDestinationRoleArn", # required
563
+ # client_token: "ClientToken",
564
+ # description: "DestinationDescription",
565
+ # tags: {
566
+ # "TagKey" => "TagValue",
567
+ # },
568
+ # })
569
+ #
570
+ # @example Response structure
571
+ #
572
+ # resp.name #=> String
573
+ #
574
+ # @overload create_destination(params = {})
575
+ # @param [Hash] params ({})
576
+ def create_destination(params = {}, options = {})
577
+ req = build_request(:create_destination, params)
578
+ req.send_request(options)
579
+ end
580
+
581
+ # Set the event log configuration for the account, resource type, or
582
+ # specific resource.
583
+ #
584
+ # @option params [required, String] :resource_type
585
+ # The type of resource for the event log configuration.
586
+ #
587
+ # @option params [String] :resource_id
588
+ # The identifier of the resource for the event log configuration.
589
+ #
590
+ # @option params [required, String] :event_log_level
591
+ # The logging level for the event log configuration.
592
+ #
593
+ # @option params [String] :client_token
594
+ # An idempotency token. If you retry a request that completed
595
+ # successfully initially using the same client token and parameters,
596
+ # then the retry attempt will succeed without performing any further
597
+ # actions.
598
+ #
599
+ # **A suitable default value is auto-generated.** You should normally
600
+ # not need to pass this option.**
601
+ #
602
+ # @return [Types::CreateEventLogConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
603
+ #
604
+ # * {Types::CreateEventLogConfigurationResponse#id #id} => String
605
+ #
606
+ # @example Request syntax with placeholder values
607
+ #
608
+ # resp = client.create_event_log_configuration({
609
+ # resource_type: "SmartHomeResourceType", # required
610
+ # resource_id: "SmartHomeResourceId",
611
+ # event_log_level: "DEBUG", # required, accepts DEBUG, ERROR, INFO, WARN
612
+ # client_token: "ClientToken",
613
+ # })
614
+ #
615
+ # @example Response structure
616
+ #
617
+ # resp.id #=> String
618
+ #
619
+ # @overload create_event_log_configuration(params = {})
620
+ # @param [Hash] params ({})
621
+ def create_event_log_configuration(params = {}, options = {})
622
+ req = build_request(:create_event_log_configuration, params)
623
+ req.send_request(options)
624
+ end
625
+
626
+ # Creates a managed thing. A managed thing contains the device
627
+ # identifier, protocol supported, and capabilities of the device in a
628
+ # protocol-specific format.
629
+ #
630
+ # @option params [required, String] :role
631
+ # The type of device used. This will be the hub controller, cloud
632
+ # device, or AWS IoT device.
633
+ #
634
+ # @option params [String] :owner
635
+ # Owner of the device, usually an indication of whom the device belongs
636
+ # to. This value should not contain personal identifiable information.
637
+ #
638
+ # @option params [String] :credential_locker_id
639
+ # The identifier of the credential for the managed thing.
640
+ #
641
+ # @option params [required, String] :authentication_material
642
+ # The authentication material defining the device connectivity setup
643
+ # requests. The authentication materials used are the device bar code.
644
+ #
645
+ # @option params [required, String] :authentication_material_type
646
+ # The type of authentication material used for device connectivity setup
647
+ # requests.
648
+ #
649
+ # @option params [String] :serial_number
650
+ # The serial number of the device.
651
+ #
652
+ # @option params [String] :brand
653
+ # The brand of the device.
654
+ #
655
+ # @option params [String] :model
656
+ # The model of the device.
657
+ #
658
+ # @option params [String] :name
659
+ # The name of the managed thing representing the physical device.
660
+ #
661
+ # @option params [Types::CapabilityReport] :capability_report
662
+ # A report of the capabilities for the managed thing.
663
+ #
664
+ # @option params [String] :capabilities
665
+ # The capabilities of the device such as light bulb.
666
+ #
667
+ # @option params [String] :client_token
668
+ # An idempotency token. If you retry a request that completed
669
+ # successfully initially using the same client token and parameters,
670
+ # then the retry attempt will succeed without performing any further
671
+ # actions.
672
+ #
673
+ # **A suitable default value is auto-generated.** You should normally
674
+ # not need to pass this option.**
675
+ #
676
+ # @option params [String] :classification
677
+ # The classification of the managed thing such as light bulb or
678
+ # thermostat.
679
+ #
680
+ # @option params [Hash<String,String>] :tags
681
+ # A set of key/value pairs that are used to manage the managed thing.
682
+ #
683
+ # @option params [Hash<String,String>] :meta_data
684
+ # The metadata for the managed thing.
685
+ #
686
+ # @return [Types::CreateManagedThingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
687
+ #
688
+ # * {Types::CreateManagedThingResponse#id #id} => String
689
+ # * {Types::CreateManagedThingResponse#arn #arn} => String
690
+ # * {Types::CreateManagedThingResponse#created_at #created_at} => Time
691
+ #
692
+ # @example Request syntax with placeholder values
693
+ #
694
+ # resp = client.create_managed_thing({
695
+ # role: "CONTROLLER", # required, accepts CONTROLLER, DEVICE
696
+ # owner: "Owner",
697
+ # credential_locker_id: "CredentialLockerId",
698
+ # authentication_material: "AuthMaterialString", # required
699
+ # authentication_material_type: "WIFI_SETUP_QR_BAR_CODE", # required, accepts WIFI_SETUP_QR_BAR_CODE, ZWAVE_QR_BAR_CODE, ZIGBEE_QR_BAR_CODE
700
+ # serial_number: "SerialNumber",
701
+ # brand: "Brand",
702
+ # model: "Model",
703
+ # name: "Name",
704
+ # capability_report: {
705
+ # version: "CapabilityReportVersion", # required
706
+ # node_id: "NodeId",
707
+ # endpoints: [ # required
708
+ # {
709
+ # id: "EndpointId", # required
710
+ # device_types: ["DeviceType"], # required
711
+ # capabilities: [ # required
712
+ # {
713
+ # id: "SchemaVersionedId", # required
714
+ # name: "CapabilityName", # required
715
+ # version: "CapabilityVersion", # required
716
+ # properties: ["PropertyName"], # required
717
+ # actions: ["ActionName"], # required
718
+ # events: ["EventName"], # required
719
+ # },
720
+ # ],
721
+ # },
722
+ # ],
723
+ # },
724
+ # capabilities: "Capabilities",
725
+ # client_token: "ClientToken",
726
+ # classification: "Classification",
727
+ # tags: {
728
+ # "TagKey" => "TagValue",
729
+ # },
730
+ # meta_data: {
731
+ # "AttributeName" => "AttributeValue",
732
+ # },
733
+ # })
734
+ #
735
+ # @example Response structure
736
+ #
737
+ # resp.id #=> String
738
+ # resp.arn #=> String
739
+ # resp.created_at #=> Time
740
+ #
741
+ # @overload create_managed_thing(params = {})
742
+ # @param [Hash] params ({})
743
+ def create_managed_thing(params = {}, options = {})
744
+ req = build_request(:create_managed_thing, params)
745
+ req.send_request(options)
746
+ end
747
+
748
+ # Creates a notification configuration. A configuration is a connection
749
+ # between an event type and a destination that you have already created.
750
+ #
751
+ # @option params [required, String] :event_type
752
+ # The type of event triggering a device notification to the
753
+ # customer-managed destination.
754
+ #
755
+ # @option params [required, String] :destination_name
756
+ # The name of the destination for the notification configuration.
757
+ #
758
+ # @option params [String] :client_token
759
+ # An idempotency token. If you retry a request that completed
760
+ # successfully initially using the same client token and parameters,
761
+ # then the retry attempt will succeed without performing any further
762
+ # actions.
763
+ #
764
+ # **A suitable default value is auto-generated.** You should normally
765
+ # not need to pass this option.**
766
+ #
767
+ # @option params [Hash<String,String>] :tags
768
+ # A set of key/value pairs that are used to manage the notification
769
+ # configuration.
770
+ #
771
+ # @return [Types::CreateNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
772
+ #
773
+ # * {Types::CreateNotificationConfigurationResponse#event_type #event_type} => String
774
+ #
775
+ # @example Request syntax with placeholder values
776
+ #
777
+ # resp = client.create_notification_configuration({
778
+ # event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, CONNECTOR_ASSOCIATION, CONNECTOR_ERROR_REPORT
779
+ # destination_name: "DestinationName", # required
780
+ # client_token: "ClientToken",
781
+ # tags: {
782
+ # "TagKey" => "TagValue",
783
+ # },
784
+ # })
785
+ #
786
+ # @example Response structure
787
+ #
788
+ # resp.event_type #=> String, one of "DEVICE_COMMAND", "DEVICE_COMMAND_REQUEST", "DEVICE_EVENT", "DEVICE_LIFE_CYCLE", "DEVICE_STATE", "DEVICE_OTA", "CONNECTOR_ASSOCIATION", "CONNECTOR_ERROR_REPORT"
789
+ #
790
+ # @overload create_notification_configuration(params = {})
791
+ # @param [Hash] params ({})
792
+ def create_notification_configuration(params = {}, options = {})
793
+ req = build_request(:create_notification_configuration, params)
794
+ req.send_request(options)
795
+ end
796
+
797
+ # Create an over-the-air (OTA) task to update a device.
798
+ #
799
+ # @option params [String] :description
800
+ # The description of the over-the-air (OTA) task.
801
+ #
802
+ # @option params [required, String] :s3_url
803
+ # The URL to the Amazon S3 bucket where the over-the-air (OTA) task is
804
+ # stored.
805
+ #
806
+ # @option params [String] :protocol
807
+ # The connection protocol the over-the-air (OTA) task uses to update the
808
+ # device.
809
+ #
810
+ # @option params [Array<String>] :target
811
+ # The device targeted for the over-the-air (OTA) task.
812
+ #
813
+ # @option params [String] :task_configuration_id
814
+ # The identifier for the over-the-air (OTA) task configuration.
815
+ #
816
+ # @option params [String] :ota_mechanism
817
+ # The deployment mechanism for the over-the-air (OTA) task.
818
+ #
819
+ # @option params [required, String] :ota_type
820
+ # The frequency type for the over-the-air (OTA) task.
821
+ #
822
+ # @option params [String] :ota_target_query_string
823
+ # The query string to add things to the thing group.
824
+ #
825
+ # @option params [String] :client_token
826
+ # An idempotency token. If you retry a request that completed
827
+ # successfully initially using the same client token and parameters,
828
+ # then the retry attempt will succeed without performing any further
829
+ # actions.
830
+ #
831
+ # **A suitable default value is auto-generated.** You should normally
832
+ # not need to pass this option.**
833
+ #
834
+ # @option params [Types::OtaTaskSchedulingConfig] :ota_scheduling_config
835
+ # Over-the-air (OTA) task scheduling config.
836
+ #
837
+ # @option params [Types::OtaTaskExecutionRetryConfig] :ota_task_execution_retry_config
838
+ # Over-the-air (OTA) task retry config.
839
+ #
840
+ # @option params [Hash<String,String>] :tags
841
+ # A set of key/value pairs that are used to manage the over-the-air
842
+ # (OTA) task.
843
+ #
844
+ # @return [Types::CreateOtaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
845
+ #
846
+ # * {Types::CreateOtaTaskResponse#task_id #task_id} => String
847
+ # * {Types::CreateOtaTaskResponse#task_arn #task_arn} => String
848
+ # * {Types::CreateOtaTaskResponse#description #description} => String
849
+ #
850
+ # @example Request syntax with placeholder values
851
+ #
852
+ # resp = client.create_ota_task({
853
+ # description: "OtaDescription",
854
+ # s3_url: "S3Url", # required
855
+ # protocol: "HTTP", # accepts HTTP
856
+ # target: ["String"],
857
+ # task_configuration_id: "OtaTaskConfigurationId",
858
+ # ota_mechanism: "PUSH", # accepts PUSH
859
+ # ota_type: "ONE_TIME", # required, accepts ONE_TIME, CONTINUOUS
860
+ # ota_target_query_string: "OtaTargetQueryString",
861
+ # client_token: "ClientToken",
862
+ # ota_scheduling_config: {
863
+ # end_behavior: "STOP_ROLLOUT", # accepts STOP_ROLLOUT, CANCEL, FORCE_CANCEL
864
+ # end_time: "EndTime",
865
+ # maintenance_windows: [
866
+ # {
867
+ # duration_in_minutes: 1,
868
+ # start_time: "StartTime",
869
+ # },
870
+ # ],
871
+ # start_time: "ScheduleStartTime",
872
+ # },
873
+ # ota_task_execution_retry_config: {
874
+ # retry_config_criteria: [
875
+ # {
876
+ # failure_type: "FAILED", # accepts FAILED, TIMED_OUT, ALL
877
+ # min_number_of_retries: 1,
878
+ # },
879
+ # ],
880
+ # },
881
+ # tags: {
882
+ # "TagKey" => "TagValue",
883
+ # },
884
+ # })
885
+ #
886
+ # @example Response structure
887
+ #
888
+ # resp.task_id #=> String
889
+ # resp.task_arn #=> String
890
+ # resp.description #=> String
891
+ #
892
+ # @overload create_ota_task(params = {})
893
+ # @param [Hash] params ({})
894
+ def create_ota_task(params = {}, options = {})
895
+ req = build_request(:create_ota_task, params)
896
+ req.send_request(options)
897
+ end
898
+
899
+ # Create a configuraiton for the over-the-air (OTA) task.
900
+ #
901
+ # @option params [String] :description
902
+ # A description of the over-the-air (OTA) task configuration.
903
+ #
904
+ # @option params [String] :name
905
+ # The name of the over-the-air (OTA) task.
906
+ #
907
+ # @option params [Types::PushConfig] :push_config
908
+ # Describes the type of configuration used for the over-the-air (OTA)
909
+ # task.
910
+ #
911
+ # @option params [String] :client_token
912
+ # An idempotency token. If you retry a request that completed
913
+ # successfully initially using the same client token and parameters,
914
+ # then the retry attempt will succeed without performing any further
915
+ # actions.
916
+ #
917
+ # **A suitable default value is auto-generated.** You should normally
918
+ # not need to pass this option.**
919
+ #
920
+ # @return [Types::CreateOtaTaskConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
921
+ #
922
+ # * {Types::CreateOtaTaskConfigurationResponse#task_configuration_id #task_configuration_id} => String
923
+ #
924
+ # @example Request syntax with placeholder values
925
+ #
926
+ # resp = client.create_ota_task_configuration({
927
+ # description: "OtaDescription",
928
+ # name: "OtaTaskConfigurationName",
929
+ # push_config: {
930
+ # abort_config: {
931
+ # abort_config_criteria_list: [
932
+ # {
933
+ # action: "CANCEL", # accepts CANCEL
934
+ # failure_type: "FAILED", # accepts FAILED, REJECTED, TIMED_OUT, ALL
935
+ # min_number_of_executed_things: 1,
936
+ # threshold_percentage: 1.0,
937
+ # },
938
+ # ],
939
+ # },
940
+ # rollout_config: {
941
+ # exponential_rollout_rate: {
942
+ # base_rate_per_minute: 1,
943
+ # increment_factor: 1.0,
944
+ # rate_increase_criteria: {
945
+ # number_of_notified_things: 1,
946
+ # number_of_succeeded_things: 1,
947
+ # },
948
+ # },
949
+ # maximum_per_minute: 1,
950
+ # },
951
+ # timeout_config: {
952
+ # in_progress_timeout_in_minutes: 1,
953
+ # },
954
+ # },
955
+ # client_token: "ClientToken",
956
+ # })
957
+ #
958
+ # @example Response structure
959
+ #
960
+ # resp.task_configuration_id #=> String
961
+ #
962
+ # @overload create_ota_task_configuration(params = {})
963
+ # @param [Hash] params ({})
964
+ def create_ota_task_configuration(params = {}, options = {})
965
+ req = build_request(:create_ota_task_configuration, params)
966
+ req.send_request(options)
967
+ end
968
+
969
+ # Create a provisioning profile for a device to execute the provisioning
970
+ # flows using a provisioning template. The provisioning template is a
971
+ # document that defines the set of resources and policies applied to a
972
+ # device during the provisioning process.
973
+ #
974
+ # @option params [required, String] :provisioning_type
975
+ # The type of provisioning workflow the device uses for onboarding to
976
+ # IoT managed integrations.
977
+ #
978
+ # @option params [String] :ca_certificate
979
+ # The id of the certificate authority (CA) certificate.
980
+ #
981
+ # @option params [String] :name
982
+ # The name of the provisioning template.
983
+ #
984
+ # @option params [String] :client_token
985
+ # An idempotency token. If you retry a request that completed
986
+ # successfully initially using the same client token and parameters,
987
+ # then the retry attempt will succeed without performing any further
988
+ # actions.
989
+ #
990
+ # **A suitable default value is auto-generated.** You should normally
991
+ # not need to pass this option.**
992
+ #
993
+ # @option params [Hash<String,String>] :tags
994
+ # A set of key/value pairs that are used to manage the provisioning
995
+ # profile.
996
+ #
997
+ # @return [Types::CreateProvisioningProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
998
+ #
999
+ # * {Types::CreateProvisioningProfileResponse#arn #arn} => String
1000
+ # * {Types::CreateProvisioningProfileResponse#name #name} => String
1001
+ # * {Types::CreateProvisioningProfileResponse#provisioning_type #provisioning_type} => String
1002
+ # * {Types::CreateProvisioningProfileResponse#id #id} => String
1003
+ # * {Types::CreateProvisioningProfileResponse#claim_certificate #claim_certificate} => String
1004
+ # * {Types::CreateProvisioningProfileResponse#claim_certificate_private_key #claim_certificate_private_key} => String
1005
+ #
1006
+ # @example Request syntax with placeholder values
1007
+ #
1008
+ # resp = client.create_provisioning_profile({
1009
+ # provisioning_type: "FLEET_PROVISIONING", # required, accepts FLEET_PROVISIONING, JITR
1010
+ # ca_certificate: "CaCertificate",
1011
+ # name: "ProvisioningProfileName",
1012
+ # client_token: "ClientToken",
1013
+ # tags: {
1014
+ # "TagKey" => "TagValue",
1015
+ # },
1016
+ # })
1017
+ #
1018
+ # @example Response structure
1019
+ #
1020
+ # resp.arn #=> String
1021
+ # resp.name #=> String
1022
+ # resp.provisioning_type #=> String, one of "FLEET_PROVISIONING", "JITR"
1023
+ # resp.id #=> String
1024
+ # resp.claim_certificate #=> String
1025
+ # resp.claim_certificate_private_key #=> String
1026
+ #
1027
+ # @overload create_provisioning_profile(params = {})
1028
+ # @param [Hash] params ({})
1029
+ def create_provisioning_profile(params = {}, options = {})
1030
+ req = build_request(:create_provisioning_profile, params)
1031
+ req.send_request(options)
1032
+ end
1033
+
1034
+ # Delete a credential locker.
1035
+ #
1036
+ # <note markdown="1"> This operation can't be undone and any existing device won't be able
1037
+ # to use IoT managed integrations.
1038
+ #
1039
+ # </note>
1040
+ #
1041
+ # @option params [required, String] :identifier
1042
+ # The identifier of the credential locker.
1043
+ #
1044
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1045
+ #
1046
+ # @example Request syntax with placeholder values
1047
+ #
1048
+ # resp = client.delete_credential_locker({
1049
+ # identifier: "CredentialLockerId", # required
1050
+ # })
1051
+ #
1052
+ # @overload delete_credential_locker(params = {})
1053
+ # @param [Hash] params ({})
1054
+ def delete_credential_locker(params = {}, options = {})
1055
+ req = build_request(:delete_credential_locker, params)
1056
+ req.send_request(options)
1057
+ end
1058
+
1059
+ # Deletes a customer-managed destination specified by id.
1060
+ #
1061
+ # @option params [required, String] :name
1062
+ # The id of the customer-managed destination.
1063
+ #
1064
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1065
+ #
1066
+ # @example Request syntax with placeholder values
1067
+ #
1068
+ # resp = client.delete_destination({
1069
+ # name: "DestinationName", # required
1070
+ # })
1071
+ #
1072
+ # @overload delete_destination(params = {})
1073
+ # @param [Hash] params ({})
1074
+ def delete_destination(params = {}, options = {})
1075
+ req = build_request(:delete_destination, params)
1076
+ req.send_request(options)
1077
+ end
1078
+
1079
+ # Delete an event log configuration.
1080
+ #
1081
+ # @option params [required, String] :id
1082
+ # The identifier of the event log configuration.
1083
+ #
1084
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1085
+ #
1086
+ # @example Request syntax with placeholder values
1087
+ #
1088
+ # resp = client.delete_event_log_configuration({
1089
+ # id: "LogConfigurationId", # required
1090
+ # })
1091
+ #
1092
+ # @overload delete_event_log_configuration(params = {})
1093
+ # @param [Hash] params ({})
1094
+ def delete_event_log_configuration(params = {}, options = {})
1095
+ req = build_request(:delete_event_log_configuration, params)
1096
+ req.send_request(options)
1097
+ end
1098
+
1099
+ # Delete a managed thing. If a controller is deleted, all of the devices
1100
+ # connected to it will have their status changed to `PENDING`. It is not
1101
+ # possible to remove a cloud device.
1102
+ #
1103
+ # @option params [required, String] :identifier
1104
+ # The id of the managed thing.
1105
+ #
1106
+ # @option params [Boolean] :force
1107
+ # When set to `TRUE`, a forceful deteletion of the managed thing will
1108
+ # occur. When set to `FALSE`, a non-forceful deletion of the managed
1109
+ # thing will occur.
1110
+ #
1111
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1112
+ #
1113
+ # @example Request syntax with placeholder values
1114
+ #
1115
+ # resp = client.delete_managed_thing({
1116
+ # identifier: "ManagedThingId", # required
1117
+ # force: false,
1118
+ # })
1119
+ #
1120
+ # @overload delete_managed_thing(params = {})
1121
+ # @param [Hash] params ({})
1122
+ def delete_managed_thing(params = {}, options = {})
1123
+ req = build_request(:delete_managed_thing, params)
1124
+ req.send_request(options)
1125
+ end
1126
+
1127
+ # Deletes a notification configuration.
1128
+ #
1129
+ # @option params [required, String] :event_type
1130
+ # The type of event triggering a device notification to the
1131
+ # customer-managed destination.
1132
+ #
1133
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1134
+ #
1135
+ # @example Request syntax with placeholder values
1136
+ #
1137
+ # resp = client.delete_notification_configuration({
1138
+ # event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, CONNECTOR_ASSOCIATION, CONNECTOR_ERROR_REPORT
1139
+ # })
1140
+ #
1141
+ # @overload delete_notification_configuration(params = {})
1142
+ # @param [Hash] params ({})
1143
+ def delete_notification_configuration(params = {}, options = {})
1144
+ req = build_request(:delete_notification_configuration, params)
1145
+ req.send_request(options)
1146
+ end
1147
+
1148
+ # Delete the over-the-air (OTA) task.
1149
+ #
1150
+ # @option params [required, String] :identifier
1151
+ # The identifier of the over-the-air (OTA) task.
1152
+ #
1153
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1154
+ #
1155
+ # @example Request syntax with placeholder values
1156
+ #
1157
+ # resp = client.delete_ota_task({
1158
+ # identifier: "OtaTaskId", # required
1159
+ # })
1160
+ #
1161
+ # @overload delete_ota_task(params = {})
1162
+ # @param [Hash] params ({})
1163
+ def delete_ota_task(params = {}, options = {})
1164
+ req = build_request(:delete_ota_task, params)
1165
+ req.send_request(options)
1166
+ end
1167
+
1168
+ # Delete the over-the-air (OTA) task configuration.
1169
+ #
1170
+ # @option params [required, String] :identifier
1171
+ # The identifier of the over-the-air (OTA) task configuration.
1172
+ #
1173
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1174
+ #
1175
+ # @example Request syntax with placeholder values
1176
+ #
1177
+ # resp = client.delete_ota_task_configuration({
1178
+ # identifier: "OtaTaskConfigurationId", # required
1179
+ # })
1180
+ #
1181
+ # @overload delete_ota_task_configuration(params = {})
1182
+ # @param [Hash] params ({})
1183
+ def delete_ota_task_configuration(params = {}, options = {})
1184
+ req = build_request(:delete_ota_task_configuration, params)
1185
+ req.send_request(options)
1186
+ end
1187
+
1188
+ # Delete a provisioning profile.
1189
+ #
1190
+ # @option params [required, String] :identifier
1191
+ # The name of the provisioning template.
1192
+ #
1193
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1194
+ #
1195
+ # @example Request syntax with placeholder values
1196
+ #
1197
+ # resp = client.delete_provisioning_profile({
1198
+ # identifier: "ProvisioningProfileId", # required
1199
+ # })
1200
+ #
1201
+ # @overload delete_provisioning_profile(params = {})
1202
+ # @param [Hash] params ({})
1203
+ def delete_provisioning_profile(params = {}, options = {})
1204
+ req = build_request(:delete_provisioning_profile, params)
1205
+ req.send_request(options)
1206
+ end
1207
+
1208
+ # Get information on an existing credential locker
1209
+ #
1210
+ # @option params [required, String] :identifier
1211
+ # The identifier of the credential locker.
1212
+ #
1213
+ # @return [Types::GetCredentialLockerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1214
+ #
1215
+ # * {Types::GetCredentialLockerResponse#id #id} => String
1216
+ # * {Types::GetCredentialLockerResponse#arn #arn} => String
1217
+ # * {Types::GetCredentialLockerResponse#name #name} => String
1218
+ # * {Types::GetCredentialLockerResponse#created_at #created_at} => Time
1219
+ # * {Types::GetCredentialLockerResponse#tags #tags} => Hash&lt;String,String&gt;
1220
+ #
1221
+ # @example Request syntax with placeholder values
1222
+ #
1223
+ # resp = client.get_credential_locker({
1224
+ # identifier: "CredentialLockerId", # required
1225
+ # })
1226
+ #
1227
+ # @example Response structure
1228
+ #
1229
+ # resp.id #=> String
1230
+ # resp.arn #=> String
1231
+ # resp.name #=> String
1232
+ # resp.created_at #=> Time
1233
+ # resp.tags #=> Hash
1234
+ # resp.tags["TagKey"] #=> String
1235
+ #
1236
+ # @overload get_credential_locker(params = {})
1237
+ # @param [Hash] params ({})
1238
+ def get_credential_locker(params = {}, options = {})
1239
+ req = build_request(:get_credential_locker, params)
1240
+ req.send_request(options)
1241
+ end
1242
+
1243
+ # Returns the IoT managed integrations custom endpoint.
1244
+ #
1245
+ # @return [Types::GetCustomEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1246
+ #
1247
+ # * {Types::GetCustomEndpointResponse#endpoint_address #endpoint_address} => String
1248
+ #
1249
+ # @example Response structure
1250
+ #
1251
+ # resp.endpoint_address #=> String
1252
+ #
1253
+ # @overload get_custom_endpoint(params = {})
1254
+ # @param [Hash] params ({})
1255
+ def get_custom_endpoint(params = {}, options = {})
1256
+ req = build_request(:get_custom_endpoint, params)
1257
+ req.send_request(options)
1258
+ end
1259
+
1260
+ # Retrieves information about the default encryption configuration for
1261
+ # the Amazon Web Services account in the default or specified region.
1262
+ # For more information, see [Key management][1] in the *AWS IoT SiteWise
1263
+ # User Guide*.
1264
+ #
1265
+ #
1266
+ #
1267
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
1268
+ #
1269
+ # @return [Types::GetDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1270
+ #
1271
+ # * {Types::GetDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
1272
+ # * {Types::GetDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
1273
+ # * {Types::GetDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
1274
+ #
1275
+ # @example Response structure
1276
+ #
1277
+ # resp.configuration_status.error.code #=> String
1278
+ # resp.configuration_status.error.message #=> String
1279
+ # resp.configuration_status.state #=> String, one of "ENABLED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
1280
+ # resp.encryption_type #=> String, one of "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION", "CUSTOMER_KEY_ENCRYPTION"
1281
+ # resp.kms_key_arn #=> String
1282
+ #
1283
+ # @overload get_default_encryption_configuration(params = {})
1284
+ # @param [Hash] params ({})
1285
+ def get_default_encryption_configuration(params = {}, options = {})
1286
+ req = build_request(:get_default_encryption_configuration, params)
1287
+ req.send_request(options)
1288
+ end
1289
+
1290
+ # Gets a destination by ID.
1291
+ #
1292
+ # @option params [required, String] :name
1293
+ # The name of the customer-managed destination.
1294
+ #
1295
+ # @return [Types::GetDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1296
+ #
1297
+ # * {Types::GetDestinationResponse#description #description} => String
1298
+ # * {Types::GetDestinationResponse#delivery_destination_arn #delivery_destination_arn} => String
1299
+ # * {Types::GetDestinationResponse#delivery_destination_type #delivery_destination_type} => String
1300
+ # * {Types::GetDestinationResponse#name #name} => String
1301
+ # * {Types::GetDestinationResponse#role_arn #role_arn} => String
1302
+ # * {Types::GetDestinationResponse#created_at #created_at} => Time
1303
+ # * {Types::GetDestinationResponse#updated_at #updated_at} => Time
1304
+ # * {Types::GetDestinationResponse#tags #tags} => Hash&lt;String,String&gt;
1305
+ #
1306
+ # @example Request syntax with placeholder values
1307
+ #
1308
+ # resp = client.get_destination({
1309
+ # name: "DestinationName", # required
1310
+ # })
1311
+ #
1312
+ # @example Response structure
1313
+ #
1314
+ # resp.description #=> String
1315
+ # resp.delivery_destination_arn #=> String
1316
+ # resp.delivery_destination_type #=> String, one of "KINESIS"
1317
+ # resp.name #=> String
1318
+ # resp.role_arn #=> String
1319
+ # resp.created_at #=> Time
1320
+ # resp.updated_at #=> Time
1321
+ # resp.tags #=> Hash
1322
+ # resp.tags["TagKey"] #=> String
1323
+ #
1324
+ # @overload get_destination(params = {})
1325
+ # @param [Hash] params ({})
1326
+ def get_destination(params = {}, options = {})
1327
+ req = build_request(:get_destination, params)
1328
+ req.send_request(options)
1329
+ end
1330
+
1331
+ # Get the current state of a device discovery.
1332
+ #
1333
+ # @option params [required, String] :identifier
1334
+ # The id of the device discovery job request.
1335
+ #
1336
+ # @return [Types::GetDeviceDiscoveryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1337
+ #
1338
+ # * {Types::GetDeviceDiscoveryResponse#id #id} => String
1339
+ # * {Types::GetDeviceDiscoveryResponse#arn #arn} => String
1340
+ # * {Types::GetDeviceDiscoveryResponse#discovery_type #discovery_type} => String
1341
+ # * {Types::GetDeviceDiscoveryResponse#status #status} => String
1342
+ # * {Types::GetDeviceDiscoveryResponse#started_at #started_at} => Time
1343
+ # * {Types::GetDeviceDiscoveryResponse#controller_id #controller_id} => String
1344
+ # * {Types::GetDeviceDiscoveryResponse#connector_association_id #connector_association_id} => String
1345
+ # * {Types::GetDeviceDiscoveryResponse#finished_at #finished_at} => Time
1346
+ # * {Types::GetDeviceDiscoveryResponse#tags #tags} => Hash&lt;String,String&gt;
1347
+ #
1348
+ # @example Request syntax with placeholder values
1349
+ #
1350
+ # resp = client.get_device_discovery({
1351
+ # identifier: "DeviceDiscoveryId", # required
1352
+ # })
1353
+ #
1354
+ # @example Response structure
1355
+ #
1356
+ # resp.id #=> String
1357
+ # resp.arn #=> String
1358
+ # resp.discovery_type #=> String, one of "ZWAVE", "ZIGBEE", "CLOUD"
1359
+ # resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT"
1360
+ # resp.started_at #=> Time
1361
+ # resp.controller_id #=> String
1362
+ # resp.connector_association_id #=> String
1363
+ # resp.finished_at #=> Time
1364
+ # resp.tags #=> Hash
1365
+ # resp.tags["TagKey"] #=> String
1366
+ #
1367
+ # @overload get_device_discovery(params = {})
1368
+ # @param [Hash] params ({})
1369
+ def get_device_discovery(params = {}, options = {})
1370
+ req = build_request(:get_device_discovery, params)
1371
+ req.send_request(options)
1372
+ end
1373
+
1374
+ # Get an event log configuration.
1375
+ #
1376
+ # @option params [required, String] :id
1377
+ # The identifier of the event log configuration.
1378
+ #
1379
+ # @return [Types::GetEventLogConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1380
+ #
1381
+ # * {Types::GetEventLogConfigurationResponse#id #id} => String
1382
+ # * {Types::GetEventLogConfigurationResponse#resource_type #resource_type} => String
1383
+ # * {Types::GetEventLogConfigurationResponse#resource_id #resource_id} => String
1384
+ # * {Types::GetEventLogConfigurationResponse#event_log_level #event_log_level} => String
1385
+ #
1386
+ # @example Request syntax with placeholder values
1387
+ #
1388
+ # resp = client.get_event_log_configuration({
1389
+ # id: "LogConfigurationId", # required
1390
+ # })
1391
+ #
1392
+ # @example Response structure
1393
+ #
1394
+ # resp.id #=> String
1395
+ # resp.resource_type #=> String
1396
+ # resp.resource_id #=> String
1397
+ # resp.event_log_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"
1398
+ #
1399
+ # @overload get_event_log_configuration(params = {})
1400
+ # @param [Hash] params ({})
1401
+ def get_event_log_configuration(params = {}, options = {})
1402
+ req = build_request(:get_event_log_configuration, params)
1403
+ req.send_request(options)
1404
+ end
1405
+
1406
+ # Get a hub configuration.
1407
+ #
1408
+ # @return [Types::GetHubConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1409
+ #
1410
+ # * {Types::GetHubConfigurationResponse#hub_token_timer_expiry_setting_in_seconds #hub_token_timer_expiry_setting_in_seconds} => Integer
1411
+ # * {Types::GetHubConfigurationResponse#updated_at #updated_at} => Time
1412
+ #
1413
+ # @example Response structure
1414
+ #
1415
+ # resp.hub_token_timer_expiry_setting_in_seconds #=> Integer
1416
+ # resp.updated_at #=> Time
1417
+ #
1418
+ # @overload get_hub_configuration(params = {})
1419
+ # @param [Hash] params ({})
1420
+ def get_hub_configuration(params = {}, options = {})
1421
+ req = build_request(:get_hub_configuration, params)
1422
+ req.send_request(options)
1423
+ end
1424
+
1425
+ # Get the attributes and capabilities associated with a managed thing.
1426
+ #
1427
+ # @option params [required, String] :identifier
1428
+ # The id of the managed thing.
1429
+ #
1430
+ # @return [Types::GetManagedThingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1431
+ #
1432
+ # * {Types::GetManagedThingResponse#id #id} => String
1433
+ # * {Types::GetManagedThingResponse#arn #arn} => String
1434
+ # * {Types::GetManagedThingResponse#owner #owner} => String
1435
+ # * {Types::GetManagedThingResponse#credential_locker_id #credential_locker_id} => String
1436
+ # * {Types::GetManagedThingResponse#advertised_product_id #advertised_product_id} => String
1437
+ # * {Types::GetManagedThingResponse#role #role} => String
1438
+ # * {Types::GetManagedThingResponse#provisioning_status #provisioning_status} => String
1439
+ # * {Types::GetManagedThingResponse#name #name} => String
1440
+ # * {Types::GetManagedThingResponse#model #model} => String
1441
+ # * {Types::GetManagedThingResponse#brand #brand} => String
1442
+ # * {Types::GetManagedThingResponse#serial_number #serial_number} => String
1443
+ # * {Types::GetManagedThingResponse#universal_product_code #universal_product_code} => String
1444
+ # * {Types::GetManagedThingResponse#international_article_number #international_article_number} => String
1445
+ # * {Types::GetManagedThingResponse#connector_policy_id #connector_policy_id} => String
1446
+ # * {Types::GetManagedThingResponse#connector_device_id #connector_device_id} => String
1447
+ # * {Types::GetManagedThingResponse#device_specific_key #device_specific_key} => String
1448
+ # * {Types::GetManagedThingResponse#mac_address #mac_address} => String
1449
+ # * {Types::GetManagedThingResponse#parent_controller_id #parent_controller_id} => String
1450
+ # * {Types::GetManagedThingResponse#classification #classification} => String
1451
+ # * {Types::GetManagedThingResponse#created_at #created_at} => Time
1452
+ # * {Types::GetManagedThingResponse#updated_at #updated_at} => Time
1453
+ # * {Types::GetManagedThingResponse#activated_at #activated_at} => Time
1454
+ # * {Types::GetManagedThingResponse#hub_network_mode #hub_network_mode} => String
1455
+ # * {Types::GetManagedThingResponse#meta_data #meta_data} => Hash&lt;String,String&gt;
1456
+ # * {Types::GetManagedThingResponse#tags #tags} => Hash&lt;String,String&gt;
1457
+ #
1458
+ # @example Request syntax with placeholder values
1459
+ #
1460
+ # resp = client.get_managed_thing({
1461
+ # identifier: "ManagedThingId", # required
1462
+ # })
1463
+ #
1464
+ # @example Response structure
1465
+ #
1466
+ # resp.id #=> String
1467
+ # resp.arn #=> String
1468
+ # resp.owner #=> String
1469
+ # resp.credential_locker_id #=> String
1470
+ # resp.advertised_product_id #=> String
1471
+ # resp.role #=> String, one of "CONTROLLER", "DEVICE"
1472
+ # resp.provisioning_status #=> String, one of "UNASSOCIATED", "PRE_ASSOCIATED", "DISCOVERED", "ACTIVATED", "DELETION_FAILED", "DELETE_IN_PROGRESS", "ISOLATED", "DELETED"
1473
+ # resp.name #=> String
1474
+ # resp.model #=> String
1475
+ # resp.brand #=> String
1476
+ # resp.serial_number #=> String
1477
+ # resp.universal_product_code #=> String
1478
+ # resp.international_article_number #=> String
1479
+ # resp.connector_policy_id #=> String
1480
+ # resp.connector_device_id #=> String
1481
+ # resp.device_specific_key #=> String
1482
+ # resp.mac_address #=> String
1483
+ # resp.parent_controller_id #=> String
1484
+ # resp.classification #=> String
1485
+ # resp.created_at #=> Time
1486
+ # resp.updated_at #=> Time
1487
+ # resp.activated_at #=> Time
1488
+ # resp.hub_network_mode #=> String, one of "STANDARD", "NETWORK_WIDE_EXCLUSION"
1489
+ # resp.meta_data #=> Hash
1490
+ # resp.meta_data["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1491
+ # resp.tags #=> Hash
1492
+ # resp.tags["TagKey"] #=> String
1493
+ #
1494
+ # @overload get_managed_thing(params = {})
1495
+ # @param [Hash] params ({})
1496
+ def get_managed_thing(params = {}, options = {})
1497
+ req = build_request(:get_managed_thing, params)
1498
+ req.send_request(options)
1499
+ end
1500
+
1501
+ # Get the capabilities for a managed thing using the device ID.
1502
+ #
1503
+ # @option params [required, String] :identifier
1504
+ # The id of the device.
1505
+ #
1506
+ # @return [Types::GetManagedThingCapabilitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1507
+ #
1508
+ # * {Types::GetManagedThingCapabilitiesResponse#managed_thing_id #managed_thing_id} => String
1509
+ # * {Types::GetManagedThingCapabilitiesResponse#capabilities #capabilities} => String
1510
+ # * {Types::GetManagedThingCapabilitiesResponse#capability_report #capability_report} => Types::CapabilityReport
1511
+ #
1512
+ # @example Request syntax with placeholder values
1513
+ #
1514
+ # resp = client.get_managed_thing_capabilities({
1515
+ # identifier: "ManagedThingId", # required
1516
+ # })
1517
+ #
1518
+ # @example Response structure
1519
+ #
1520
+ # resp.managed_thing_id #=> String
1521
+ # resp.capabilities #=> String
1522
+ # resp.capability_report.version #=> String
1523
+ # resp.capability_report.node_id #=> String
1524
+ # resp.capability_report.endpoints #=> Array
1525
+ # resp.capability_report.endpoints[0].id #=> String
1526
+ # resp.capability_report.endpoints[0].device_types #=> Array
1527
+ # resp.capability_report.endpoints[0].device_types[0] #=> String
1528
+ # resp.capability_report.endpoints[0].capabilities #=> Array
1529
+ # resp.capability_report.endpoints[0].capabilities[0].id #=> String
1530
+ # resp.capability_report.endpoints[0].capabilities[0].name #=> String
1531
+ # resp.capability_report.endpoints[0].capabilities[0].version #=> String
1532
+ # resp.capability_report.endpoints[0].capabilities[0].properties #=> Array
1533
+ # resp.capability_report.endpoints[0].capabilities[0].properties[0] #=> String
1534
+ # resp.capability_report.endpoints[0].capabilities[0].actions #=> Array
1535
+ # resp.capability_report.endpoints[0].capabilities[0].actions[0] #=> String
1536
+ # resp.capability_report.endpoints[0].capabilities[0].events #=> Array
1537
+ # resp.capability_report.endpoints[0].capabilities[0].events[0] #=> String
1538
+ #
1539
+ # @overload get_managed_thing_capabilities(params = {})
1540
+ # @param [Hash] params ({})
1541
+ def get_managed_thing_capabilities(params = {}, options = {})
1542
+ req = build_request(:get_managed_thing_capabilities, params)
1543
+ req.send_request(options)
1544
+ end
1545
+
1546
+ # Get the connectivity status of a managed thing.
1547
+ #
1548
+ # @option params [required, String] :identifier
1549
+ # The identifier of a managed thing.
1550
+ #
1551
+ # @return [Types::GetManagedThingConnectivityDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1552
+ #
1553
+ # * {Types::GetManagedThingConnectivityDataResponse#managed_thing_id #managed_thing_id} => String
1554
+ # * {Types::GetManagedThingConnectivityDataResponse#connected #connected} => Boolean
1555
+ # * {Types::GetManagedThingConnectivityDataResponse#timestamp #timestamp} => Time
1556
+ # * {Types::GetManagedThingConnectivityDataResponse#disconnect_reason #disconnect_reason} => String
1557
+ #
1558
+ # @example Request syntax with placeholder values
1559
+ #
1560
+ # resp = client.get_managed_thing_connectivity_data({
1561
+ # identifier: "ManagedThingId", # required
1562
+ # })
1563
+ #
1564
+ # @example Response structure
1565
+ #
1566
+ # resp.managed_thing_id #=> String
1567
+ # resp.connected #=> Boolean
1568
+ # resp.timestamp #=> Time
1569
+ # resp.disconnect_reason #=> String, one of "AUTH_ERROR", "CLIENT_INITIATED_DISCONNECT", "CLIENT_ERROR", "CONNECTION_LOST", "DUPLICATE_CLIENTID", "FORBIDDEN_ACCESS", "MQTT_KEEP_ALIVE_TIMEOUT", "SERVER_ERROR", "SERVER_INITIATED_DISCONNECT", "THROTTLED", "WEBSOCKET_TTL_EXPIRATION", "CUSTOMAUTH_TTL_EXPIRATION", "UNKNOWN", "NONE"
1570
+ #
1571
+ # @overload get_managed_thing_connectivity_data(params = {})
1572
+ # @param [Hash] params ({})
1573
+ def get_managed_thing_connectivity_data(params = {}, options = {})
1574
+ req = build_request(:get_managed_thing_connectivity_data, params)
1575
+ req.send_request(options)
1576
+ end
1577
+
1578
+ # Get the metadata information for a managed thing.
1579
+ #
1580
+ # @option params [required, String] :identifier
1581
+ # The managed thing id.
1582
+ #
1583
+ # @return [Types::GetManagedThingMetaDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1584
+ #
1585
+ # * {Types::GetManagedThingMetaDataResponse#managed_thing_id #managed_thing_id} => String
1586
+ # * {Types::GetManagedThingMetaDataResponse#meta_data #meta_data} => Hash&lt;String,String&gt;
1587
+ #
1588
+ # @example Request syntax with placeholder values
1589
+ #
1590
+ # resp = client.get_managed_thing_meta_data({
1591
+ # identifier: "ManagedThingId", # required
1592
+ # })
1593
+ #
1594
+ # @example Response structure
1595
+ #
1596
+ # resp.managed_thing_id #=> String
1597
+ # resp.meta_data #=> Hash
1598
+ # resp.meta_data["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1599
+ #
1600
+ # @overload get_managed_thing_meta_data(params = {})
1601
+ # @param [Hash] params ({})
1602
+ def get_managed_thing_meta_data(params = {}, options = {})
1603
+ req = build_request(:get_managed_thing_meta_data, params)
1604
+ req.send_request(options)
1605
+ end
1606
+
1607
+ # Returns the managed thing state for the given device Id.
1608
+ #
1609
+ # @option params [required, String] :managed_thing_id
1610
+ # The id of the device.
1611
+ #
1612
+ # @return [Types::GetManagedThingStateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1613
+ #
1614
+ # * {Types::GetManagedThingStateResponse#endpoints #endpoints} => Array&lt;Types::StateEndpoint&gt;
1615
+ #
1616
+ # @example Request syntax with placeholder values
1617
+ #
1618
+ # resp = client.get_managed_thing_state({
1619
+ # managed_thing_id: "ManagedThingId", # required
1620
+ # })
1621
+ #
1622
+ # @example Response structure
1623
+ #
1624
+ # resp.endpoints #=> Array
1625
+ # resp.endpoints[0].endpoint_id #=> String
1626
+ # resp.endpoints[0].capabilities #=> Array
1627
+ # resp.endpoints[0].capabilities[0].id #=> String
1628
+ # resp.endpoints[0].capabilities[0].name #=> String
1629
+ # resp.endpoints[0].capabilities[0].version #=> String
1630
+ #
1631
+ # @overload get_managed_thing_state(params = {})
1632
+ # @param [Hash] params ({})
1633
+ def get_managed_thing_state(params = {}, options = {})
1634
+ req = build_request(:get_managed_thing_state, params)
1635
+ req.send_request(options)
1636
+ end
1637
+
1638
+ # Get a notification configuration.
1639
+ #
1640
+ # @option params [required, String] :event_type
1641
+ # The type of event triggering a device notification to the
1642
+ # customer-managed destination.
1643
+ #
1644
+ # @return [Types::GetNotificationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1645
+ #
1646
+ # * {Types::GetNotificationConfigurationResponse#event_type #event_type} => String
1647
+ # * {Types::GetNotificationConfigurationResponse#destination_name #destination_name} => String
1648
+ # * {Types::GetNotificationConfigurationResponse#created_at #created_at} => Time
1649
+ # * {Types::GetNotificationConfigurationResponse#updated_at #updated_at} => Time
1650
+ # * {Types::GetNotificationConfigurationResponse#tags #tags} => Hash&lt;String,String&gt;
1651
+ #
1652
+ # @example Request syntax with placeholder values
1653
+ #
1654
+ # resp = client.get_notification_configuration({
1655
+ # event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, CONNECTOR_ASSOCIATION, CONNECTOR_ERROR_REPORT
1656
+ # })
1657
+ #
1658
+ # @example Response structure
1659
+ #
1660
+ # resp.event_type #=> String, one of "DEVICE_COMMAND", "DEVICE_COMMAND_REQUEST", "DEVICE_EVENT", "DEVICE_LIFE_CYCLE", "DEVICE_STATE", "DEVICE_OTA", "CONNECTOR_ASSOCIATION", "CONNECTOR_ERROR_REPORT"
1661
+ # resp.destination_name #=> String
1662
+ # resp.created_at #=> Time
1663
+ # resp.updated_at #=> Time
1664
+ # resp.tags #=> Hash
1665
+ # resp.tags["TagKey"] #=> String
1666
+ #
1667
+ # @overload get_notification_configuration(params = {})
1668
+ # @param [Hash] params ({})
1669
+ def get_notification_configuration(params = {}, options = {})
1670
+ req = build_request(:get_notification_configuration, params)
1671
+ req.send_request(options)
1672
+ end
1673
+
1674
+ # Get the over-the-air (OTA) task.
1675
+ #
1676
+ # @option params [required, String] :identifier
1677
+ # The over-the-air (OTA) task id.
1678
+ #
1679
+ # @return [Types::GetOtaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1680
+ #
1681
+ # * {Types::GetOtaTaskResponse#task_id #task_id} => String
1682
+ # * {Types::GetOtaTaskResponse#task_arn #task_arn} => String
1683
+ # * {Types::GetOtaTaskResponse#description #description} => String
1684
+ # * {Types::GetOtaTaskResponse#s3_url #s3_url} => String
1685
+ # * {Types::GetOtaTaskResponse#protocol #protocol} => String
1686
+ # * {Types::GetOtaTaskResponse#ota_type #ota_type} => String
1687
+ # * {Types::GetOtaTaskResponse#ota_target_query_string #ota_target_query_string} => String
1688
+ # * {Types::GetOtaTaskResponse#ota_mechanism #ota_mechanism} => String
1689
+ # * {Types::GetOtaTaskResponse#target #target} => Array&lt;String&gt;
1690
+ # * {Types::GetOtaTaskResponse#created_at #created_at} => Time
1691
+ # * {Types::GetOtaTaskResponse#last_updated_at #last_updated_at} => Time
1692
+ # * {Types::GetOtaTaskResponse#task_configuration_id #task_configuration_id} => String
1693
+ # * {Types::GetOtaTaskResponse#task_processing_details #task_processing_details} => Types::TaskProcessingDetails
1694
+ # * {Types::GetOtaTaskResponse#ota_scheduling_config #ota_scheduling_config} => Types::OtaTaskSchedulingConfig
1695
+ # * {Types::GetOtaTaskResponse#ota_task_execution_retry_config #ota_task_execution_retry_config} => Types::OtaTaskExecutionRetryConfig
1696
+ # * {Types::GetOtaTaskResponse#status #status} => String
1697
+ #
1698
+ # @example Request syntax with placeholder values
1699
+ #
1700
+ # resp = client.get_ota_task({
1701
+ # identifier: "OtaTaskId", # required
1702
+ # })
1703
+ #
1704
+ # @example Response structure
1705
+ #
1706
+ # resp.task_id #=> String
1707
+ # resp.task_arn #=> String
1708
+ # resp.description #=> String
1709
+ # resp.s3_url #=> String
1710
+ # resp.protocol #=> String, one of "HTTP"
1711
+ # resp.ota_type #=> String, one of "ONE_TIME", "CONTINUOUS"
1712
+ # resp.ota_target_query_string #=> String
1713
+ # resp.ota_mechanism #=> String, one of "PUSH"
1714
+ # resp.target #=> Array
1715
+ # resp.target[0] #=> String
1716
+ # resp.created_at #=> Time
1717
+ # resp.last_updated_at #=> Time
1718
+ # resp.task_configuration_id #=> String
1719
+ # resp.task_processing_details.number_of_canceled_things #=> Integer
1720
+ # resp.task_processing_details.number_of_failed_things #=> Integer
1721
+ # resp.task_processing_details.number_of_in_progress_things #=> Integer
1722
+ # resp.task_processing_details.number_of_queued_things #=> Integer
1723
+ # resp.task_processing_details.number_of_rejected_things #=> Integer
1724
+ # resp.task_processing_details.number_of_removed_things #=> Integer
1725
+ # resp.task_processing_details.number_of_succeeded_things #=> Integer
1726
+ # resp.task_processing_details.number_of_timed_out_things #=> Integer
1727
+ # resp.task_processing_details.processing_targets #=> Array
1728
+ # resp.task_processing_details.processing_targets[0] #=> String
1729
+ # resp.ota_scheduling_config.end_behavior #=> String, one of "STOP_ROLLOUT", "CANCEL", "FORCE_CANCEL"
1730
+ # resp.ota_scheduling_config.end_time #=> String
1731
+ # resp.ota_scheduling_config.maintenance_windows #=> Array
1732
+ # resp.ota_scheduling_config.maintenance_windows[0].duration_in_minutes #=> Integer
1733
+ # resp.ota_scheduling_config.maintenance_windows[0].start_time #=> String
1734
+ # resp.ota_scheduling_config.start_time #=> String
1735
+ # resp.ota_task_execution_retry_config.retry_config_criteria #=> Array
1736
+ # resp.ota_task_execution_retry_config.retry_config_criteria[0].failure_type #=> String, one of "FAILED", "TIMED_OUT", "ALL"
1737
+ # resp.ota_task_execution_retry_config.retry_config_criteria[0].min_number_of_retries #=> Integer
1738
+ # resp.status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS", "SCHEDULED"
1739
+ #
1740
+ # @overload get_ota_task(params = {})
1741
+ # @param [Hash] params ({})
1742
+ def get_ota_task(params = {}, options = {})
1743
+ req = build_request(:get_ota_task, params)
1744
+ req.send_request(options)
1745
+ end
1746
+
1747
+ # Get a configuraiton for the over-the-air (OTA) task.
1748
+ #
1749
+ # @option params [required, String] :identifier
1750
+ # The over-the-air (OTA) task configuration id.
1751
+ #
1752
+ # @return [Types::GetOtaTaskConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1753
+ #
1754
+ # * {Types::GetOtaTaskConfigurationResponse#task_configuration_id #task_configuration_id} => String
1755
+ # * {Types::GetOtaTaskConfigurationResponse#name #name} => String
1756
+ # * {Types::GetOtaTaskConfigurationResponse#push_config #push_config} => Types::PushConfig
1757
+ # * {Types::GetOtaTaskConfigurationResponse#description #description} => String
1758
+ # * {Types::GetOtaTaskConfigurationResponse#created_at #created_at} => Time
1759
+ #
1760
+ # @example Request syntax with placeholder values
1761
+ #
1762
+ # resp = client.get_ota_task_configuration({
1763
+ # identifier: "OtaTaskConfigurationId", # required
1764
+ # })
1765
+ #
1766
+ # @example Response structure
1767
+ #
1768
+ # resp.task_configuration_id #=> String
1769
+ # resp.name #=> String
1770
+ # resp.push_config.abort_config.abort_config_criteria_list #=> Array
1771
+ # resp.push_config.abort_config.abort_config_criteria_list[0].action #=> String, one of "CANCEL"
1772
+ # resp.push_config.abort_config.abort_config_criteria_list[0].failure_type #=> String, one of "FAILED", "REJECTED", "TIMED_OUT", "ALL"
1773
+ # resp.push_config.abort_config.abort_config_criteria_list[0].min_number_of_executed_things #=> Integer
1774
+ # resp.push_config.abort_config.abort_config_criteria_list[0].threshold_percentage #=> Float
1775
+ # resp.push_config.rollout_config.exponential_rollout_rate.base_rate_per_minute #=> Integer
1776
+ # resp.push_config.rollout_config.exponential_rollout_rate.increment_factor #=> Float
1777
+ # resp.push_config.rollout_config.exponential_rollout_rate.rate_increase_criteria.number_of_notified_things #=> Integer
1778
+ # resp.push_config.rollout_config.exponential_rollout_rate.rate_increase_criteria.number_of_succeeded_things #=> Integer
1779
+ # resp.push_config.rollout_config.maximum_per_minute #=> Integer
1780
+ # resp.push_config.timeout_config.in_progress_timeout_in_minutes #=> Integer
1781
+ # resp.description #=> String
1782
+ # resp.created_at #=> Time
1783
+ #
1784
+ # @overload get_ota_task_configuration(params = {})
1785
+ # @param [Hash] params ({})
1786
+ def get_ota_task_configuration(params = {}, options = {})
1787
+ req = build_request(:get_ota_task_configuration, params)
1788
+ req.send_request(options)
1789
+ end
1790
+
1791
+ # Get a provisioning profile by template name.
1792
+ #
1793
+ # @option params [required, String] :identifier
1794
+ # The provisioning template the device uses for the provisioning
1795
+ # process.
1796
+ #
1797
+ # @return [Types::GetProvisioningProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1798
+ #
1799
+ # * {Types::GetProvisioningProfileResponse#arn #arn} => String
1800
+ # * {Types::GetProvisioningProfileResponse#name #name} => String
1801
+ # * {Types::GetProvisioningProfileResponse#provisioning_type #provisioning_type} => String
1802
+ # * {Types::GetProvisioningProfileResponse#id #id} => String
1803
+ # * {Types::GetProvisioningProfileResponse#claim_certificate #claim_certificate} => String
1804
+ # * {Types::GetProvisioningProfileResponse#tags #tags} => Hash&lt;String,String&gt;
1805
+ #
1806
+ # @example Request syntax with placeholder values
1807
+ #
1808
+ # resp = client.get_provisioning_profile({
1809
+ # identifier: "ProvisioningProfileId", # required
1810
+ # })
1811
+ #
1812
+ # @example Response structure
1813
+ #
1814
+ # resp.arn #=> String
1815
+ # resp.name #=> String
1816
+ # resp.provisioning_type #=> String, one of "FLEET_PROVISIONING", "JITR"
1817
+ # resp.id #=> String
1818
+ # resp.claim_certificate #=> String
1819
+ # resp.tags #=> Hash
1820
+ # resp.tags["TagKey"] #=> String
1821
+ #
1822
+ # @overload get_provisioning_profile(params = {})
1823
+ # @param [Hash] params ({})
1824
+ def get_provisioning_profile(params = {}, options = {})
1825
+ req = build_request(:get_provisioning_profile, params)
1826
+ req.send_request(options)
1827
+ end
1828
+
1829
+ # Get the runtime log configuration for a specific managed thing or for
1830
+ # all managed things as a group.
1831
+ #
1832
+ # @option params [required, String] :managed_thing_id
1833
+ # The id for a managed thing.
1834
+ #
1835
+ # @return [Types::GetRuntimeLogConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1836
+ #
1837
+ # * {Types::GetRuntimeLogConfigurationResponse#managed_thing_id #managed_thing_id} => String
1838
+ # * {Types::GetRuntimeLogConfigurationResponse#runtime_log_configurations #runtime_log_configurations} => Types::RuntimeLogConfigurations
1839
+ #
1840
+ # @example Request syntax with placeholder values
1841
+ #
1842
+ # resp = client.get_runtime_log_configuration({
1843
+ # managed_thing_id: "ManagedThingId", # required
1844
+ # })
1845
+ #
1846
+ # @example Response structure
1847
+ #
1848
+ # resp.managed_thing_id #=> String
1849
+ # resp.runtime_log_configurations.log_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"
1850
+ # resp.runtime_log_configurations.log_flush_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"
1851
+ # resp.runtime_log_configurations.local_store_location #=> String
1852
+ # resp.runtime_log_configurations.local_store_file_rotation_max_files #=> Integer
1853
+ # resp.runtime_log_configurations.local_store_file_rotation_max_bytes #=> Integer
1854
+ # resp.runtime_log_configurations.upload_log #=> Boolean
1855
+ # resp.runtime_log_configurations.upload_period_minutes #=> Integer
1856
+ # resp.runtime_log_configurations.delete_local_store_after_upload #=> Boolean
1857
+ #
1858
+ # @overload get_runtime_log_configuration(params = {})
1859
+ # @param [Hash] params ({})
1860
+ def get_runtime_log_configuration(params = {}, options = {})
1861
+ req = build_request(:get_runtime_log_configuration, params)
1862
+ req.send_request(options)
1863
+ end
1864
+
1865
+ # Gets a schema version with the provided information.
1866
+ #
1867
+ # @option params [required, String] :type
1868
+ # The type of schema version.
1869
+ #
1870
+ # @option params [required, String] :schema_versioned_id
1871
+ # Schema id with a version specified. If the version is missing, it
1872
+ # defaults to latest version.
1873
+ #
1874
+ # @option params [String] :format
1875
+ # The format of the schema version.
1876
+ #
1877
+ # @return [Types::GetSchemaVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1878
+ #
1879
+ # * {Types::GetSchemaVersionResponse#schema_id #schema_id} => String
1880
+ # * {Types::GetSchemaVersionResponse#type #type} => String
1881
+ # * {Types::GetSchemaVersionResponse#description #description} => String
1882
+ # * {Types::GetSchemaVersionResponse#namespace #namespace} => String
1883
+ # * {Types::GetSchemaVersionResponse#semantic_version #semantic_version} => String
1884
+ # * {Types::GetSchemaVersionResponse#visibility #visibility} => String
1885
+ # * {Types::GetSchemaVersionResponse#schema #schema} => Hash,Array,String,Numeric,Boolean
1886
+ #
1887
+ # @example Request syntax with placeholder values
1888
+ #
1889
+ # resp = client.get_schema_version({
1890
+ # type: "capability", # required, accepts capability, definition
1891
+ # schema_versioned_id: "SchemaVersionedId", # required
1892
+ # format: "AWS", # accepts AWS, ZCL, CONNECTOR
1893
+ # })
1894
+ #
1895
+ # @example Response structure
1896
+ #
1897
+ # resp.schema_id #=> String
1898
+ # resp.type #=> String, one of "capability", "definition"
1899
+ # resp.description #=> String
1900
+ # resp.namespace #=> String
1901
+ # resp.semantic_version #=> String
1902
+ # resp.visibility #=> String, one of "PUBLIC", "PRIVATE"
1903
+ #
1904
+ # @overload get_schema_version(params = {})
1905
+ # @param [Hash] params ({})
1906
+ def get_schema_version(params = {}, options = {})
1907
+ req = build_request(:get_schema_version, params)
1908
+ req.send_request(options)
1909
+ end
1910
+
1911
+ # List information on an existing credential locker.
1912
+ #
1913
+ # @option params [String] :next_token
1914
+ # A token that can be used to retrieve the next set of results.
1915
+ #
1916
+ # @option params [Integer] :max_results
1917
+ # The maximum number of results to return at one time.
1918
+ #
1919
+ # @return [Types::ListCredentialLockersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1920
+ #
1921
+ # * {Types::ListCredentialLockersResponse#items #items} => Array&lt;Types::CredentialLockerSummary&gt;
1922
+ # * {Types::ListCredentialLockersResponse#next_token #next_token} => String
1923
+ #
1924
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1925
+ #
1926
+ # @example Request syntax with placeholder values
1927
+ #
1928
+ # resp = client.list_credential_lockers({
1929
+ # next_token: "NextToken",
1930
+ # max_results: 1,
1931
+ # })
1932
+ #
1933
+ # @example Response structure
1934
+ #
1935
+ # resp.items #=> Array
1936
+ # resp.items[0].id #=> String
1937
+ # resp.items[0].arn #=> String
1938
+ # resp.items[0].name #=> String
1939
+ # resp.items[0].created_at #=> Time
1940
+ # resp.next_token #=> String
1941
+ #
1942
+ # @overload list_credential_lockers(params = {})
1943
+ # @param [Hash] params ({})
1944
+ def list_credential_lockers(params = {}, options = {})
1945
+ req = build_request(:list_credential_lockers, params)
1946
+ req.send_request(options)
1947
+ end
1948
+
1949
+ # List all destination names under one Amazon Web Services account.
1950
+ #
1951
+ # @option params [String] :next_token
1952
+ # A token that can be used to retrieve the next set of results.
1953
+ #
1954
+ # @option params [Integer] :max_results
1955
+ # The maximum number of results to return at one time.
1956
+ #
1957
+ # @return [Types::ListDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1958
+ #
1959
+ # * {Types::ListDestinationsResponse#destination_list #destination_list} => Array&lt;Types::DestinationSummary&gt;
1960
+ # * {Types::ListDestinationsResponse#next_token #next_token} => String
1961
+ #
1962
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1963
+ #
1964
+ # @example Request syntax with placeholder values
1965
+ #
1966
+ # resp = client.list_destinations({
1967
+ # next_token: "NextToken",
1968
+ # max_results: 1,
1969
+ # })
1970
+ #
1971
+ # @example Response structure
1972
+ #
1973
+ # resp.destination_list #=> Array
1974
+ # resp.destination_list[0].description #=> String
1975
+ # resp.destination_list[0].delivery_destination_arn #=> String
1976
+ # resp.destination_list[0].delivery_destination_type #=> String, one of "KINESIS"
1977
+ # resp.destination_list[0].name #=> String
1978
+ # resp.destination_list[0].role_arn #=> String
1979
+ # resp.next_token #=> String
1980
+ #
1981
+ # @overload list_destinations(params = {})
1982
+ # @param [Hash] params ({})
1983
+ def list_destinations(params = {}, options = {})
1984
+ req = build_request(:list_destinations, params)
1985
+ req.send_request(options)
1986
+ end
1987
+
1988
+ # List all event log configurations for an account.
1989
+ #
1990
+ # @option params [String] :next_token
1991
+ # A token that can be used to retrieve the next set of results.
1992
+ #
1993
+ # @option params [Integer] :max_results
1994
+ # The maximum number of results to return at one time.
1995
+ #
1996
+ # @return [Types::ListEventLogConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1997
+ #
1998
+ # * {Types::ListEventLogConfigurationsResponse#event_log_configuration_list #event_log_configuration_list} => Array&lt;Types::EventLogConfigurationSummary&gt;
1999
+ # * {Types::ListEventLogConfigurationsResponse#next_token #next_token} => String
2000
+ #
2001
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2002
+ #
2003
+ # @example Request syntax with placeholder values
2004
+ #
2005
+ # resp = client.list_event_log_configurations({
2006
+ # next_token: "NextToken",
2007
+ # max_results: 1,
2008
+ # })
2009
+ #
2010
+ # @example Response structure
2011
+ #
2012
+ # resp.event_log_configuration_list #=> Array
2013
+ # resp.event_log_configuration_list[0].id #=> String
2014
+ # resp.event_log_configuration_list[0].resource_type #=> String
2015
+ # resp.event_log_configuration_list[0].resource_id #=> String
2016
+ # resp.event_log_configuration_list[0].event_log_level #=> String, one of "DEBUG", "ERROR", "INFO", "WARN"
2017
+ # resp.next_token #=> String
2018
+ #
2019
+ # @overload list_event_log_configurations(params = {})
2020
+ # @param [Hash] params ({})
2021
+ def list_event_log_configurations(params = {}, options = {})
2022
+ req = build_request(:list_event_log_configurations, params)
2023
+ req.send_request(options)
2024
+ end
2025
+
2026
+ # List schemas associated with a managed thing.
2027
+ #
2028
+ # @option params [required, String] :identifier
2029
+ # The managed thing id.
2030
+ #
2031
+ # @option params [String] :endpoint_id_filter
2032
+ # Filter on an endpoint id.
2033
+ #
2034
+ # @option params [String] :capability_id_filter
2035
+ # Filter on a capability id.
2036
+ #
2037
+ # @option params [String] :next_token
2038
+ # A token that can be used to retrieve the next set of results.
2039
+ #
2040
+ # @option params [Integer] :max_results
2041
+ # The maximum number of results to return at one time.
2042
+ #
2043
+ # @return [Types::ListManagedThingSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2044
+ #
2045
+ # * {Types::ListManagedThingSchemasResponse#items #items} => Array&lt;Types::ManagedThingSchemaListItem&gt;
2046
+ # * {Types::ListManagedThingSchemasResponse#next_token #next_token} => String
2047
+ #
2048
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2049
+ #
2050
+ # @example Request syntax with placeholder values
2051
+ #
2052
+ # resp = client.list_managed_thing_schemas({
2053
+ # identifier: "ManagedThingId", # required
2054
+ # endpoint_id_filter: "EndpointId",
2055
+ # capability_id_filter: "CapabilityId",
2056
+ # next_token: "NextToken",
2057
+ # max_results: 1,
2058
+ # })
2059
+ #
2060
+ # @example Response structure
2061
+ #
2062
+ # resp.items #=> Array
2063
+ # resp.items[0].endpoint_id #=> String
2064
+ # resp.items[0].capability_id #=> String
2065
+ # resp.next_token #=> String
2066
+ #
2067
+ # @overload list_managed_thing_schemas(params = {})
2068
+ # @param [Hash] params ({})
2069
+ def list_managed_thing_schemas(params = {}, options = {})
2070
+ req = build_request(:list_managed_thing_schemas, params)
2071
+ req.send_request(options)
2072
+ end
2073
+
2074
+ # List all of the associations and statuses for a managed thing by its
2075
+ # owner.
2076
+ #
2077
+ # @option params [String] :owner_filter
2078
+ # Filter on device owners when listing managed things.
2079
+ #
2080
+ # @option params [String] :credential_locker_filter
2081
+ # Filter on a credential locker for a managed thing.
2082
+ #
2083
+ # @option params [String] :role_filter
2084
+ # Filter on the type of device used. This will be the Amazon Web
2085
+ # Services hub controller, cloud device, or IoT device.
2086
+ #
2087
+ # @option params [String] :parent_controller_identifier_filter
2088
+ # Filter on a parent controller id for a managed thing.
2089
+ #
2090
+ # @option params [String] :connector_policy_id_filter
2091
+ # Filter on a connector policy id for a managed thing.
2092
+ #
2093
+ # @option params [String] :serial_number_filter
2094
+ # Filter on the serial number of the device.
2095
+ #
2096
+ # @option params [String] :provisioning_status_filter
2097
+ # Filter on the status of the device.
2098
+ #
2099
+ # @option params [String] :next_token
2100
+ # A token that can be used to retrieve the next set of results.
2101
+ #
2102
+ # @option params [Integer] :max_results
2103
+ # The maximum number of results to return at one time.
2104
+ #
2105
+ # @return [Types::ListManagedThingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2106
+ #
2107
+ # * {Types::ListManagedThingsResponse#items #items} => Array&lt;Types::ManagedThingSummary&gt;
2108
+ # * {Types::ListManagedThingsResponse#next_token #next_token} => String
2109
+ #
2110
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2111
+ #
2112
+ # @example Request syntax with placeholder values
2113
+ #
2114
+ # resp = client.list_managed_things({
2115
+ # owner_filter: "Owner",
2116
+ # credential_locker_filter: "CredentialLockerId",
2117
+ # role_filter: "CONTROLLER", # accepts CONTROLLER, DEVICE
2118
+ # parent_controller_identifier_filter: "ParentControllerId",
2119
+ # connector_policy_id_filter: "ConnectorPolicyId",
2120
+ # serial_number_filter: "SerialNumber",
2121
+ # provisioning_status_filter: "UNASSOCIATED", # accepts UNASSOCIATED, PRE_ASSOCIATED, DISCOVERED, ACTIVATED, DELETION_FAILED, DELETE_IN_PROGRESS, ISOLATED, DELETED
2122
+ # next_token: "NextToken",
2123
+ # max_results: 1,
2124
+ # })
2125
+ #
2126
+ # @example Response structure
2127
+ #
2128
+ # resp.items #=> Array
2129
+ # resp.items[0].id #=> String
2130
+ # resp.items[0].arn #=> String
2131
+ # resp.items[0].advertised_product_id #=> String
2132
+ # resp.items[0].brand #=> String
2133
+ # resp.items[0].classification #=> String
2134
+ # resp.items[0].connector_device_id #=> String
2135
+ # resp.items[0].connector_policy_id #=> String
2136
+ # resp.items[0].model #=> String
2137
+ # resp.items[0].name #=> String
2138
+ # resp.items[0].owner #=> String
2139
+ # resp.items[0].credential_locker_id #=> String
2140
+ # resp.items[0].parent_controller_id #=> String
2141
+ # resp.items[0].provisioning_status #=> String, one of "UNASSOCIATED", "PRE_ASSOCIATED", "DISCOVERED", "ACTIVATED", "DELETION_FAILED", "DELETE_IN_PROGRESS", "ISOLATED", "DELETED"
2142
+ # resp.items[0].role #=> String, one of "CONTROLLER", "DEVICE"
2143
+ # resp.items[0].serial_number #=> String
2144
+ # resp.items[0].created_at #=> Time
2145
+ # resp.items[0].updated_at #=> Time
2146
+ # resp.items[0].activated_at #=> Time
2147
+ # resp.next_token #=> String
2148
+ #
2149
+ # @overload list_managed_things(params = {})
2150
+ # @param [Hash] params ({})
2151
+ def list_managed_things(params = {}, options = {})
2152
+ req = build_request(:list_managed_things, params)
2153
+ req.send_request(options)
2154
+ end
2155
+
2156
+ # List all notification configurations.
2157
+ #
2158
+ # @option params [Integer] :max_results
2159
+ # The maximum number of results to return at one time.
2160
+ #
2161
+ # @option params [String] :next_token
2162
+ # A token that can be used to retrieve the next set of results.
2163
+ #
2164
+ # @return [Types::ListNotificationConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2165
+ #
2166
+ # * {Types::ListNotificationConfigurationsResponse#notification_configuration_list #notification_configuration_list} => Array&lt;Types::NotificationConfigurationSummary&gt;
2167
+ # * {Types::ListNotificationConfigurationsResponse#next_token #next_token} => String
2168
+ #
2169
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2170
+ #
2171
+ # @example Request syntax with placeholder values
2172
+ #
2173
+ # resp = client.list_notification_configurations({
2174
+ # max_results: 1,
2175
+ # next_token: "NextToken",
2176
+ # })
2177
+ #
2178
+ # @example Response structure
2179
+ #
2180
+ # resp.notification_configuration_list #=> Array
2181
+ # resp.notification_configuration_list[0].event_type #=> String, one of "DEVICE_COMMAND", "DEVICE_COMMAND_REQUEST", "DEVICE_EVENT", "DEVICE_LIFE_CYCLE", "DEVICE_STATE", "DEVICE_OTA", "CONNECTOR_ASSOCIATION", "CONNECTOR_ERROR_REPORT"
2182
+ # resp.notification_configuration_list[0].destination_name #=> String
2183
+ # resp.next_token #=> String
2184
+ #
2185
+ # @overload list_notification_configurations(params = {})
2186
+ # @param [Hash] params ({})
2187
+ def list_notification_configurations(params = {}, options = {})
2188
+ req = build_request(:list_notification_configurations, params)
2189
+ req.send_request(options)
2190
+ end
2191
+
2192
+ # List all of the over-the-air (OTA) task configurations.
2193
+ #
2194
+ # @option params [String] :next_token
2195
+ # A token that can be used to retrieve the next set of results.
2196
+ #
2197
+ # @option params [Integer] :max_results
2198
+ # The maximum number of results to return at one time.
2199
+ #
2200
+ # @return [Types::ListOtaTaskConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2201
+ #
2202
+ # * {Types::ListOtaTaskConfigurationsResponse#items #items} => Array&lt;Types::OtaTaskConfigurationSummary&gt;
2203
+ # * {Types::ListOtaTaskConfigurationsResponse#next_token #next_token} => String
2204
+ #
2205
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2206
+ #
2207
+ # @example Request syntax with placeholder values
2208
+ #
2209
+ # resp = client.list_ota_task_configurations({
2210
+ # next_token: "NextToken",
2211
+ # max_results: 1,
2212
+ # })
2213
+ #
2214
+ # @example Response structure
2215
+ #
2216
+ # resp.items #=> Array
2217
+ # resp.items[0].task_configuration_id #=> String
2218
+ # resp.items[0].name #=> String
2219
+ # resp.items[0].created_at #=> Time
2220
+ # resp.next_token #=> String
2221
+ #
2222
+ # @overload list_ota_task_configurations(params = {})
2223
+ # @param [Hash] params ({})
2224
+ def list_ota_task_configurations(params = {}, options = {})
2225
+ req = build_request(:list_ota_task_configurations, params)
2226
+ req.send_request(options)
2227
+ end
2228
+
2229
+ # List all of the over-the-air (OTA) task executions.
2230
+ #
2231
+ # @option params [required, String] :identifier
2232
+ # The over-the-air (OTA) task id.
2233
+ #
2234
+ # @option params [String] :next_token
2235
+ # A token that can be used to retrieve the next set of results.
2236
+ #
2237
+ # @option params [Integer] :max_results
2238
+ # The maximum number of results to return at one time.
2239
+ #
2240
+ # @return [Types::ListOtaTaskExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2241
+ #
2242
+ # * {Types::ListOtaTaskExecutionsResponse#execution_summaries #execution_summaries} => Array&lt;Types::OtaTaskExecutionSummaries&gt;
2243
+ # * {Types::ListOtaTaskExecutionsResponse#next_token #next_token} => String
2244
+ #
2245
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2246
+ #
2247
+ # @example Request syntax with placeholder values
2248
+ #
2249
+ # resp = client.list_ota_task_executions({
2250
+ # identifier: "OtaTaskId", # required
2251
+ # next_token: "OtaNextToken",
2252
+ # max_results: 1,
2253
+ # })
2254
+ #
2255
+ # @example Response structure
2256
+ #
2257
+ # resp.execution_summaries #=> Array
2258
+ # resp.execution_summaries[0].task_execution_summary.execution_number #=> Integer
2259
+ # resp.execution_summaries[0].task_execution_summary.last_updated_at #=> Time
2260
+ # resp.execution_summaries[0].task_execution_summary.queued_at #=> Time
2261
+ # resp.execution_summaries[0].task_execution_summary.retry_attempt #=> Integer
2262
+ # resp.execution_summaries[0].task_execution_summary.started_at #=> Time
2263
+ # resp.execution_summaries[0].task_execution_summary.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "REJECTED", "REMOVED", "CANCELED"
2264
+ # resp.execution_summaries[0].managed_thing_id #=> String
2265
+ # resp.next_token #=> String
2266
+ #
2267
+ # @overload list_ota_task_executions(params = {})
2268
+ # @param [Hash] params ({})
2269
+ def list_ota_task_executions(params = {}, options = {})
2270
+ req = build_request(:list_ota_task_executions, params)
2271
+ req.send_request(options)
2272
+ end
2273
+
2274
+ # List all of the over-the-air (OTA) tasks.
2275
+ #
2276
+ # @option params [String] :next_token
2277
+ # A token that can be used to retrieve the next set of results.
2278
+ #
2279
+ # @option params [Integer] :max_results
2280
+ # The maximum number of results to return at one time.
2281
+ #
2282
+ # @return [Types::ListOtaTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2283
+ #
2284
+ # * {Types::ListOtaTasksResponse#tasks #tasks} => Array&lt;Types::OtaTaskSummary&gt;
2285
+ # * {Types::ListOtaTasksResponse#next_token #next_token} => String
2286
+ #
2287
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2288
+ #
2289
+ # @example Request syntax with placeholder values
2290
+ #
2291
+ # resp = client.list_ota_tasks({
2292
+ # next_token: "OtaNextToken",
2293
+ # max_results: 1,
2294
+ # })
2295
+ #
2296
+ # @example Response structure
2297
+ #
2298
+ # resp.tasks #=> Array
2299
+ # resp.tasks[0].task_id #=> String
2300
+ # resp.tasks[0].task_arn #=> String
2301
+ # resp.tasks[0].created_at #=> Time
2302
+ # resp.tasks[0].last_updated_at #=> Time
2303
+ # resp.tasks[0].task_configuration_id #=> String
2304
+ # resp.tasks[0].status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS", "SCHEDULED"
2305
+ # resp.next_token #=> String
2306
+ #
2307
+ # @overload list_ota_tasks(params = {})
2308
+ # @param [Hash] params ({})
2309
+ def list_ota_tasks(params = {}, options = {})
2310
+ req = build_request(:list_ota_tasks, params)
2311
+ req.send_request(options)
2312
+ end
2313
+
2314
+ # List the provisioning profiles within the Amazon Web Services account.
2315
+ #
2316
+ # @option params [String] :next_token
2317
+ # A token that can be used to retrieve the next set of results.
2318
+ #
2319
+ # @option params [Integer] :max_results
2320
+ # The maximum number of results to return at one time.
2321
+ #
2322
+ # @return [Types::ListProvisioningProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2323
+ #
2324
+ # * {Types::ListProvisioningProfilesResponse#items #items} => Array&lt;Types::ProvisioningProfileSummary&gt;
2325
+ # * {Types::ListProvisioningProfilesResponse#next_token #next_token} => String
2326
+ #
2327
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2328
+ #
2329
+ # @example Request syntax with placeholder values
2330
+ #
2331
+ # resp = client.list_provisioning_profiles({
2332
+ # next_token: "NextToken",
2333
+ # max_results: 1,
2334
+ # })
2335
+ #
2336
+ # @example Response structure
2337
+ #
2338
+ # resp.items #=> Array
2339
+ # resp.items[0].name #=> String
2340
+ # resp.items[0].id #=> String
2341
+ # resp.items[0].arn #=> String
2342
+ # resp.items[0].provisioning_type #=> String, one of "FLEET_PROVISIONING", "JITR"
2343
+ # resp.next_token #=> String
2344
+ #
2345
+ # @overload list_provisioning_profiles(params = {})
2346
+ # @param [Hash] params ({})
2347
+ def list_provisioning_profiles(params = {}, options = {})
2348
+ req = build_request(:list_provisioning_profiles, params)
2349
+ req.send_request(options)
2350
+ end
2351
+
2352
+ # Lists schema versions with the provided information.
2353
+ #
2354
+ # @option params [required, String] :type
2355
+ # Filter on the type of schema version.
2356
+ #
2357
+ # @option params [Integer] :max_results
2358
+ # The maximum number of results to return at one time.
2359
+ #
2360
+ # @option params [String] :next_token
2361
+ # A token that can be used to retrieve the next set of results.
2362
+ #
2363
+ # @option params [String] :schema_id
2364
+ # Filter on the id of the schema version.
2365
+ #
2366
+ # @option params [String] :namespace
2367
+ # Filter on the name of the schema version.
2368
+ #
2369
+ # @option params [String] :visibility
2370
+ # The visibility of the schema version.
2371
+ #
2372
+ # @option params [String] :semantic_version
2373
+ # The schema version. If this is left blank, it defaults to the latest
2374
+ # version.
2375
+ #
2376
+ # @return [Types::ListSchemaVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2377
+ #
2378
+ # * {Types::ListSchemaVersionsResponse#items #items} => Array&lt;Types::SchemaVersionListItem&gt;
2379
+ # * {Types::ListSchemaVersionsResponse#next_token #next_token} => String
2380
+ #
2381
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2382
+ #
2383
+ #
2384
+ # @example Example: ListSchemaVersions happy path for an example schema version.
2385
+ #
2386
+ # resp = client.list_schema_versions({
2387
+ # schema_id: "matter.ColorControl",
2388
+ # type: "capability",
2389
+ # })
2390
+ #
2391
+ # resp.to_h outputs the following:
2392
+ # {
2393
+ # items: [
2394
+ # {
2395
+ # description: "The Color Control cluster defined as Harmony Capability.",
2396
+ # namespace: "matter",
2397
+ # schema_id: "matter.ColorControl",
2398
+ # semantic_version: "1.3",
2399
+ # type: "capability",
2400
+ # },
2401
+ # ],
2402
+ # }
2403
+ #
2404
+ # @example Example: ListSchemaVersions by version.
2405
+ #
2406
+ # resp = client.list_schema_versions({
2407
+ # semantic_version: "34.56",
2408
+ # type: "capability",
2409
+ # })
2410
+ #
2411
+ # resp.to_h outputs the following:
2412
+ # {
2413
+ # items: [
2414
+ # {
2415
+ # description: "The Color Control cluster defined as Harmony Capability.",
2416
+ # namespace: "matter",
2417
+ # schema_id: "matter.ColorControl",
2418
+ # semantic_version: "1.3",
2419
+ # type: "capability",
2420
+ # },
2421
+ # ],
2422
+ # }
2423
+ #
2424
+ # @example Example: ListSchemaVersions error for invalid input.
2425
+ #
2426
+ # resp = client.list_schema_versions({
2427
+ # namespace: "matter",
2428
+ # schema_id: "matter.ColorControl",
2429
+ # type: "capability",
2430
+ # })
2431
+ #
2432
+ # @example Request syntax with placeholder values
2433
+ #
2434
+ # resp = client.list_schema_versions({
2435
+ # type: "capability", # required, accepts capability, definition
2436
+ # max_results: 1,
2437
+ # next_token: "NextToken",
2438
+ # schema_id: "SchemaId",
2439
+ # namespace: "SchemaVersionNamespaceName",
2440
+ # visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
2441
+ # semantic_version: "SchemaVersionVersion",
2442
+ # })
2443
+ #
2444
+ # @example Response structure
2445
+ #
2446
+ # resp.items #=> Array
2447
+ # resp.items[0].schema_id #=> String
2448
+ # resp.items[0].type #=> String, one of "capability", "definition"
2449
+ # resp.items[0].description #=> String
2450
+ # resp.items[0].namespace #=> String
2451
+ # resp.items[0].semantic_version #=> String
2452
+ # resp.items[0].visibility #=> String, one of "PUBLIC", "PRIVATE"
2453
+ # resp.next_token #=> String
2454
+ #
2455
+ # @overload list_schema_versions(params = {})
2456
+ # @param [Hash] params ({})
2457
+ def list_schema_versions(params = {}, options = {})
2458
+ req = build_request(:list_schema_versions, params)
2459
+ req.send_request(options)
2460
+ end
2461
+
2462
+ # Sets the default encryption configuration for the Amazon Web Services
2463
+ # account. For more information, see [Key management][1] in the AWS IoT
2464
+ # SiteWise User Guide.
2465
+ #
2466
+ #
2467
+ #
2468
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
2469
+ #
2470
+ # @option params [required, String] :encryption_type
2471
+ # The type of encryption used for the encryption configuration.
2472
+ #
2473
+ # @option params [String] :kms_key_arn
2474
+ # The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS
2475
+ # encryption if you use `KMS_BASED_ENCRYPTION`.
2476
+ #
2477
+ # @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2478
+ #
2479
+ # * {Types::PutDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
2480
+ # * {Types::PutDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
2481
+ # * {Types::PutDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
2482
+ #
2483
+ # @example Request syntax with placeholder values
2484
+ #
2485
+ # resp = client.put_default_encryption_configuration({
2486
+ # encryption_type: "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION", # required, accepts MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION, CUSTOMER_KEY_ENCRYPTION
2487
+ # kms_key_arn: "KmsKeyArn",
2488
+ # })
2489
+ #
2490
+ # @example Response structure
2491
+ #
2492
+ # resp.configuration_status.error.code #=> String
2493
+ # resp.configuration_status.error.message #=> String
2494
+ # resp.configuration_status.state #=> String, one of "ENABLED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
2495
+ # resp.encryption_type #=> String, one of "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION", "CUSTOMER_KEY_ENCRYPTION"
2496
+ # resp.kms_key_arn #=> String
2497
+ #
2498
+ # @overload put_default_encryption_configuration(params = {})
2499
+ # @param [Hash] params ({})
2500
+ def put_default_encryption_configuration(params = {}, options = {})
2501
+ req = build_request(:put_default_encryption_configuration, params)
2502
+ req.send_request(options)
2503
+ end
2504
+
2505
+ # Update a hub configuration.
2506
+ #
2507
+ # @option params [required, Integer] :hub_token_timer_expiry_setting_in_seconds
2508
+ # A user-defined integer value that represents the hub token timer
2509
+ # expiry setting in seconds.
2510
+ #
2511
+ # @return [Types::PutHubConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2512
+ #
2513
+ # * {Types::PutHubConfigurationResponse#hub_token_timer_expiry_setting_in_seconds #hub_token_timer_expiry_setting_in_seconds} => Integer
2514
+ #
2515
+ # @example Request syntax with placeholder values
2516
+ #
2517
+ # resp = client.put_hub_configuration({
2518
+ # hub_token_timer_expiry_setting_in_seconds: 1, # required
2519
+ # })
2520
+ #
2521
+ # @example Response structure
2522
+ #
2523
+ # resp.hub_token_timer_expiry_setting_in_seconds #=> Integer
2524
+ #
2525
+ # @overload put_hub_configuration(params = {})
2526
+ # @param [Hash] params ({})
2527
+ def put_hub_configuration(params = {}, options = {})
2528
+ req = build_request(:put_hub_configuration, params)
2529
+ req.send_request(options)
2530
+ end
2531
+
2532
+ # Set the runtime log configuration for a specific managed thing or for
2533
+ # all managed things as a group.
2534
+ #
2535
+ # @option params [required, String] :managed_thing_id
2536
+ # The id for a managed thing.
2537
+ #
2538
+ # @option params [required, Types::RuntimeLogConfigurations] :runtime_log_configurations
2539
+ # The runtime log configuration for a managed thing.
2540
+ #
2541
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2542
+ #
2543
+ # @example Request syntax with placeholder values
2544
+ #
2545
+ # resp = client.put_runtime_log_configuration({
2546
+ # managed_thing_id: "ManagedThingId", # required
2547
+ # runtime_log_configurations: { # required
2548
+ # log_level: "DEBUG", # accepts DEBUG, ERROR, INFO, WARN
2549
+ # log_flush_level: "DEBUG", # accepts DEBUG, ERROR, INFO, WARN
2550
+ # local_store_location: "LocalStoreLocation",
2551
+ # local_store_file_rotation_max_files: 1,
2552
+ # local_store_file_rotation_max_bytes: 1,
2553
+ # upload_log: false,
2554
+ # upload_period_minutes: 1,
2555
+ # delete_local_store_after_upload: false,
2556
+ # },
2557
+ # })
2558
+ #
2559
+ # @overload put_runtime_log_configuration(params = {})
2560
+ # @param [Hash] params ({})
2561
+ def put_runtime_log_configuration(params = {}, options = {})
2562
+ req = build_request(:put_runtime_log_configuration, params)
2563
+ req.send_request(options)
2564
+ end
2565
+
2566
+ # Customers can request IoT managed integrations to manage the server
2567
+ # trust for them or bring their own external server trusts for the
2568
+ # custom domain. Returns an IoT managed integrations endpoint.
2569
+ #
2570
+ # @return [Types::RegisterCustomEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2571
+ #
2572
+ # * {Types::RegisterCustomEndpointResponse#endpoint_address #endpoint_address} => String
2573
+ #
2574
+ # @example Response structure
2575
+ #
2576
+ # resp.endpoint_address #=> String
2577
+ #
2578
+ # @overload register_custom_endpoint(params = {})
2579
+ # @param [Hash] params ({})
2580
+ def register_custom_endpoint(params = {}, options = {})
2581
+ req = build_request(:register_custom_endpoint, params)
2582
+ req.send_request(options)
2583
+ end
2584
+
2585
+ # Reset a runtime log configuration for a specific managed thing or for
2586
+ # all managed things as a group.
2587
+ #
2588
+ # @option params [required, String] :managed_thing_id
2589
+ # The id of a managed thing.
2590
+ #
2591
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2592
+ #
2593
+ # @example Request syntax with placeholder values
2594
+ #
2595
+ # resp = client.reset_runtime_log_configuration({
2596
+ # managed_thing_id: "ManagedThingId", # required
2597
+ # })
2598
+ #
2599
+ # @overload reset_runtime_log_configuration(params = {})
2600
+ # @param [Hash] params ({})
2601
+ def reset_runtime_log_configuration(params = {}, options = {})
2602
+ req = build_request(:reset_runtime_log_configuration, params)
2603
+ req.send_request(options)
2604
+ end
2605
+
2606
+ # Send the command to the device represented by the managed thing.
2607
+ #
2608
+ # @option params [required, String] :managed_thing_id
2609
+ # The id of the device.
2610
+ #
2611
+ # @option params [required, Array<Types::CommandEndpoint>] :endpoints
2612
+ # The device endpoint.
2613
+ #
2614
+ # @option params [String] :connector_association_id
2615
+ # The ID tracking the current discovery process for one connector
2616
+ # association.
2617
+ #
2618
+ # @return [Types::SendManagedThingCommandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2619
+ #
2620
+ # * {Types::SendManagedThingCommandResponse#trace_id #trace_id} => String
2621
+ #
2622
+ # @example Request syntax with placeholder values
2623
+ #
2624
+ # resp = client.send_managed_thing_command({
2625
+ # managed_thing_id: "ManagedThingId", # required
2626
+ # endpoints: [ # required
2627
+ # {
2628
+ # endpoint_id: "EndpointId", # required
2629
+ # capabilities: [ # required
2630
+ # {
2631
+ # id: "SchemaVersionedId", # required
2632
+ # name: "CapabilityName", # required
2633
+ # version: "CapabilityVersion", # required
2634
+ # actions: [ # required
2635
+ # {
2636
+ # name: "CapabilityActionName", # required
2637
+ # ref: "ActionReference",
2638
+ # action_trace_id: "ActionTraceId",
2639
+ # parameters: {
2640
+ # },
2641
+ # },
2642
+ # ],
2643
+ # },
2644
+ # ],
2645
+ # },
2646
+ # ],
2647
+ # connector_association_id: "ConnectorAssociationId",
2648
+ # })
2649
+ #
2650
+ # @example Response structure
2651
+ #
2652
+ # resp.trace_id #=> String
2653
+ #
2654
+ # @overload send_managed_thing_command(params = {})
2655
+ # @param [Hash] params ({})
2656
+ def send_managed_thing_command(params = {}, options = {})
2657
+ req = build_request(:send_managed_thing_command, params)
2658
+ req.send_request(options)
2659
+ end
2660
+
2661
+ # During user-guided setup, this is used to start device discovery. The
2662
+ # authentication material (install code) is passed as a message to the
2663
+ # controller telling it to start the discovery.
2664
+ #
2665
+ # @option params [required, String] :discovery_type
2666
+ # The discovery type supporting the type of device to be discovered in
2667
+ # the device discovery job request.
2668
+ #
2669
+ # @option params [String] :controller_identifier
2670
+ # The id of the end-user's IoT hub.
2671
+ #
2672
+ # @option params [String] :connector_association_identifier
2673
+ # The id of the connector association.
2674
+ #
2675
+ # @option params [String] :authentication_material
2676
+ # The authentication material required to start the local device
2677
+ # discovery job request.
2678
+ #
2679
+ # @option params [String] :authentication_material_type
2680
+ # The type of authentication material used for device discovery jobs.
2681
+ #
2682
+ # @option params [String] :client_token
2683
+ # An idempotency token. If you retry a request that completed
2684
+ # successfully initially using the same client token and parameters,
2685
+ # then the retry attempt will succeed without performing any further
2686
+ # actions.
2687
+ #
2688
+ # @option params [Hash<String,String>] :tags
2689
+ # A set of key/value pairs that are used to manage the device discovery
2690
+ # request.
2691
+ #
2692
+ # @return [Types::StartDeviceDiscoveryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2693
+ #
2694
+ # * {Types::StartDeviceDiscoveryResponse#id #id} => String
2695
+ # * {Types::StartDeviceDiscoveryResponse#started_at #started_at} => Time
2696
+ #
2697
+ # @example Request syntax with placeholder values
2698
+ #
2699
+ # resp = client.start_device_discovery({
2700
+ # discovery_type: "ZWAVE", # required, accepts ZWAVE, ZIGBEE, CLOUD
2701
+ # controller_identifier: "ManagedThingId",
2702
+ # connector_association_identifier: "ConnectorAssociationId",
2703
+ # authentication_material: "DiscoveryAuthMaterialString",
2704
+ # authentication_material_type: "ZWAVE_INSTALL_CODE", # accepts ZWAVE_INSTALL_CODE
2705
+ # client_token: "ClientToken",
2706
+ # tags: {
2707
+ # "TagKey" => "TagValue",
2708
+ # },
2709
+ # })
2710
+ #
2711
+ # @example Response structure
2712
+ #
2713
+ # resp.id #=> String
2714
+ # resp.started_at #=> Time
2715
+ #
2716
+ # @overload start_device_discovery(params = {})
2717
+ # @param [Hash] params ({})
2718
+ def start_device_discovery(params = {}, options = {})
2719
+ req = build_request(:start_device_discovery, params)
2720
+ req.send_request(options)
2721
+ end
2722
+
2723
+ # Update a destination specified by id.
2724
+ #
2725
+ # @option params [required, String] :name
2726
+ # The name of the customer-managed destination.
2727
+ #
2728
+ # @option params [String] :delivery_destination_arn
2729
+ # The Amazon Resource Name (ARN) of the customer-managed destination.
2730
+ #
2731
+ # @option params [String] :delivery_destination_type
2732
+ # The destination type for the customer-managed destination.
2733
+ #
2734
+ # @option params [String] :role_arn
2735
+ # The Amazon Resource Name (ARN) of the delivery destination role.
2736
+ #
2737
+ # @option params [String] :description
2738
+ # The description of the customer-managed destination.
2739
+ #
2740
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2741
+ #
2742
+ # @example Request syntax with placeholder values
2743
+ #
2744
+ # resp = client.update_destination({
2745
+ # name: "DestinationName", # required
2746
+ # delivery_destination_arn: "DeliveryDestinationArn",
2747
+ # delivery_destination_type: "KINESIS", # accepts KINESIS
2748
+ # role_arn: "DeliveryDestinationRoleArn",
2749
+ # description: "DestinationDescription",
2750
+ # })
2751
+ #
2752
+ # @overload update_destination(params = {})
2753
+ # @param [Hash] params ({})
2754
+ def update_destination(params = {}, options = {})
2755
+ req = build_request(:update_destination, params)
2756
+ req.send_request(options)
2757
+ end
2758
+
2759
+ # Update an event log configuration by log configuration ID.
2760
+ #
2761
+ # @option params [required, String] :id
2762
+ # The log configuration id.
2763
+ #
2764
+ # @option params [required, String] :event_log_level
2765
+ # The log level for the event in terms of severity.
2766
+ #
2767
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2768
+ #
2769
+ # @example Request syntax with placeholder values
2770
+ #
2771
+ # resp = client.update_event_log_configuration({
2772
+ # id: "LogConfigurationId", # required
2773
+ # event_log_level: "DEBUG", # required, accepts DEBUG, ERROR, INFO, WARN
2774
+ # })
2775
+ #
2776
+ # @overload update_event_log_configuration(params = {})
2777
+ # @param [Hash] params ({})
2778
+ def update_event_log_configuration(params = {}, options = {})
2779
+ req = build_request(:update_event_log_configuration, params)
2780
+ req.send_request(options)
2781
+ end
2782
+
2783
+ # Update the attributes and capabilities associated with a managed
2784
+ # thing.
2785
+ #
2786
+ # @option params [required, String] :identifier
2787
+ # The id of the managed thing.
2788
+ #
2789
+ # @option params [String] :owner
2790
+ # Owner of the device, usually an indication of whom the device belongs
2791
+ # to. This value should not contain personal identifiable information.
2792
+ #
2793
+ # @option params [String] :credential_locker_id
2794
+ # The identifier of the credential for the managed thing.
2795
+ #
2796
+ # @option params [String] :serial_number
2797
+ # The serial number of the device.
2798
+ #
2799
+ # @option params [String] :brand
2800
+ # The brand of the device.
2801
+ #
2802
+ # @option params [String] :model
2803
+ # The model of the device.
2804
+ #
2805
+ # @option params [String] :name
2806
+ # The name of the managed thing representing the physical device.
2807
+ #
2808
+ # @option params [Types::CapabilityReport] :capability_report
2809
+ # A report of the capabilities for the managed thing.
2810
+ #
2811
+ # @option params [String] :capabilities
2812
+ # The capabilities of the device such as light bulb.
2813
+ #
2814
+ # @option params [String] :classification
2815
+ # The classification of the managed thing such as light bulb or
2816
+ # thermostat.
2817
+ #
2818
+ # @option params [String] :hub_network_mode
2819
+ # The network mode for the hub-connected device.
2820
+ #
2821
+ # @option params [Hash<String,String>] :meta_data
2822
+ # The metadata for the managed thing.
2823
+ #
2824
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2825
+ #
2826
+ # @example Request syntax with placeholder values
2827
+ #
2828
+ # resp = client.update_managed_thing({
2829
+ # identifier: "ManagedThingId", # required
2830
+ # owner: "Owner",
2831
+ # credential_locker_id: "CredentialLockerId",
2832
+ # serial_number: "SerialNumber",
2833
+ # brand: "Brand",
2834
+ # model: "Model",
2835
+ # name: "Name",
2836
+ # capability_report: {
2837
+ # version: "CapabilityReportVersion", # required
2838
+ # node_id: "NodeId",
2839
+ # endpoints: [ # required
2840
+ # {
2841
+ # id: "EndpointId", # required
2842
+ # device_types: ["DeviceType"], # required
2843
+ # capabilities: [ # required
2844
+ # {
2845
+ # id: "SchemaVersionedId", # required
2846
+ # name: "CapabilityName", # required
2847
+ # version: "CapabilityVersion", # required
2848
+ # properties: ["PropertyName"], # required
2849
+ # actions: ["ActionName"], # required
2850
+ # events: ["EventName"], # required
2851
+ # },
2852
+ # ],
2853
+ # },
2854
+ # ],
2855
+ # },
2856
+ # capabilities: "Capabilities",
2857
+ # classification: "Classification",
2858
+ # hub_network_mode: "STANDARD", # accepts STANDARD, NETWORK_WIDE_EXCLUSION
2859
+ # meta_data: {
2860
+ # "AttributeName" => "AttributeValue",
2861
+ # },
2862
+ # })
2863
+ #
2864
+ # @overload update_managed_thing(params = {})
2865
+ # @param [Hash] params ({})
2866
+ def update_managed_thing(params = {}, options = {})
2867
+ req = build_request(:update_managed_thing, params)
2868
+ req.send_request(options)
2869
+ end
2870
+
2871
+ # Update a notification configuration.
2872
+ #
2873
+ # @option params [required, String] :event_type
2874
+ # The type of event triggering a device notification to the
2875
+ # customer-managed destination.
2876
+ #
2877
+ # @option params [required, String] :destination_name
2878
+ # The name of the destination for the notification configuration.
2879
+ #
2880
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2881
+ #
2882
+ # @example Request syntax with placeholder values
2883
+ #
2884
+ # resp = client.update_notification_configuration({
2885
+ # event_type: "DEVICE_COMMAND", # required, accepts DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, CONNECTOR_ASSOCIATION, CONNECTOR_ERROR_REPORT
2886
+ # destination_name: "DestinationName", # required
2887
+ # })
2888
+ #
2889
+ # @overload update_notification_configuration(params = {})
2890
+ # @param [Hash] params ({})
2891
+ def update_notification_configuration(params = {}, options = {})
2892
+ req = build_request(:update_notification_configuration, params)
2893
+ req.send_request(options)
2894
+ end
2895
+
2896
+ # Update an over-the-air (OTA) task.
2897
+ #
2898
+ # @option params [required, String] :identifier
2899
+ # The over-the-air (OTA) task id.
2900
+ #
2901
+ # @option params [String] :description
2902
+ # The description of the over-the-air (OTA) task.
2903
+ #
2904
+ # @option params [String] :task_configuration_id
2905
+ # The identifier for the over-the-air (OTA) task configuration.
2906
+ #
2907
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2908
+ #
2909
+ # @example Request syntax with placeholder values
2910
+ #
2911
+ # resp = client.update_ota_task({
2912
+ # identifier: "OtaTaskId", # required
2913
+ # description: "OtaDescription",
2914
+ # task_configuration_id: "OtaTaskConfigurationId",
2915
+ # })
2916
+ #
2917
+ # @overload update_ota_task(params = {})
2918
+ # @param [Hash] params ({})
2919
+ def update_ota_task(params = {}, options = {})
2920
+ req = build_request(:update_ota_task, params)
2921
+ req.send_request(options)
2922
+ end
2923
+
2924
+ # @!endgroup
2925
+
2926
+ # @param params ({})
2927
+ # @api private
2928
+ def build_request(operation_name, params = {})
2929
+ handlers = @handlers.for(operation_name)
2930
+ tracer = config.telemetry_provider.tracer_provider.tracer(
2931
+ Aws::Telemetry.module_to_tracer_name('Aws::IoTManagedIntegrations')
2932
+ )
2933
+ context = Seahorse::Client::RequestContext.new(
2934
+ operation_name: operation_name,
2935
+ operation: config.api.operation(operation_name),
2936
+ client: self,
2937
+ params: params,
2938
+ config: config,
2939
+ tracer: tracer
2940
+ )
2941
+ context[:gem_name] = 'aws-sdk-iotmanagedintegrations'
2942
+ context[:gem_version] = '1.0.0'
2943
+ Seahorse::Client::Request.new(handlers, context)
2944
+ end
2945
+
2946
+ # @api private
2947
+ # @deprecated
2948
+ def waiter_names
2949
+ []
2950
+ end
2951
+
2952
+ class << self
2953
+
2954
+ # @api private
2955
+ attr_reader :identifier
2956
+
2957
+ # @api private
2958
+ def errors_module
2959
+ Errors
2960
+ end
2961
+
2962
+ end
2963
+ end
2964
+ end