aws-sdk-iotfleethub 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,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 84c373172c42e6d2e951f397b8d9d1838716f16f2f2db07ad793bc0d51e240e3
4
+ data.tar.gz: f5301a317eb9169003b43a44f70ea3b727bea59c0a41eefb7fceb98e0b451981
5
+ SHA512:
6
+ metadata.gz: d1933a97795f719db7e4092a5ee05a5f35d12854dc6b677fdc82cb9183a9dd5c00b15dbd9f7a1780ce1d64f67ad26c50643b6cce7580527453c131d8b79d0f9d
7
+ data.tar.gz: 74905fdbdeaed1e62a54d2536bf35051201004a746947df996cbb8c1a7969ffbb46c565bba9dd9fc74543dd72911c3686436da62c8c143dc41978c3c8436e78e
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-iotfleethub/types'
15
+ require_relative 'aws-sdk-iotfleethub/client_api'
16
+ require_relative 'aws-sdk-iotfleethub/client'
17
+ require_relative 'aws-sdk-iotfleethub/errors'
18
+ require_relative 'aws-sdk-iotfleethub/resource'
19
+ require_relative 'aws-sdk-iotfleethub/customizations'
20
+
21
+ # This module provides support for AWS IoT Fleet Hub. This module is available in the
22
+ # `aws-sdk-iotfleethub` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # io_t_fleet_hub = Aws::IoTFleetHub::Client.new
31
+ # resp = io_t_fleet_hub.create_application(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from AWS IoT Fleet Hub are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::IoTFleetHub::Errors::ServiceError
43
+ # # rescues all AWS IoT Fleet Hub API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::IoTFleetHub
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,696 @@
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/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:iotfleethub)
34
+
35
+ module Aws::IoTFleetHub
36
+ # An API client for IoTFleetHub. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::IoTFleetHub::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :iotfleethub
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Creates a Fleet Hub for AWS IoT Device Management web application.
331
+ #
332
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
333
+ # subject to change.
334
+ #
335
+ # </note>
336
+ #
337
+ # @option params [required, String] :application_name
338
+ # The name of the web application.
339
+ #
340
+ # @option params [String] :application_description
341
+ # An optional description of the web application.
342
+ #
343
+ # @option params [String] :client_token
344
+ # A unique case-sensitive identifier that you can provide to ensure the
345
+ # idempotency of the request. Don't reuse this client token if a new
346
+ # idempotent request is required.
347
+ #
348
+ # **A suitable default value is auto-generated.** You should normally
349
+ # not need to pass this option.**
350
+ #
351
+ # @option params [required, String] :role_arn
352
+ # The ARN of the role that the web application assumes when it interacts
353
+ # with AWS IoT Core.
354
+ #
355
+ # <note markdown="1"> The name of the role must be in the form `AWSIotFleetHub_random_string
356
+ # `.
357
+ #
358
+ # </note>
359
+ #
360
+ # @option params [Hash<String,String>] :tags
361
+ # A set of key/value pairs that you can use to manage the web
362
+ # application resource.
363
+ #
364
+ # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
365
+ #
366
+ # * {Types::CreateApplicationResponse#application_id #application_id} => String
367
+ # * {Types::CreateApplicationResponse#application_arn #application_arn} => String
368
+ #
369
+ # @example Request syntax with placeholder values
370
+ #
371
+ # resp = client.create_application({
372
+ # application_name: "Name", # required
373
+ # application_description: "Description",
374
+ # client_token: "ClientRequestToken",
375
+ # role_arn: "Arn", # required
376
+ # tags: {
377
+ # "TagKey" => "TagValue",
378
+ # },
379
+ # })
380
+ #
381
+ # @example Response structure
382
+ #
383
+ # resp.application_id #=> String
384
+ # resp.application_arn #=> String
385
+ #
386
+ # @overload create_application(params = {})
387
+ # @param [Hash] params ({})
388
+ def create_application(params = {}, options = {})
389
+ req = build_request(:create_application, params)
390
+ req.send_request(options)
391
+ end
392
+
393
+ # Deletes a Fleet Hub for AWS IoT Device Management web application.
394
+ #
395
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
396
+ # subject to change.
397
+ #
398
+ # </note>
399
+ #
400
+ # @option params [required, String] :application_id
401
+ # The unique Id of the web application.
402
+ #
403
+ # @option params [String] :client_token
404
+ # A unique case-sensitive identifier that you can provide to ensure the
405
+ # idempotency of the request. Don't reuse this client token if a new
406
+ # idempotent request is required.
407
+ #
408
+ # **A suitable default value is auto-generated.** You should normally
409
+ # not need to pass this option.**
410
+ #
411
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
412
+ #
413
+ # @example Request syntax with placeholder values
414
+ #
415
+ # resp = client.delete_application({
416
+ # application_id: "Id", # required
417
+ # client_token: "ClientRequestToken",
418
+ # })
419
+ #
420
+ # @overload delete_application(params = {})
421
+ # @param [Hash] params ({})
422
+ def delete_application(params = {}, options = {})
423
+ req = build_request(:delete_application, params)
424
+ req.send_request(options)
425
+ end
426
+
427
+ # Gets information about a Fleet Hub for AWS IoT Device Management web
428
+ # application.
429
+ #
430
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
431
+ # subject to change.
432
+ #
433
+ # </note>
434
+ #
435
+ # @option params [required, String] :application_id
436
+ # The unique Id of the web application.
437
+ #
438
+ # @return [Types::DescribeApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
439
+ #
440
+ # * {Types::DescribeApplicationResponse#application_id #application_id} => String
441
+ # * {Types::DescribeApplicationResponse#application_arn #application_arn} => String
442
+ # * {Types::DescribeApplicationResponse#application_name #application_name} => String
443
+ # * {Types::DescribeApplicationResponse#application_description #application_description} => String
444
+ # * {Types::DescribeApplicationResponse#application_url #application_url} => String
445
+ # * {Types::DescribeApplicationResponse#application_state #application_state} => String
446
+ # * {Types::DescribeApplicationResponse#application_creation_date #application_creation_date} => Integer
447
+ # * {Types::DescribeApplicationResponse#application_last_update_date #application_last_update_date} => Integer
448
+ # * {Types::DescribeApplicationResponse#role_arn #role_arn} => String
449
+ # * {Types::DescribeApplicationResponse#sso_client_id #sso_client_id} => String
450
+ # * {Types::DescribeApplicationResponse#error_message #error_message} => String
451
+ # * {Types::DescribeApplicationResponse#tags #tags} => Hash&lt;String,String&gt;
452
+ #
453
+ # @example Request syntax with placeholder values
454
+ #
455
+ # resp = client.describe_application({
456
+ # application_id: "Id", # required
457
+ # })
458
+ #
459
+ # @example Response structure
460
+ #
461
+ # resp.application_id #=> String
462
+ # resp.application_arn #=> String
463
+ # resp.application_name #=> String
464
+ # resp.application_description #=> String
465
+ # resp.application_url #=> String
466
+ # resp.application_state #=> String, one of "CREATING", "DELETING", "ACTIVE", "CREATE_FAILED", "DELETE_FAILED"
467
+ # resp.application_creation_date #=> Integer
468
+ # resp.application_last_update_date #=> Integer
469
+ # resp.role_arn #=> String
470
+ # resp.sso_client_id #=> String
471
+ # resp.error_message #=> String
472
+ # resp.tags #=> Hash
473
+ # resp.tags["TagKey"] #=> String
474
+ #
475
+ # @overload describe_application(params = {})
476
+ # @param [Hash] params ({})
477
+ def describe_application(params = {}, options = {})
478
+ req = build_request(:describe_application, params)
479
+ req.send_request(options)
480
+ end
481
+
482
+ # Gets a list of Fleet Hub for AWS IoT Device Management web
483
+ # applications for the current account.
484
+ #
485
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
486
+ # subject to change.
487
+ #
488
+ # </note>
489
+ #
490
+ # @option params [String] :next_token
491
+ # A token used to get the next set of results.
492
+ #
493
+ # @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
494
+ #
495
+ # * {Types::ListApplicationsResponse#application_summaries #application_summaries} => Array&lt;Types::ApplicationSummary&gt;
496
+ # * {Types::ListApplicationsResponse#next_token #next_token} => String
497
+ #
498
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
499
+ #
500
+ # @example Request syntax with placeholder values
501
+ #
502
+ # resp = client.list_applications({
503
+ # next_token: "NextToken",
504
+ # })
505
+ #
506
+ # @example Response structure
507
+ #
508
+ # resp.application_summaries #=> Array
509
+ # resp.application_summaries[0].application_id #=> String
510
+ # resp.application_summaries[0].application_name #=> String
511
+ # resp.application_summaries[0].application_description #=> String
512
+ # resp.application_summaries[0].application_url #=> String
513
+ # resp.application_summaries[0].application_creation_date #=> Integer
514
+ # resp.application_summaries[0].application_last_update_date #=> Integer
515
+ # resp.application_summaries[0].application_state #=> String, one of "CREATING", "DELETING", "ACTIVE", "CREATE_FAILED", "DELETE_FAILED"
516
+ # resp.next_token #=> String
517
+ #
518
+ # @overload list_applications(params = {})
519
+ # @param [Hash] params ({})
520
+ def list_applications(params = {}, options = {})
521
+ req = build_request(:list_applications, params)
522
+ req.send_request(options)
523
+ end
524
+
525
+ # Lists the tags for the specified resource.
526
+ #
527
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
528
+ # subject to change.
529
+ #
530
+ # </note>
531
+ #
532
+ # @option params [required, String] :resource_arn
533
+ # The ARN of the resource.
534
+ #
535
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
536
+ #
537
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
538
+ #
539
+ # @example Request syntax with placeholder values
540
+ #
541
+ # resp = client.list_tags_for_resource({
542
+ # resource_arn: "ResourceArn", # required
543
+ # })
544
+ #
545
+ # @example Response structure
546
+ #
547
+ # resp.tags #=> Hash
548
+ # resp.tags["TagKey"] #=> String
549
+ #
550
+ # @overload list_tags_for_resource(params = {})
551
+ # @param [Hash] params ({})
552
+ def list_tags_for_resource(params = {}, options = {})
553
+ req = build_request(:list_tags_for_resource, params)
554
+ req.send_request(options)
555
+ end
556
+
557
+ # Adds to or modifies the tags of the specified resource. Tags are
558
+ # metadata which can be used to manage a resource.
559
+ #
560
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
561
+ # subject to change.
562
+ #
563
+ # </note>
564
+ #
565
+ # @option params [required, String] :resource_arn
566
+ # The ARN of the resource.
567
+ #
568
+ # @option params [required, Hash<String,String>] :tags
569
+ # The new or modified tags for the resource.
570
+ #
571
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
572
+ #
573
+ # @example Request syntax with placeholder values
574
+ #
575
+ # resp = client.tag_resource({
576
+ # resource_arn: "ResourceArn", # required
577
+ # tags: { # required
578
+ # "TagKey" => "TagValue",
579
+ # },
580
+ # })
581
+ #
582
+ # @overload tag_resource(params = {})
583
+ # @param [Hash] params ({})
584
+ def tag_resource(params = {}, options = {})
585
+ req = build_request(:tag_resource, params)
586
+ req.send_request(options)
587
+ end
588
+
589
+ # Removes the specified tags (metadata) from the resource.
590
+ #
591
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
592
+ # subject to change.
593
+ #
594
+ # </note>
595
+ #
596
+ # @option params [required, String] :resource_arn
597
+ # The ARN of the resource.
598
+ #
599
+ # @option params [required, Array<String>] :tag_keys
600
+ # A list of the keys of the tags to be removed from the resource.
601
+ #
602
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
603
+ #
604
+ # @example Request syntax with placeholder values
605
+ #
606
+ # resp = client.untag_resource({
607
+ # resource_arn: "ResourceArn", # required
608
+ # tag_keys: ["TagKey"], # required
609
+ # })
610
+ #
611
+ # @overload untag_resource(params = {})
612
+ # @param [Hash] params ({})
613
+ def untag_resource(params = {}, options = {})
614
+ req = build_request(:untag_resource, params)
615
+ req.send_request(options)
616
+ end
617
+
618
+ # Updates information about a Fleet Hub for a AWS IoT Device Management
619
+ # web application.
620
+ #
621
+ # <note markdown="1"> Fleet Hub for AWS IoT Device Management is in public preview and is
622
+ # subject to change.
623
+ #
624
+ # </note>
625
+ #
626
+ # @option params [required, String] :application_id
627
+ # The unique Id of the web application.
628
+ #
629
+ # @option params [String] :application_name
630
+ # The name of the web application.
631
+ #
632
+ # @option params [String] :application_description
633
+ # An optional description of the web application.
634
+ #
635
+ # @option params [String] :client_token
636
+ # A unique case-sensitive identifier that you can provide to ensure the
637
+ # idempotency of the request. Don't reuse this client token if a new
638
+ # idempotent request is required.
639
+ #
640
+ # **A suitable default value is auto-generated.** You should normally
641
+ # not need to pass this option.**
642
+ #
643
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
644
+ #
645
+ # @example Request syntax with placeholder values
646
+ #
647
+ # resp = client.update_application({
648
+ # application_id: "Id", # required
649
+ # application_name: "Name",
650
+ # application_description: "Description",
651
+ # client_token: "ClientRequestToken",
652
+ # })
653
+ #
654
+ # @overload update_application(params = {})
655
+ # @param [Hash] params ({})
656
+ def update_application(params = {}, options = {})
657
+ req = build_request(:update_application, params)
658
+ req.send_request(options)
659
+ end
660
+
661
+ # @!endgroup
662
+
663
+ # @param params ({})
664
+ # @api private
665
+ def build_request(operation_name, params = {})
666
+ handlers = @handlers.for(operation_name)
667
+ context = Seahorse::Client::RequestContext.new(
668
+ operation_name: operation_name,
669
+ operation: config.api.operation(operation_name),
670
+ client: self,
671
+ params: params,
672
+ config: config)
673
+ context[:gem_name] = 'aws-sdk-iotfleethub'
674
+ context[:gem_version] = '1.0.0'
675
+ Seahorse::Client::Request.new(handlers, context)
676
+ end
677
+
678
+ # @api private
679
+ # @deprecated
680
+ def waiter_names
681
+ []
682
+ end
683
+
684
+ class << self
685
+
686
+ # @api private
687
+ attr_reader :identifier
688
+
689
+ # @api private
690
+ def errors_module
691
+ Errors
692
+ end
693
+
694
+ end
695
+ end
696
+ end