aws-sdk-iotwireless 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-iotwireless.rb +53 -0
- data/lib/aws-sdk-iotwireless/client.rb +2242 -0
- data/lib/aws-sdk-iotwireless/client_api.rb +1639 -0
- data/lib/aws-sdk-iotwireless/customizations.rb +0 -0
- data/lib/aws-sdk-iotwireless/errors.rb +175 -0
- data/lib/aws-sdk-iotwireless/resource.rb +26 -0
- data/lib/aws-sdk-iotwireless/types.rb +3281 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: bf1f3d2fa6acc0518b208e80a5a19598f2cb36c132a83092b72041e61293fd1a
|
4
|
+
data.tar.gz: c61e511f58752a3ca75195d163de9c337731abc55a07c8f204ecaa8ad8360e09
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ae506733437ab91029f54dd886da940e759d2727570ff8565acb0ee483e26500d0ffe085e10e1653b0955907c3933f9b603af7a25b3ee9f4539c3386bee62b6d
|
7
|
+
data.tar.gz: a2b074659b1f9371e9a045e9ae8ae9836b2170dadb43c4a42946884f37b4bca25eede9607cad617ecc0a63117e4ae356931f94e924b8419a8cfe7a7b4947dbc2
|
@@ -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-iotwireless/types'
|
15
|
+
require_relative 'aws-sdk-iotwireless/client_api'
|
16
|
+
require_relative 'aws-sdk-iotwireless/client'
|
17
|
+
require_relative 'aws-sdk-iotwireless/errors'
|
18
|
+
require_relative 'aws-sdk-iotwireless/resource'
|
19
|
+
require_relative 'aws-sdk-iotwireless/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AWS IoT Wireless. This module is available in the
|
22
|
+
# `aws-sdk-iotwireless` 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_wireless = Aws::IoTWireless::Client.new
|
31
|
+
# resp = io_t_wireless.associate_aws_account_with_partner_account(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AWS IoT Wireless are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::IoTWireless::Errors::ServiceError
|
43
|
+
# # rescues all AWS IoT Wireless API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::IoTWireless
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,2242 @@
|
|
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(:iotwireless)
|
34
|
+
|
35
|
+
module Aws::IoTWireless
|
36
|
+
# An API client for IoTWireless. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::IoTWireless::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 = :iotwireless
|
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
|
+
# Associates a partner account with your AWS account.
|
331
|
+
#
|
332
|
+
# @option params [required, Types::SidewalkAccountInfo] :sidewalk
|
333
|
+
# The Sidewalk account credentials.
|
334
|
+
#
|
335
|
+
# @option params [String] :client_request_token
|
336
|
+
# Each resource must have a unique client request token. If you try to
|
337
|
+
# create a new resource with the same token as a resource that already
|
338
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
339
|
+
# automatically generate a unique client request.
|
340
|
+
#
|
341
|
+
# **A suitable default value is auto-generated.** You should normally
|
342
|
+
# not need to pass this option.**
|
343
|
+
#
|
344
|
+
# @return [Types::AssociateAwsAccountWithPartnerAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
345
|
+
#
|
346
|
+
# * {Types::AssociateAwsAccountWithPartnerAccountResponse#sidewalk #sidewalk} => Types::SidewalkAccountInfo
|
347
|
+
#
|
348
|
+
# @example Request syntax with placeholder values
|
349
|
+
#
|
350
|
+
# resp = client.associate_aws_account_with_partner_account({
|
351
|
+
# sidewalk: { # required
|
352
|
+
# amazon_id: "AmazonId",
|
353
|
+
# app_server_private_key: "AppServerPrivateKey",
|
354
|
+
# },
|
355
|
+
# client_request_token: "ClientRequestToken",
|
356
|
+
# })
|
357
|
+
#
|
358
|
+
# @example Response structure
|
359
|
+
#
|
360
|
+
# resp.sidewalk.amazon_id #=> String
|
361
|
+
# resp.sidewalk.app_server_private_key #=> String
|
362
|
+
#
|
363
|
+
# @overload associate_aws_account_with_partner_account(params = {})
|
364
|
+
# @param [Hash] params ({})
|
365
|
+
def associate_aws_account_with_partner_account(params = {}, options = {})
|
366
|
+
req = build_request(:associate_aws_account_with_partner_account, params)
|
367
|
+
req.send_request(options)
|
368
|
+
end
|
369
|
+
|
370
|
+
# Associates a wireless device with a thing.
|
371
|
+
#
|
372
|
+
# @option params [required, String] :id
|
373
|
+
# The ID of the resource to update.
|
374
|
+
#
|
375
|
+
# @option params [required, String] :thing_arn
|
376
|
+
# The ARN of the thing to associate with the wireless device.
|
377
|
+
#
|
378
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
379
|
+
#
|
380
|
+
# @example Request syntax with placeholder values
|
381
|
+
#
|
382
|
+
# resp = client.associate_wireless_device_with_thing({
|
383
|
+
# id: "WirelessDeviceId", # required
|
384
|
+
# thing_arn: "ThingArn", # required
|
385
|
+
# })
|
386
|
+
#
|
387
|
+
# @overload associate_wireless_device_with_thing(params = {})
|
388
|
+
# @param [Hash] params ({})
|
389
|
+
def associate_wireless_device_with_thing(params = {}, options = {})
|
390
|
+
req = build_request(:associate_wireless_device_with_thing, params)
|
391
|
+
req.send_request(options)
|
392
|
+
end
|
393
|
+
|
394
|
+
# Associates a wireless gateway with a certificate.
|
395
|
+
#
|
396
|
+
# @option params [required, String] :id
|
397
|
+
# The ID of the resource to update.
|
398
|
+
#
|
399
|
+
# @option params [required, String] :iot_certificate_id
|
400
|
+
# The ID of the certificate to associate with the wireless gateway.
|
401
|
+
#
|
402
|
+
# @return [Types::AssociateWirelessGatewayWithCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
403
|
+
#
|
404
|
+
# * {Types::AssociateWirelessGatewayWithCertificateResponse#iot_certificate_id #iot_certificate_id} => String
|
405
|
+
#
|
406
|
+
# @example Request syntax with placeholder values
|
407
|
+
#
|
408
|
+
# resp = client.associate_wireless_gateway_with_certificate({
|
409
|
+
# id: "WirelessGatewayId", # required
|
410
|
+
# iot_certificate_id: "IotCertificateId", # required
|
411
|
+
# })
|
412
|
+
#
|
413
|
+
# @example Response structure
|
414
|
+
#
|
415
|
+
# resp.iot_certificate_id #=> String
|
416
|
+
#
|
417
|
+
# @overload associate_wireless_gateway_with_certificate(params = {})
|
418
|
+
# @param [Hash] params ({})
|
419
|
+
def associate_wireless_gateway_with_certificate(params = {}, options = {})
|
420
|
+
req = build_request(:associate_wireless_gateway_with_certificate, params)
|
421
|
+
req.send_request(options)
|
422
|
+
end
|
423
|
+
|
424
|
+
# Associates a wireless gateway with a thing.
|
425
|
+
#
|
426
|
+
# @option params [required, String] :id
|
427
|
+
# The ID of the resource to update.
|
428
|
+
#
|
429
|
+
# @option params [required, String] :thing_arn
|
430
|
+
# The ARN of the thing to associate with the wireless gateway.
|
431
|
+
#
|
432
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
433
|
+
#
|
434
|
+
# @example Request syntax with placeholder values
|
435
|
+
#
|
436
|
+
# resp = client.associate_wireless_gateway_with_thing({
|
437
|
+
# id: "WirelessGatewayId", # required
|
438
|
+
# thing_arn: "ThingArn", # required
|
439
|
+
# })
|
440
|
+
#
|
441
|
+
# @overload associate_wireless_gateway_with_thing(params = {})
|
442
|
+
# @param [Hash] params ({})
|
443
|
+
def associate_wireless_gateway_with_thing(params = {}, options = {})
|
444
|
+
req = build_request(:associate_wireless_gateway_with_thing, params)
|
445
|
+
req.send_request(options)
|
446
|
+
end
|
447
|
+
|
448
|
+
# Creates a new destination that maps a device message to an AWS IoT
|
449
|
+
# rule.
|
450
|
+
#
|
451
|
+
# @option params [required, String] :name
|
452
|
+
# The name of the new resource.
|
453
|
+
#
|
454
|
+
# @option params [required, String] :expression_type
|
455
|
+
# The type of value in `Expression`.
|
456
|
+
#
|
457
|
+
# @option params [required, String] :expression
|
458
|
+
# The rule name or topic rule to send messages to.
|
459
|
+
#
|
460
|
+
# @option params [String] :description
|
461
|
+
# The description of the new resource.
|
462
|
+
#
|
463
|
+
# @option params [required, String] :role_arn
|
464
|
+
# The ARN of the IAM Role that authorizes the destination.
|
465
|
+
#
|
466
|
+
# @option params [Array<Types::Tag>] :tags
|
467
|
+
# The tags to attach to the new destination. Tags are metadata that can
|
468
|
+
# be used to manage a resource.
|
469
|
+
#
|
470
|
+
# @option params [String] :client_request_token
|
471
|
+
# Each resource must have a unique client request token. If you try to
|
472
|
+
# create a new resource with the same token as a resource that already
|
473
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
474
|
+
# automatically generate a unique client request.
|
475
|
+
#
|
476
|
+
# **A suitable default value is auto-generated.** You should normally
|
477
|
+
# not need to pass this option.**
|
478
|
+
#
|
479
|
+
# @return [Types::CreateDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
480
|
+
#
|
481
|
+
# * {Types::CreateDestinationResponse#arn #arn} => String
|
482
|
+
# * {Types::CreateDestinationResponse#name #name} => String
|
483
|
+
#
|
484
|
+
# @example Request syntax with placeholder values
|
485
|
+
#
|
486
|
+
# resp = client.create_destination({
|
487
|
+
# name: "DestinationName", # required
|
488
|
+
# expression_type: "RuleName", # required, accepts RuleName
|
489
|
+
# expression: "Expression", # required
|
490
|
+
# description: "Description",
|
491
|
+
# role_arn: "RoleArn", # required
|
492
|
+
# tags: [
|
493
|
+
# {
|
494
|
+
# key: "TagKey", # required
|
495
|
+
# value: "TagValue", # required
|
496
|
+
# },
|
497
|
+
# ],
|
498
|
+
# client_request_token: "ClientRequestToken",
|
499
|
+
# })
|
500
|
+
#
|
501
|
+
# @example Response structure
|
502
|
+
#
|
503
|
+
# resp.arn #=> String
|
504
|
+
# resp.name #=> String
|
505
|
+
#
|
506
|
+
# @overload create_destination(params = {})
|
507
|
+
# @param [Hash] params ({})
|
508
|
+
def create_destination(params = {}, options = {})
|
509
|
+
req = build_request(:create_destination, params)
|
510
|
+
req.send_request(options)
|
511
|
+
end
|
512
|
+
|
513
|
+
# Creates a new device profile.
|
514
|
+
#
|
515
|
+
# @option params [String] :name
|
516
|
+
# The name of the new resource.
|
517
|
+
#
|
518
|
+
# @option params [Types::LoRaWANDeviceProfile] :lo_ra_wan
|
519
|
+
# The device profile information to use to create the device profile.
|
520
|
+
#
|
521
|
+
# @option params [Array<Types::Tag>] :tags
|
522
|
+
# The tags to attach to the new device profile Tags are metadata that
|
523
|
+
# can be used to manage a resource.
|
524
|
+
#
|
525
|
+
# @option params [String] :client_request_token
|
526
|
+
# Each resource must have a unique client request token. If you try to
|
527
|
+
# create a new resource with the same token as a resource that already
|
528
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
529
|
+
# automatically generate a unique client request.
|
530
|
+
#
|
531
|
+
# **A suitable default value is auto-generated.** You should normally
|
532
|
+
# not need to pass this option.**
|
533
|
+
#
|
534
|
+
# @return [Types::CreateDeviceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
535
|
+
#
|
536
|
+
# * {Types::CreateDeviceProfileResponse#arn #arn} => String
|
537
|
+
# * {Types::CreateDeviceProfileResponse#id #id} => String
|
538
|
+
#
|
539
|
+
# @example Request syntax with placeholder values
|
540
|
+
#
|
541
|
+
# resp = client.create_device_profile({
|
542
|
+
# name: "DeviceProfileName",
|
543
|
+
# lo_ra_wan: {
|
544
|
+
# supports_class_b: false,
|
545
|
+
# class_b_timeout: 1,
|
546
|
+
# ping_slot_period: 1,
|
547
|
+
# ping_slot_dr: 1,
|
548
|
+
# ping_slot_freq: 1,
|
549
|
+
# supports_class_c: false,
|
550
|
+
# class_c_timeout: 1,
|
551
|
+
# mac_version: "MacVersion",
|
552
|
+
# reg_params_revision: "RegParamsRevision",
|
553
|
+
# rx_delay_1: 1,
|
554
|
+
# rx_dr_offset_1: 1,
|
555
|
+
# rx_data_rate_2: 1,
|
556
|
+
# rx_freq_2: 1,
|
557
|
+
# factory_preset_freqs_list: [1],
|
558
|
+
# max_eirp: 1,
|
559
|
+
# max_duty_cycle: 1,
|
560
|
+
# rf_region: "RfRegion",
|
561
|
+
# supports_join: false,
|
562
|
+
# supports_32_bit_f_cnt: false,
|
563
|
+
# },
|
564
|
+
# tags: [
|
565
|
+
# {
|
566
|
+
# key: "TagKey", # required
|
567
|
+
# value: "TagValue", # required
|
568
|
+
# },
|
569
|
+
# ],
|
570
|
+
# client_request_token: "ClientRequestToken",
|
571
|
+
# })
|
572
|
+
#
|
573
|
+
# @example Response structure
|
574
|
+
#
|
575
|
+
# resp.arn #=> String
|
576
|
+
# resp.id #=> String
|
577
|
+
#
|
578
|
+
# @overload create_device_profile(params = {})
|
579
|
+
# @param [Hash] params ({})
|
580
|
+
def create_device_profile(params = {}, options = {})
|
581
|
+
req = build_request(:create_device_profile, params)
|
582
|
+
req.send_request(options)
|
583
|
+
end
|
584
|
+
|
585
|
+
# Creates a new service profile.
|
586
|
+
#
|
587
|
+
# @option params [String] :name
|
588
|
+
# The name of the new resource.
|
589
|
+
#
|
590
|
+
# @option params [Types::LoRaWANServiceProfile] :lo_ra_wan
|
591
|
+
# The service profile information to use to create the service profile.
|
592
|
+
#
|
593
|
+
# @option params [Array<Types::Tag>] :tags
|
594
|
+
# The tags to attach to the new service profile. Tags are metadata that
|
595
|
+
# can be used to manage a resource.
|
596
|
+
#
|
597
|
+
# @option params [String] :client_request_token
|
598
|
+
# Each resource must have a unique client request token. If you try to
|
599
|
+
# create a new resource with the same token as a resource that already
|
600
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
601
|
+
# automatically generate a unique client request.
|
602
|
+
#
|
603
|
+
# **A suitable default value is auto-generated.** You should normally
|
604
|
+
# not need to pass this option.**
|
605
|
+
#
|
606
|
+
# @return [Types::CreateServiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
607
|
+
#
|
608
|
+
# * {Types::CreateServiceProfileResponse#arn #arn} => String
|
609
|
+
# * {Types::CreateServiceProfileResponse#id #id} => String
|
610
|
+
#
|
611
|
+
# @example Request syntax with placeholder values
|
612
|
+
#
|
613
|
+
# resp = client.create_service_profile({
|
614
|
+
# name: "ServiceProfileName",
|
615
|
+
# lo_ra_wan: {
|
616
|
+
# add_gw_metadata: false,
|
617
|
+
# },
|
618
|
+
# tags: [
|
619
|
+
# {
|
620
|
+
# key: "TagKey", # required
|
621
|
+
# value: "TagValue", # required
|
622
|
+
# },
|
623
|
+
# ],
|
624
|
+
# client_request_token: "ClientRequestToken",
|
625
|
+
# })
|
626
|
+
#
|
627
|
+
# @example Response structure
|
628
|
+
#
|
629
|
+
# resp.arn #=> String
|
630
|
+
# resp.id #=> String
|
631
|
+
#
|
632
|
+
# @overload create_service_profile(params = {})
|
633
|
+
# @param [Hash] params ({})
|
634
|
+
def create_service_profile(params = {}, options = {})
|
635
|
+
req = build_request(:create_service_profile, params)
|
636
|
+
req.send_request(options)
|
637
|
+
end
|
638
|
+
|
639
|
+
# Provisions a wireless device.
|
640
|
+
#
|
641
|
+
# @option params [required, String] :type
|
642
|
+
# The wireless device type.
|
643
|
+
#
|
644
|
+
# @option params [String] :name
|
645
|
+
# The name of the new resource.
|
646
|
+
#
|
647
|
+
# @option params [String] :description
|
648
|
+
# The description of the new resource.
|
649
|
+
#
|
650
|
+
# @option params [required, String] :destination_name
|
651
|
+
# The name of the destination to assign to the new wireless device.
|
652
|
+
#
|
653
|
+
# @option params [String] :client_request_token
|
654
|
+
# Each resource must have a unique client request token. If you try to
|
655
|
+
# create a new resource with the same token as a resource that already
|
656
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
657
|
+
# automatically generate a unique client request.
|
658
|
+
#
|
659
|
+
# **A suitable default value is auto-generated.** You should normally
|
660
|
+
# not need to pass this option.**
|
661
|
+
#
|
662
|
+
# @option params [Types::LoRaWANDevice] :lo_ra_wan
|
663
|
+
# The device configuration information to use to create the wireless
|
664
|
+
# device.
|
665
|
+
#
|
666
|
+
# @return [Types::CreateWirelessDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
667
|
+
#
|
668
|
+
# * {Types::CreateWirelessDeviceResponse#arn #arn} => String
|
669
|
+
# * {Types::CreateWirelessDeviceResponse#id #id} => String
|
670
|
+
#
|
671
|
+
# @example Request syntax with placeholder values
|
672
|
+
#
|
673
|
+
# resp = client.create_wireless_device({
|
674
|
+
# type: "Sidewalk", # required, accepts Sidewalk, LoRaWAN
|
675
|
+
# name: "WirelessDeviceName",
|
676
|
+
# description: "Description",
|
677
|
+
# destination_name: "DestinationName", # required
|
678
|
+
# client_request_token: "ClientRequestToken",
|
679
|
+
# lo_ra_wan: {
|
680
|
+
# dev_eui: "DevEui",
|
681
|
+
# device_profile_id: "DeviceProfileId",
|
682
|
+
# service_profile_id: "ServiceProfileId",
|
683
|
+
# otaa_v1_1: {
|
684
|
+
# app_key: "AppKey",
|
685
|
+
# nwk_key: "NwkKey",
|
686
|
+
# join_eui: "JoinEui",
|
687
|
+
# },
|
688
|
+
# otaa_v1_0_x: {
|
689
|
+
# app_key: "AppKey",
|
690
|
+
# app_eui: "AppEui",
|
691
|
+
# },
|
692
|
+
# abp_v1_1: {
|
693
|
+
# dev_addr: "DevAddr",
|
694
|
+
# session_keys: {
|
695
|
+
# f_nwk_s_int_key: "FNwkSIntKey",
|
696
|
+
# s_nwk_s_int_key: "SNwkSIntKey",
|
697
|
+
# nwk_s_enc_key: "NwkSEncKey",
|
698
|
+
# app_s_key: "AppSKey",
|
699
|
+
# },
|
700
|
+
# },
|
701
|
+
# abp_v1_0_x: {
|
702
|
+
# dev_addr: "DevAddr",
|
703
|
+
# session_keys: {
|
704
|
+
# nwk_s_key: "NwkSKey",
|
705
|
+
# app_s_key: "AppSKey",
|
706
|
+
# },
|
707
|
+
# },
|
708
|
+
# },
|
709
|
+
# })
|
710
|
+
#
|
711
|
+
# @example Response structure
|
712
|
+
#
|
713
|
+
# resp.arn #=> String
|
714
|
+
# resp.id #=> String
|
715
|
+
#
|
716
|
+
# @overload create_wireless_device(params = {})
|
717
|
+
# @param [Hash] params ({})
|
718
|
+
def create_wireless_device(params = {}, options = {})
|
719
|
+
req = build_request(:create_wireless_device, params)
|
720
|
+
req.send_request(options)
|
721
|
+
end
|
722
|
+
|
723
|
+
# Provisions a wireless gateway.
|
724
|
+
#
|
725
|
+
# @option params [String] :name
|
726
|
+
# The name of the new resource.
|
727
|
+
#
|
728
|
+
# @option params [String] :description
|
729
|
+
# The description of the new resource.
|
730
|
+
#
|
731
|
+
# @option params [required, Types::LoRaWANGateway] :lo_ra_wan
|
732
|
+
# The gateway configuration information to use to create the wireless
|
733
|
+
# gateway.
|
734
|
+
#
|
735
|
+
# @option params [Array<Types::Tag>] :tags
|
736
|
+
# The tags to attach to the new wireless gateway. Tags are metadata that
|
737
|
+
# can be used to manage a resource.
|
738
|
+
#
|
739
|
+
# @option params [String] :client_request_token
|
740
|
+
# Each resource must have a unique client request token. If you try to
|
741
|
+
# create a new resource with the same token as a resource that already
|
742
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
743
|
+
# automatically generate a unique client request.
|
744
|
+
#
|
745
|
+
# **A suitable default value is auto-generated.** You should normally
|
746
|
+
# not need to pass this option.**
|
747
|
+
#
|
748
|
+
# @return [Types::CreateWirelessGatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
749
|
+
#
|
750
|
+
# * {Types::CreateWirelessGatewayResponse#arn #arn} => String
|
751
|
+
# * {Types::CreateWirelessGatewayResponse#id #id} => String
|
752
|
+
#
|
753
|
+
# @example Request syntax with placeholder values
|
754
|
+
#
|
755
|
+
# resp = client.create_wireless_gateway({
|
756
|
+
# name: "WirelessGatewayName",
|
757
|
+
# description: "Description",
|
758
|
+
# lo_ra_wan: { # required
|
759
|
+
# gateway_eui: "GatewayEui",
|
760
|
+
# rf_region: "RfRegion",
|
761
|
+
# },
|
762
|
+
# tags: [
|
763
|
+
# {
|
764
|
+
# key: "TagKey", # required
|
765
|
+
# value: "TagValue", # required
|
766
|
+
# },
|
767
|
+
# ],
|
768
|
+
# client_request_token: "ClientRequestToken",
|
769
|
+
# })
|
770
|
+
#
|
771
|
+
# @example Response structure
|
772
|
+
#
|
773
|
+
# resp.arn #=> String
|
774
|
+
# resp.id #=> String
|
775
|
+
#
|
776
|
+
# @overload create_wireless_gateway(params = {})
|
777
|
+
# @param [Hash] params ({})
|
778
|
+
def create_wireless_gateway(params = {}, options = {})
|
779
|
+
req = build_request(:create_wireless_gateway, params)
|
780
|
+
req.send_request(options)
|
781
|
+
end
|
782
|
+
|
783
|
+
# Creates a task for a wireless gateway.
|
784
|
+
#
|
785
|
+
# @option params [required, String] :id
|
786
|
+
# The ID of the resource to update.
|
787
|
+
#
|
788
|
+
# @option params [required, String] :wireless_gateway_task_definition_id
|
789
|
+
# The ID of the WirelessGatewayTaskDefinition.
|
790
|
+
#
|
791
|
+
# @return [Types::CreateWirelessGatewayTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
792
|
+
#
|
793
|
+
# * {Types::CreateWirelessGatewayTaskResponse#wireless_gateway_task_definition_id #wireless_gateway_task_definition_id} => String
|
794
|
+
# * {Types::CreateWirelessGatewayTaskResponse#status #status} => String
|
795
|
+
#
|
796
|
+
# @example Request syntax with placeholder values
|
797
|
+
#
|
798
|
+
# resp = client.create_wireless_gateway_task({
|
799
|
+
# id: "WirelessGatewayId", # required
|
800
|
+
# wireless_gateway_task_definition_id: "WirelessGatewayTaskDefinitionId", # required
|
801
|
+
# })
|
802
|
+
#
|
803
|
+
# @example Response structure
|
804
|
+
#
|
805
|
+
# resp.wireless_gateway_task_definition_id #=> String
|
806
|
+
# resp.status #=> String, one of "PENDING", "IN_PROGRESS", "FIRST_RETRY", "SECOND_RETRY", "COMPLETED", "FAILED"
|
807
|
+
#
|
808
|
+
# @overload create_wireless_gateway_task(params = {})
|
809
|
+
# @param [Hash] params ({})
|
810
|
+
def create_wireless_gateway_task(params = {}, options = {})
|
811
|
+
req = build_request(:create_wireless_gateway_task, params)
|
812
|
+
req.send_request(options)
|
813
|
+
end
|
814
|
+
|
815
|
+
# Creates a gateway task definition.
|
816
|
+
#
|
817
|
+
# @option params [required, Boolean] :auto_create_tasks
|
818
|
+
# Whether to automatically create tasks using this task definition for
|
819
|
+
# all gateways with the specified current version. If `false`, the task
|
820
|
+
# must me created by calling `CreateWirelessGatewayTask`.
|
821
|
+
#
|
822
|
+
# @option params [String] :name
|
823
|
+
# The name of the new resource.
|
824
|
+
#
|
825
|
+
# @option params [Types::UpdateWirelessGatewayTaskCreate] :update
|
826
|
+
# Information about the gateways to update.
|
827
|
+
#
|
828
|
+
# @option params [String] :client_request_token
|
829
|
+
# Each resource must have a unique client request token. If you try to
|
830
|
+
# create a new resource with the same token as a resource that already
|
831
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
832
|
+
# automatically generate a unique client request.
|
833
|
+
#
|
834
|
+
# **A suitable default value is auto-generated.** You should normally
|
835
|
+
# not need to pass this option.**
|
836
|
+
#
|
837
|
+
# @return [Types::CreateWirelessGatewayTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
838
|
+
#
|
839
|
+
# * {Types::CreateWirelessGatewayTaskDefinitionResponse#id #id} => String
|
840
|
+
#
|
841
|
+
# @example Request syntax with placeholder values
|
842
|
+
#
|
843
|
+
# resp = client.create_wireless_gateway_task_definition({
|
844
|
+
# auto_create_tasks: false, # required
|
845
|
+
# name: "WirelessGatewayTaskName",
|
846
|
+
# update: {
|
847
|
+
# update_data_source: "UpdateDataSource",
|
848
|
+
# update_data_role: "UpdateDataSource",
|
849
|
+
# lo_ra_wan: {
|
850
|
+
# update_signature: "UpdateSignature",
|
851
|
+
# sig_key_crc: 1,
|
852
|
+
# current_version: {
|
853
|
+
# package_version: "PackageVersion",
|
854
|
+
# model: "Model",
|
855
|
+
# station: "Station",
|
856
|
+
# },
|
857
|
+
# update_version: {
|
858
|
+
# package_version: "PackageVersion",
|
859
|
+
# model: "Model",
|
860
|
+
# station: "Station",
|
861
|
+
# },
|
862
|
+
# },
|
863
|
+
# },
|
864
|
+
# client_request_token: "ClientRequestToken",
|
865
|
+
# })
|
866
|
+
#
|
867
|
+
# @example Response structure
|
868
|
+
#
|
869
|
+
# resp.id #=> String
|
870
|
+
#
|
871
|
+
# @overload create_wireless_gateway_task_definition(params = {})
|
872
|
+
# @param [Hash] params ({})
|
873
|
+
def create_wireless_gateway_task_definition(params = {}, options = {})
|
874
|
+
req = build_request(:create_wireless_gateway_task_definition, params)
|
875
|
+
req.send_request(options)
|
876
|
+
end
|
877
|
+
|
878
|
+
# Deletes a destination.
|
879
|
+
#
|
880
|
+
# @option params [required, String] :name
|
881
|
+
# The name of the resource to delete.
|
882
|
+
#
|
883
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
884
|
+
#
|
885
|
+
# @example Request syntax with placeholder values
|
886
|
+
#
|
887
|
+
# resp = client.delete_destination({
|
888
|
+
# name: "DestinationName", # required
|
889
|
+
# })
|
890
|
+
#
|
891
|
+
# @overload delete_destination(params = {})
|
892
|
+
# @param [Hash] params ({})
|
893
|
+
def delete_destination(params = {}, options = {})
|
894
|
+
req = build_request(:delete_destination, params)
|
895
|
+
req.send_request(options)
|
896
|
+
end
|
897
|
+
|
898
|
+
# Deletes a device profile.
|
899
|
+
#
|
900
|
+
# @option params [required, String] :id
|
901
|
+
# The ID of the resource to delete.
|
902
|
+
#
|
903
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
904
|
+
#
|
905
|
+
# @example Request syntax with placeholder values
|
906
|
+
#
|
907
|
+
# resp = client.delete_device_profile({
|
908
|
+
# id: "DeviceProfileId", # required
|
909
|
+
# })
|
910
|
+
#
|
911
|
+
# @overload delete_device_profile(params = {})
|
912
|
+
# @param [Hash] params ({})
|
913
|
+
def delete_device_profile(params = {}, options = {})
|
914
|
+
req = build_request(:delete_device_profile, params)
|
915
|
+
req.send_request(options)
|
916
|
+
end
|
917
|
+
|
918
|
+
# Deletes a service profile.
|
919
|
+
#
|
920
|
+
# @option params [required, String] :id
|
921
|
+
# The ID of the resource to delete.
|
922
|
+
#
|
923
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
924
|
+
#
|
925
|
+
# @example Request syntax with placeholder values
|
926
|
+
#
|
927
|
+
# resp = client.delete_service_profile({
|
928
|
+
# id: "ServiceProfileId", # required
|
929
|
+
# })
|
930
|
+
#
|
931
|
+
# @overload delete_service_profile(params = {})
|
932
|
+
# @param [Hash] params ({})
|
933
|
+
def delete_service_profile(params = {}, options = {})
|
934
|
+
req = build_request(:delete_service_profile, params)
|
935
|
+
req.send_request(options)
|
936
|
+
end
|
937
|
+
|
938
|
+
# Deletes a wireless device.
|
939
|
+
#
|
940
|
+
# @option params [required, String] :id
|
941
|
+
# The ID of the resource to delete.
|
942
|
+
#
|
943
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
944
|
+
#
|
945
|
+
# @example Request syntax with placeholder values
|
946
|
+
#
|
947
|
+
# resp = client.delete_wireless_device({
|
948
|
+
# id: "WirelessDeviceId", # required
|
949
|
+
# })
|
950
|
+
#
|
951
|
+
# @overload delete_wireless_device(params = {})
|
952
|
+
# @param [Hash] params ({})
|
953
|
+
def delete_wireless_device(params = {}, options = {})
|
954
|
+
req = build_request(:delete_wireless_device, params)
|
955
|
+
req.send_request(options)
|
956
|
+
end
|
957
|
+
|
958
|
+
# Deletes a wireless gateway.
|
959
|
+
#
|
960
|
+
# @option params [required, String] :id
|
961
|
+
# The ID of the resource to delete.
|
962
|
+
#
|
963
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
964
|
+
#
|
965
|
+
# @example Request syntax with placeholder values
|
966
|
+
#
|
967
|
+
# resp = client.delete_wireless_gateway({
|
968
|
+
# id: "WirelessGatewayId", # required
|
969
|
+
# })
|
970
|
+
#
|
971
|
+
# @overload delete_wireless_gateway(params = {})
|
972
|
+
# @param [Hash] params ({})
|
973
|
+
def delete_wireless_gateway(params = {}, options = {})
|
974
|
+
req = build_request(:delete_wireless_gateway, params)
|
975
|
+
req.send_request(options)
|
976
|
+
end
|
977
|
+
|
978
|
+
# Deletes a wireless gateway task.
|
979
|
+
#
|
980
|
+
# @option params [required, String] :id
|
981
|
+
# The ID of the resource to delete.
|
982
|
+
#
|
983
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
984
|
+
#
|
985
|
+
# @example Request syntax with placeholder values
|
986
|
+
#
|
987
|
+
# resp = client.delete_wireless_gateway_task({
|
988
|
+
# id: "WirelessGatewayId", # required
|
989
|
+
# })
|
990
|
+
#
|
991
|
+
# @overload delete_wireless_gateway_task(params = {})
|
992
|
+
# @param [Hash] params ({})
|
993
|
+
def delete_wireless_gateway_task(params = {}, options = {})
|
994
|
+
req = build_request(:delete_wireless_gateway_task, params)
|
995
|
+
req.send_request(options)
|
996
|
+
end
|
997
|
+
|
998
|
+
# Deletes a wireless gateway task definition. Deleting this task
|
999
|
+
# definition does not affect tasks that are currently in progress.
|
1000
|
+
#
|
1001
|
+
# @option params [required, String] :id
|
1002
|
+
# The ID of the resource to delete.
|
1003
|
+
#
|
1004
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1005
|
+
#
|
1006
|
+
# @example Request syntax with placeholder values
|
1007
|
+
#
|
1008
|
+
# resp = client.delete_wireless_gateway_task_definition({
|
1009
|
+
# id: "WirelessGatewayTaskDefinitionId", # required
|
1010
|
+
# })
|
1011
|
+
#
|
1012
|
+
# @overload delete_wireless_gateway_task_definition(params = {})
|
1013
|
+
# @param [Hash] params ({})
|
1014
|
+
def delete_wireless_gateway_task_definition(params = {}, options = {})
|
1015
|
+
req = build_request(:delete_wireless_gateway_task_definition, params)
|
1016
|
+
req.send_request(options)
|
1017
|
+
end
|
1018
|
+
|
1019
|
+
# Disassociates your AWS account from a partner account. If
|
1020
|
+
# `PartnerAccountId` and `PartnerType` are `null`, disassociates your
|
1021
|
+
# AWS account from all partner accounts.
|
1022
|
+
#
|
1023
|
+
# @option params [required, String] :partner_account_id
|
1024
|
+
# The partner account ID to disassociate from the AWS account.
|
1025
|
+
#
|
1026
|
+
# @option params [required, String] :partner_type
|
1027
|
+
# The partner type.
|
1028
|
+
#
|
1029
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1030
|
+
#
|
1031
|
+
# @example Request syntax with placeholder values
|
1032
|
+
#
|
1033
|
+
# resp = client.disassociate_aws_account_from_partner_account({
|
1034
|
+
# partner_account_id: "PartnerAccountId", # required
|
1035
|
+
# partner_type: "Sidewalk", # required, accepts Sidewalk
|
1036
|
+
# })
|
1037
|
+
#
|
1038
|
+
# @overload disassociate_aws_account_from_partner_account(params = {})
|
1039
|
+
# @param [Hash] params ({})
|
1040
|
+
def disassociate_aws_account_from_partner_account(params = {}, options = {})
|
1041
|
+
req = build_request(:disassociate_aws_account_from_partner_account, params)
|
1042
|
+
req.send_request(options)
|
1043
|
+
end
|
1044
|
+
|
1045
|
+
# Disassociates a wireless device from its currently associated thing.
|
1046
|
+
#
|
1047
|
+
# @option params [required, String] :id
|
1048
|
+
# The ID of the resource to update.
|
1049
|
+
#
|
1050
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1051
|
+
#
|
1052
|
+
# @example Request syntax with placeholder values
|
1053
|
+
#
|
1054
|
+
# resp = client.disassociate_wireless_device_from_thing({
|
1055
|
+
# id: "WirelessDeviceId", # required
|
1056
|
+
# })
|
1057
|
+
#
|
1058
|
+
# @overload disassociate_wireless_device_from_thing(params = {})
|
1059
|
+
# @param [Hash] params ({})
|
1060
|
+
def disassociate_wireless_device_from_thing(params = {}, options = {})
|
1061
|
+
req = build_request(:disassociate_wireless_device_from_thing, params)
|
1062
|
+
req.send_request(options)
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# Disassociates a wireless gateway from its currently associated
|
1066
|
+
# certificate.
|
1067
|
+
#
|
1068
|
+
# @option params [required, String] :id
|
1069
|
+
# The ID of the resource to update.
|
1070
|
+
#
|
1071
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1072
|
+
#
|
1073
|
+
# @example Request syntax with placeholder values
|
1074
|
+
#
|
1075
|
+
# resp = client.disassociate_wireless_gateway_from_certificate({
|
1076
|
+
# id: "WirelessGatewayId", # required
|
1077
|
+
# })
|
1078
|
+
#
|
1079
|
+
# @overload disassociate_wireless_gateway_from_certificate(params = {})
|
1080
|
+
# @param [Hash] params ({})
|
1081
|
+
def disassociate_wireless_gateway_from_certificate(params = {}, options = {})
|
1082
|
+
req = build_request(:disassociate_wireless_gateway_from_certificate, params)
|
1083
|
+
req.send_request(options)
|
1084
|
+
end
|
1085
|
+
|
1086
|
+
# Disassociates a wireless gateway from its currently associated thing.
|
1087
|
+
#
|
1088
|
+
# @option params [required, String] :id
|
1089
|
+
# The ID of the resource to update.
|
1090
|
+
#
|
1091
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1092
|
+
#
|
1093
|
+
# @example Request syntax with placeholder values
|
1094
|
+
#
|
1095
|
+
# resp = client.disassociate_wireless_gateway_from_thing({
|
1096
|
+
# id: "WirelessGatewayId", # required
|
1097
|
+
# })
|
1098
|
+
#
|
1099
|
+
# @overload disassociate_wireless_gateway_from_thing(params = {})
|
1100
|
+
# @param [Hash] params ({})
|
1101
|
+
def disassociate_wireless_gateway_from_thing(params = {}, options = {})
|
1102
|
+
req = build_request(:disassociate_wireless_gateway_from_thing, params)
|
1103
|
+
req.send_request(options)
|
1104
|
+
end
|
1105
|
+
|
1106
|
+
# Gets information about a destination.
|
1107
|
+
#
|
1108
|
+
# @option params [required, String] :name
|
1109
|
+
# The name of the resource to get.
|
1110
|
+
#
|
1111
|
+
# @return [Types::GetDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1112
|
+
#
|
1113
|
+
# * {Types::GetDestinationResponse#arn #arn} => String
|
1114
|
+
# * {Types::GetDestinationResponse#name #name} => String
|
1115
|
+
# * {Types::GetDestinationResponse#expression #expression} => String
|
1116
|
+
# * {Types::GetDestinationResponse#expression_type #expression_type} => String
|
1117
|
+
# * {Types::GetDestinationResponse#description #description} => String
|
1118
|
+
# * {Types::GetDestinationResponse#role_arn #role_arn} => String
|
1119
|
+
#
|
1120
|
+
# @example Request syntax with placeholder values
|
1121
|
+
#
|
1122
|
+
# resp = client.get_destination({
|
1123
|
+
# name: "DestinationName", # required
|
1124
|
+
# })
|
1125
|
+
#
|
1126
|
+
# @example Response structure
|
1127
|
+
#
|
1128
|
+
# resp.arn #=> String
|
1129
|
+
# resp.name #=> String
|
1130
|
+
# resp.expression #=> String
|
1131
|
+
# resp.expression_type #=> String, one of "RuleName"
|
1132
|
+
# resp.description #=> String
|
1133
|
+
# resp.role_arn #=> String
|
1134
|
+
#
|
1135
|
+
# @overload get_destination(params = {})
|
1136
|
+
# @param [Hash] params ({})
|
1137
|
+
def get_destination(params = {}, options = {})
|
1138
|
+
req = build_request(:get_destination, params)
|
1139
|
+
req.send_request(options)
|
1140
|
+
end
|
1141
|
+
|
1142
|
+
# Gets information about a device profile.
|
1143
|
+
#
|
1144
|
+
# @option params [required, String] :id
|
1145
|
+
# The ID of the resource to get.
|
1146
|
+
#
|
1147
|
+
# @return [Types::GetDeviceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1148
|
+
#
|
1149
|
+
# * {Types::GetDeviceProfileResponse#arn #arn} => String
|
1150
|
+
# * {Types::GetDeviceProfileResponse#name #name} => String
|
1151
|
+
# * {Types::GetDeviceProfileResponse#id #id} => String
|
1152
|
+
# * {Types::GetDeviceProfileResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANDeviceProfile
|
1153
|
+
#
|
1154
|
+
# @example Request syntax with placeholder values
|
1155
|
+
#
|
1156
|
+
# resp = client.get_device_profile({
|
1157
|
+
# id: "DeviceProfileId", # required
|
1158
|
+
# })
|
1159
|
+
#
|
1160
|
+
# @example Response structure
|
1161
|
+
#
|
1162
|
+
# resp.arn #=> String
|
1163
|
+
# resp.name #=> String
|
1164
|
+
# resp.id #=> String
|
1165
|
+
# resp.lo_ra_wan.supports_class_b #=> Boolean
|
1166
|
+
# resp.lo_ra_wan.class_b_timeout #=> Integer
|
1167
|
+
# resp.lo_ra_wan.ping_slot_period #=> Integer
|
1168
|
+
# resp.lo_ra_wan.ping_slot_dr #=> Integer
|
1169
|
+
# resp.lo_ra_wan.ping_slot_freq #=> Integer
|
1170
|
+
# resp.lo_ra_wan.supports_class_c #=> Boolean
|
1171
|
+
# resp.lo_ra_wan.class_c_timeout #=> Integer
|
1172
|
+
# resp.lo_ra_wan.mac_version #=> String
|
1173
|
+
# resp.lo_ra_wan.reg_params_revision #=> String
|
1174
|
+
# resp.lo_ra_wan.rx_delay_1 #=> Integer
|
1175
|
+
# resp.lo_ra_wan.rx_dr_offset_1 #=> Integer
|
1176
|
+
# resp.lo_ra_wan.rx_data_rate_2 #=> Integer
|
1177
|
+
# resp.lo_ra_wan.rx_freq_2 #=> Integer
|
1178
|
+
# resp.lo_ra_wan.factory_preset_freqs_list #=> Array
|
1179
|
+
# resp.lo_ra_wan.factory_preset_freqs_list[0] #=> Integer
|
1180
|
+
# resp.lo_ra_wan.max_eirp #=> Integer
|
1181
|
+
# resp.lo_ra_wan.max_duty_cycle #=> Integer
|
1182
|
+
# resp.lo_ra_wan.rf_region #=> String
|
1183
|
+
# resp.lo_ra_wan.supports_join #=> Boolean
|
1184
|
+
# resp.lo_ra_wan.supports_32_bit_f_cnt #=> Boolean
|
1185
|
+
#
|
1186
|
+
# @overload get_device_profile(params = {})
|
1187
|
+
# @param [Hash] params ({})
|
1188
|
+
def get_device_profile(params = {}, options = {})
|
1189
|
+
req = build_request(:get_device_profile, params)
|
1190
|
+
req.send_request(options)
|
1191
|
+
end
|
1192
|
+
|
1193
|
+
# Gets information about a partner account. If `PartnerAccountId` and
|
1194
|
+
# `PartnerType` are `null`, returns all partner accounts.
|
1195
|
+
#
|
1196
|
+
# @option params [required, String] :partner_account_id
|
1197
|
+
# The partner account ID to disassociate from the AWS account.
|
1198
|
+
#
|
1199
|
+
# @option params [required, String] :partner_type
|
1200
|
+
# The partner type.
|
1201
|
+
#
|
1202
|
+
# @return [Types::GetPartnerAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1203
|
+
#
|
1204
|
+
# * {Types::GetPartnerAccountResponse#sidewalk #sidewalk} => Types::SidewalkAccountInfoWithFingerprint
|
1205
|
+
# * {Types::GetPartnerAccountResponse#account_linked #account_linked} => Boolean
|
1206
|
+
#
|
1207
|
+
# @example Request syntax with placeholder values
|
1208
|
+
#
|
1209
|
+
# resp = client.get_partner_account({
|
1210
|
+
# partner_account_id: "PartnerAccountId", # required
|
1211
|
+
# partner_type: "Sidewalk", # required, accepts Sidewalk
|
1212
|
+
# })
|
1213
|
+
#
|
1214
|
+
# @example Response structure
|
1215
|
+
#
|
1216
|
+
# resp.sidewalk.amazon_id #=> String
|
1217
|
+
# resp.sidewalk.app_server_private_key #=> String
|
1218
|
+
# resp.account_linked #=> Boolean
|
1219
|
+
#
|
1220
|
+
# @overload get_partner_account(params = {})
|
1221
|
+
# @param [Hash] params ({})
|
1222
|
+
def get_partner_account(params = {}, options = {})
|
1223
|
+
req = build_request(:get_partner_account, params)
|
1224
|
+
req.send_request(options)
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
# Gets the account-specific endpoint for Configuration and Update Server
|
1228
|
+
# (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
|
1229
|
+
#
|
1230
|
+
# @option params [String] :service_type
|
1231
|
+
# The service type for which to get endpoint information about. Can be
|
1232
|
+
# `CUPS` for the Configuration and Update Server endpoint, or `LNS` for
|
1233
|
+
# the LoRaWAN Network Server endpoint.
|
1234
|
+
#
|
1235
|
+
# @return [Types::GetServiceEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1236
|
+
#
|
1237
|
+
# * {Types::GetServiceEndpointResponse#service_type #service_type} => String
|
1238
|
+
# * {Types::GetServiceEndpointResponse#service_endpoint #service_endpoint} => String
|
1239
|
+
# * {Types::GetServiceEndpointResponse#server_trust #server_trust} => String
|
1240
|
+
#
|
1241
|
+
# @example Request syntax with placeholder values
|
1242
|
+
#
|
1243
|
+
# resp = client.get_service_endpoint({
|
1244
|
+
# service_type: "CUPS", # accepts CUPS, LNS
|
1245
|
+
# })
|
1246
|
+
#
|
1247
|
+
# @example Response structure
|
1248
|
+
#
|
1249
|
+
# resp.service_type #=> String, one of "CUPS", "LNS"
|
1250
|
+
# resp.service_endpoint #=> String
|
1251
|
+
# resp.server_trust #=> String
|
1252
|
+
#
|
1253
|
+
# @overload get_service_endpoint(params = {})
|
1254
|
+
# @param [Hash] params ({})
|
1255
|
+
def get_service_endpoint(params = {}, options = {})
|
1256
|
+
req = build_request(:get_service_endpoint, params)
|
1257
|
+
req.send_request(options)
|
1258
|
+
end
|
1259
|
+
|
1260
|
+
# Gets information about a service profile.
|
1261
|
+
#
|
1262
|
+
# @option params [required, String] :id
|
1263
|
+
# The ID of the resource to get.
|
1264
|
+
#
|
1265
|
+
# @return [Types::GetServiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1266
|
+
#
|
1267
|
+
# * {Types::GetServiceProfileResponse#arn #arn} => String
|
1268
|
+
# * {Types::GetServiceProfileResponse#name #name} => String
|
1269
|
+
# * {Types::GetServiceProfileResponse#id #id} => String
|
1270
|
+
# * {Types::GetServiceProfileResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANGetServiceProfileInfo
|
1271
|
+
#
|
1272
|
+
# @example Request syntax with placeholder values
|
1273
|
+
#
|
1274
|
+
# resp = client.get_service_profile({
|
1275
|
+
# id: "ServiceProfileId", # required
|
1276
|
+
# })
|
1277
|
+
#
|
1278
|
+
# @example Response structure
|
1279
|
+
#
|
1280
|
+
# resp.arn #=> String
|
1281
|
+
# resp.name #=> String
|
1282
|
+
# resp.id #=> String
|
1283
|
+
# resp.lo_ra_wan.ul_rate #=> Integer
|
1284
|
+
# resp.lo_ra_wan.ul_bucket_size #=> Integer
|
1285
|
+
# resp.lo_ra_wan.ul_rate_policy #=> String
|
1286
|
+
# resp.lo_ra_wan.dl_rate #=> Integer
|
1287
|
+
# resp.lo_ra_wan.dl_bucket_size #=> Integer
|
1288
|
+
# resp.lo_ra_wan.dl_rate_policy #=> String
|
1289
|
+
# resp.lo_ra_wan.add_gw_metadata #=> Boolean
|
1290
|
+
# resp.lo_ra_wan.dev_status_req_freq #=> Integer
|
1291
|
+
# resp.lo_ra_wan.report_dev_status_battery #=> Boolean
|
1292
|
+
# resp.lo_ra_wan.report_dev_status_margin #=> Boolean
|
1293
|
+
# resp.lo_ra_wan.dr_min #=> Integer
|
1294
|
+
# resp.lo_ra_wan.dr_max #=> Integer
|
1295
|
+
# resp.lo_ra_wan.channel_mask #=> String
|
1296
|
+
# resp.lo_ra_wan.pr_allowed #=> Boolean
|
1297
|
+
# resp.lo_ra_wan.hr_allowed #=> Boolean
|
1298
|
+
# resp.lo_ra_wan.ra_allowed #=> Boolean
|
1299
|
+
# resp.lo_ra_wan.nwk_geo_loc #=> Boolean
|
1300
|
+
# resp.lo_ra_wan.target_per #=> Integer
|
1301
|
+
# resp.lo_ra_wan.min_gw_diversity #=> Integer
|
1302
|
+
#
|
1303
|
+
# @overload get_service_profile(params = {})
|
1304
|
+
# @param [Hash] params ({})
|
1305
|
+
def get_service_profile(params = {}, options = {})
|
1306
|
+
req = build_request(:get_service_profile, params)
|
1307
|
+
req.send_request(options)
|
1308
|
+
end
|
1309
|
+
|
1310
|
+
# Gets information about a wireless device.
|
1311
|
+
#
|
1312
|
+
# @option params [required, String] :identifier
|
1313
|
+
# The identifier of the wireless device to get.
|
1314
|
+
#
|
1315
|
+
# @option params [required, String] :identifier_type
|
1316
|
+
# The type of identifier used in `identifier`.
|
1317
|
+
#
|
1318
|
+
# @return [Types::GetWirelessDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1319
|
+
#
|
1320
|
+
# * {Types::GetWirelessDeviceResponse#type #type} => String
|
1321
|
+
# * {Types::GetWirelessDeviceResponse#name #name} => String
|
1322
|
+
# * {Types::GetWirelessDeviceResponse#description #description} => String
|
1323
|
+
# * {Types::GetWirelessDeviceResponse#destination_name #destination_name} => String
|
1324
|
+
# * {Types::GetWirelessDeviceResponse#id #id} => String
|
1325
|
+
# * {Types::GetWirelessDeviceResponse#arn #arn} => String
|
1326
|
+
# * {Types::GetWirelessDeviceResponse#thing_name #thing_name} => String
|
1327
|
+
# * {Types::GetWirelessDeviceResponse#thing_arn #thing_arn} => String
|
1328
|
+
# * {Types::GetWirelessDeviceResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANDevice
|
1329
|
+
#
|
1330
|
+
# @example Request syntax with placeholder values
|
1331
|
+
#
|
1332
|
+
# resp = client.get_wireless_device({
|
1333
|
+
# identifier: "Identifier", # required
|
1334
|
+
# identifier_type: "WirelessDeviceId", # required, accepts WirelessDeviceId, DevEui, ThingName
|
1335
|
+
# })
|
1336
|
+
#
|
1337
|
+
# @example Response structure
|
1338
|
+
#
|
1339
|
+
# resp.type #=> String, one of "Sidewalk", "LoRaWAN"
|
1340
|
+
# resp.name #=> String
|
1341
|
+
# resp.description #=> String
|
1342
|
+
# resp.destination_name #=> String
|
1343
|
+
# resp.id #=> String
|
1344
|
+
# resp.arn #=> String
|
1345
|
+
# resp.thing_name #=> String
|
1346
|
+
# resp.thing_arn #=> String
|
1347
|
+
# resp.lo_ra_wan.dev_eui #=> String
|
1348
|
+
# resp.lo_ra_wan.device_profile_id #=> String
|
1349
|
+
# resp.lo_ra_wan.service_profile_id #=> String
|
1350
|
+
# resp.lo_ra_wan.otaa_v1_1.app_key #=> String
|
1351
|
+
# resp.lo_ra_wan.otaa_v1_1.nwk_key #=> String
|
1352
|
+
# resp.lo_ra_wan.otaa_v1_1.join_eui #=> String
|
1353
|
+
# resp.lo_ra_wan.otaa_v1_0_x.app_key #=> String
|
1354
|
+
# resp.lo_ra_wan.otaa_v1_0_x.app_eui #=> String
|
1355
|
+
# resp.lo_ra_wan.abp_v1_1.dev_addr #=> String
|
1356
|
+
# resp.lo_ra_wan.abp_v1_1.session_keys.f_nwk_s_int_key #=> String
|
1357
|
+
# resp.lo_ra_wan.abp_v1_1.session_keys.s_nwk_s_int_key #=> String
|
1358
|
+
# resp.lo_ra_wan.abp_v1_1.session_keys.nwk_s_enc_key #=> String
|
1359
|
+
# resp.lo_ra_wan.abp_v1_1.session_keys.app_s_key #=> String
|
1360
|
+
# resp.lo_ra_wan.abp_v1_0_x.dev_addr #=> String
|
1361
|
+
# resp.lo_ra_wan.abp_v1_0_x.session_keys.nwk_s_key #=> String
|
1362
|
+
# resp.lo_ra_wan.abp_v1_0_x.session_keys.app_s_key #=> String
|
1363
|
+
#
|
1364
|
+
# @overload get_wireless_device(params = {})
|
1365
|
+
# @param [Hash] params ({})
|
1366
|
+
def get_wireless_device(params = {}, options = {})
|
1367
|
+
req = build_request(:get_wireless_device, params)
|
1368
|
+
req.send_request(options)
|
1369
|
+
end
|
1370
|
+
|
1371
|
+
# Gets operating information about a wireless device.
|
1372
|
+
#
|
1373
|
+
# @option params [required, String] :wireless_device_id
|
1374
|
+
# The ID of the wireless device for which to get the data.
|
1375
|
+
#
|
1376
|
+
# @return [Types::GetWirelessDeviceStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1377
|
+
#
|
1378
|
+
# * {Types::GetWirelessDeviceStatisticsResponse#wireless_device_id #wireless_device_id} => String
|
1379
|
+
# * {Types::GetWirelessDeviceStatisticsResponse#last_uplink_received_at #last_uplink_received_at} => String
|
1380
|
+
# * {Types::GetWirelessDeviceStatisticsResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANDeviceMetadata
|
1381
|
+
#
|
1382
|
+
# @example Request syntax with placeholder values
|
1383
|
+
#
|
1384
|
+
# resp = client.get_wireless_device_statistics({
|
1385
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
1386
|
+
# })
|
1387
|
+
#
|
1388
|
+
# @example Response structure
|
1389
|
+
#
|
1390
|
+
# resp.wireless_device_id #=> String
|
1391
|
+
# resp.last_uplink_received_at #=> String
|
1392
|
+
# resp.lo_ra_wan.dev_eui #=> String
|
1393
|
+
# resp.lo_ra_wan.f_port #=> Integer
|
1394
|
+
# resp.lo_ra_wan.data_rate #=> Integer
|
1395
|
+
# resp.lo_ra_wan.frequency #=> Integer
|
1396
|
+
# resp.lo_ra_wan.timestamp #=> String
|
1397
|
+
# resp.lo_ra_wan.gateways #=> Array
|
1398
|
+
# resp.lo_ra_wan.gateways[0].gateway_eui #=> String
|
1399
|
+
# resp.lo_ra_wan.gateways[0].snr #=> Float
|
1400
|
+
# resp.lo_ra_wan.gateways[0].rssi #=> Float
|
1401
|
+
#
|
1402
|
+
# @overload get_wireless_device_statistics(params = {})
|
1403
|
+
# @param [Hash] params ({})
|
1404
|
+
def get_wireless_device_statistics(params = {}, options = {})
|
1405
|
+
req = build_request(:get_wireless_device_statistics, params)
|
1406
|
+
req.send_request(options)
|
1407
|
+
end
|
1408
|
+
|
1409
|
+
# Gets information about a wireless gateway.
|
1410
|
+
#
|
1411
|
+
# @option params [required, String] :identifier
|
1412
|
+
# The identifier of the wireless gateway to get.
|
1413
|
+
#
|
1414
|
+
# @option params [required, String] :identifier_type
|
1415
|
+
# The type of identifier used in `identifier`.
|
1416
|
+
#
|
1417
|
+
# @return [Types::GetWirelessGatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1418
|
+
#
|
1419
|
+
# * {Types::GetWirelessGatewayResponse#name #name} => String
|
1420
|
+
# * {Types::GetWirelessGatewayResponse#id #id} => String
|
1421
|
+
# * {Types::GetWirelessGatewayResponse#description #description} => String
|
1422
|
+
# * {Types::GetWirelessGatewayResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANGateway
|
1423
|
+
# * {Types::GetWirelessGatewayResponse#arn #arn} => String
|
1424
|
+
# * {Types::GetWirelessGatewayResponse#thing_name #thing_name} => String
|
1425
|
+
# * {Types::GetWirelessGatewayResponse#thing_arn #thing_arn} => String
|
1426
|
+
#
|
1427
|
+
# @example Request syntax with placeholder values
|
1428
|
+
#
|
1429
|
+
# resp = client.get_wireless_gateway({
|
1430
|
+
# identifier: "Identifier", # required
|
1431
|
+
# identifier_type: "GatewayEui", # required, accepts GatewayEui, WirelessGatewayId, ThingName
|
1432
|
+
# })
|
1433
|
+
#
|
1434
|
+
# @example Response structure
|
1435
|
+
#
|
1436
|
+
# resp.name #=> String
|
1437
|
+
# resp.id #=> String
|
1438
|
+
# resp.description #=> String
|
1439
|
+
# resp.lo_ra_wan.gateway_eui #=> String
|
1440
|
+
# resp.lo_ra_wan.rf_region #=> String
|
1441
|
+
# resp.arn #=> String
|
1442
|
+
# resp.thing_name #=> String
|
1443
|
+
# resp.thing_arn #=> String
|
1444
|
+
#
|
1445
|
+
# @overload get_wireless_gateway(params = {})
|
1446
|
+
# @param [Hash] params ({})
|
1447
|
+
def get_wireless_gateway(params = {}, options = {})
|
1448
|
+
req = build_request(:get_wireless_gateway, params)
|
1449
|
+
req.send_request(options)
|
1450
|
+
end
|
1451
|
+
|
1452
|
+
# Gets the ID of the certificate that is currently associated with a
|
1453
|
+
# wireless gateway.
|
1454
|
+
#
|
1455
|
+
# @option params [required, String] :id
|
1456
|
+
# The ID of the resource to get.
|
1457
|
+
#
|
1458
|
+
# @return [Types::GetWirelessGatewayCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1459
|
+
#
|
1460
|
+
# * {Types::GetWirelessGatewayCertificateResponse#iot_certificate_id #iot_certificate_id} => String
|
1461
|
+
#
|
1462
|
+
# @example Request syntax with placeholder values
|
1463
|
+
#
|
1464
|
+
# resp = client.get_wireless_gateway_certificate({
|
1465
|
+
# id: "WirelessGatewayId", # required
|
1466
|
+
# })
|
1467
|
+
#
|
1468
|
+
# @example Response structure
|
1469
|
+
#
|
1470
|
+
# resp.iot_certificate_id #=> String
|
1471
|
+
#
|
1472
|
+
# @overload get_wireless_gateway_certificate(params = {})
|
1473
|
+
# @param [Hash] params ({})
|
1474
|
+
def get_wireless_gateway_certificate(params = {}, options = {})
|
1475
|
+
req = build_request(:get_wireless_gateway_certificate, params)
|
1476
|
+
req.send_request(options)
|
1477
|
+
end
|
1478
|
+
|
1479
|
+
# Gets the firmware version and other information about a wireless
|
1480
|
+
# gateway.
|
1481
|
+
#
|
1482
|
+
# @option params [required, String] :id
|
1483
|
+
# The ID of the resource to get.
|
1484
|
+
#
|
1485
|
+
# @return [Types::GetWirelessGatewayFirmwareInformationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1486
|
+
#
|
1487
|
+
# * {Types::GetWirelessGatewayFirmwareInformationResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANGatewayCurrentVersion
|
1488
|
+
#
|
1489
|
+
# @example Request syntax with placeholder values
|
1490
|
+
#
|
1491
|
+
# resp = client.get_wireless_gateway_firmware_information({
|
1492
|
+
# id: "WirelessGatewayId", # required
|
1493
|
+
# })
|
1494
|
+
#
|
1495
|
+
# @example Response structure
|
1496
|
+
#
|
1497
|
+
# resp.lo_ra_wan.current_version.package_version #=> String
|
1498
|
+
# resp.lo_ra_wan.current_version.model #=> String
|
1499
|
+
# resp.lo_ra_wan.current_version.station #=> String
|
1500
|
+
#
|
1501
|
+
# @overload get_wireless_gateway_firmware_information(params = {})
|
1502
|
+
# @param [Hash] params ({})
|
1503
|
+
def get_wireless_gateway_firmware_information(params = {}, options = {})
|
1504
|
+
req = build_request(:get_wireless_gateway_firmware_information, params)
|
1505
|
+
req.send_request(options)
|
1506
|
+
end
|
1507
|
+
|
1508
|
+
# Gets operating information about a wireless gateway.
|
1509
|
+
#
|
1510
|
+
# @option params [required, String] :wireless_gateway_id
|
1511
|
+
# The ID of the wireless gateway for which to get the data.
|
1512
|
+
#
|
1513
|
+
# @return [Types::GetWirelessGatewayStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1514
|
+
#
|
1515
|
+
# * {Types::GetWirelessGatewayStatisticsResponse#wireless_gateway_id #wireless_gateway_id} => String
|
1516
|
+
# * {Types::GetWirelessGatewayStatisticsResponse#last_uplink_received_at #last_uplink_received_at} => String
|
1517
|
+
#
|
1518
|
+
# @example Request syntax with placeholder values
|
1519
|
+
#
|
1520
|
+
# resp = client.get_wireless_gateway_statistics({
|
1521
|
+
# wireless_gateway_id: "WirelessGatewayId", # required
|
1522
|
+
# })
|
1523
|
+
#
|
1524
|
+
# @example Response structure
|
1525
|
+
#
|
1526
|
+
# resp.wireless_gateway_id #=> String
|
1527
|
+
# resp.last_uplink_received_at #=> String
|
1528
|
+
#
|
1529
|
+
# @overload get_wireless_gateway_statistics(params = {})
|
1530
|
+
# @param [Hash] params ({})
|
1531
|
+
def get_wireless_gateway_statistics(params = {}, options = {})
|
1532
|
+
req = build_request(:get_wireless_gateway_statistics, params)
|
1533
|
+
req.send_request(options)
|
1534
|
+
end
|
1535
|
+
|
1536
|
+
# Gets information about a wireless gateway task.
|
1537
|
+
#
|
1538
|
+
# @option params [required, String] :id
|
1539
|
+
# The ID of the resource to get.
|
1540
|
+
#
|
1541
|
+
# @return [Types::GetWirelessGatewayTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1542
|
+
#
|
1543
|
+
# * {Types::GetWirelessGatewayTaskResponse#wireless_gateway_id #wireless_gateway_id} => String
|
1544
|
+
# * {Types::GetWirelessGatewayTaskResponse#wireless_gateway_task_definition_id #wireless_gateway_task_definition_id} => String
|
1545
|
+
# * {Types::GetWirelessGatewayTaskResponse#last_uplink_received_at #last_uplink_received_at} => String
|
1546
|
+
# * {Types::GetWirelessGatewayTaskResponse#task_created_at #task_created_at} => String
|
1547
|
+
# * {Types::GetWirelessGatewayTaskResponse#status #status} => String
|
1548
|
+
#
|
1549
|
+
# @example Request syntax with placeholder values
|
1550
|
+
#
|
1551
|
+
# resp = client.get_wireless_gateway_task({
|
1552
|
+
# id: "WirelessGatewayId", # required
|
1553
|
+
# })
|
1554
|
+
#
|
1555
|
+
# @example Response structure
|
1556
|
+
#
|
1557
|
+
# resp.wireless_gateway_id #=> String
|
1558
|
+
# resp.wireless_gateway_task_definition_id #=> String
|
1559
|
+
# resp.last_uplink_received_at #=> String
|
1560
|
+
# resp.task_created_at #=> String
|
1561
|
+
# resp.status #=> String, one of "PENDING", "IN_PROGRESS", "FIRST_RETRY", "SECOND_RETRY", "COMPLETED", "FAILED"
|
1562
|
+
#
|
1563
|
+
# @overload get_wireless_gateway_task(params = {})
|
1564
|
+
# @param [Hash] params ({})
|
1565
|
+
def get_wireless_gateway_task(params = {}, options = {})
|
1566
|
+
req = build_request(:get_wireless_gateway_task, params)
|
1567
|
+
req.send_request(options)
|
1568
|
+
end
|
1569
|
+
|
1570
|
+
# Gets information about a wireless gateway task definition.
|
1571
|
+
#
|
1572
|
+
# @option params [required, String] :id
|
1573
|
+
# The ID of the resource to get.
|
1574
|
+
#
|
1575
|
+
# @return [Types::GetWirelessGatewayTaskDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1576
|
+
#
|
1577
|
+
# * {Types::GetWirelessGatewayTaskDefinitionResponse#auto_create_tasks #auto_create_tasks} => Boolean
|
1578
|
+
# * {Types::GetWirelessGatewayTaskDefinitionResponse#name #name} => String
|
1579
|
+
# * {Types::GetWirelessGatewayTaskDefinitionResponse#update #update} => Types::UpdateWirelessGatewayTaskCreate
|
1580
|
+
#
|
1581
|
+
# @example Request syntax with placeholder values
|
1582
|
+
#
|
1583
|
+
# resp = client.get_wireless_gateway_task_definition({
|
1584
|
+
# id: "WirelessGatewayTaskDefinitionId", # required
|
1585
|
+
# })
|
1586
|
+
#
|
1587
|
+
# @example Response structure
|
1588
|
+
#
|
1589
|
+
# resp.auto_create_tasks #=> Boolean
|
1590
|
+
# resp.name #=> String
|
1591
|
+
# resp.update.update_data_source #=> String
|
1592
|
+
# resp.update.update_data_role #=> String
|
1593
|
+
# resp.update.lo_ra_wan.update_signature #=> String
|
1594
|
+
# resp.update.lo_ra_wan.sig_key_crc #=> Integer
|
1595
|
+
# resp.update.lo_ra_wan.current_version.package_version #=> String
|
1596
|
+
# resp.update.lo_ra_wan.current_version.model #=> String
|
1597
|
+
# resp.update.lo_ra_wan.current_version.station #=> String
|
1598
|
+
# resp.update.lo_ra_wan.update_version.package_version #=> String
|
1599
|
+
# resp.update.lo_ra_wan.update_version.model #=> String
|
1600
|
+
# resp.update.lo_ra_wan.update_version.station #=> String
|
1601
|
+
#
|
1602
|
+
# @overload get_wireless_gateway_task_definition(params = {})
|
1603
|
+
# @param [Hash] params ({})
|
1604
|
+
def get_wireless_gateway_task_definition(params = {}, options = {})
|
1605
|
+
req = build_request(:get_wireless_gateway_task_definition, params)
|
1606
|
+
req.send_request(options)
|
1607
|
+
end
|
1608
|
+
|
1609
|
+
# Lists the destinations registered to your AWS account.
|
1610
|
+
#
|
1611
|
+
# @option params [Integer] :max_results
|
1612
|
+
# The maximum number of results to return in this operation.
|
1613
|
+
#
|
1614
|
+
# @option params [String] :next_token
|
1615
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
1616
|
+
# previous response; otherwise **null** to receive the first set of
|
1617
|
+
# results.
|
1618
|
+
#
|
1619
|
+
# @return [Types::ListDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1620
|
+
#
|
1621
|
+
# * {Types::ListDestinationsResponse#next_token #next_token} => String
|
1622
|
+
# * {Types::ListDestinationsResponse#destination_list #destination_list} => Array<Types::Destinations>
|
1623
|
+
#
|
1624
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1625
|
+
#
|
1626
|
+
# @example Request syntax with placeholder values
|
1627
|
+
#
|
1628
|
+
# resp = client.list_destinations({
|
1629
|
+
# max_results: 1,
|
1630
|
+
# next_token: "NextToken",
|
1631
|
+
# })
|
1632
|
+
#
|
1633
|
+
# @example Response structure
|
1634
|
+
#
|
1635
|
+
# resp.next_token #=> String
|
1636
|
+
# resp.destination_list #=> Array
|
1637
|
+
# resp.destination_list[0].arn #=> String
|
1638
|
+
# resp.destination_list[0].name #=> String
|
1639
|
+
# resp.destination_list[0].expression_type #=> String, one of "RuleName"
|
1640
|
+
# resp.destination_list[0].expression #=> String
|
1641
|
+
# resp.destination_list[0].description #=> String
|
1642
|
+
# resp.destination_list[0].role_arn #=> String
|
1643
|
+
#
|
1644
|
+
# @overload list_destinations(params = {})
|
1645
|
+
# @param [Hash] params ({})
|
1646
|
+
def list_destinations(params = {}, options = {})
|
1647
|
+
req = build_request(:list_destinations, params)
|
1648
|
+
req.send_request(options)
|
1649
|
+
end
|
1650
|
+
|
1651
|
+
# Lists the device profiles registered to your AWS account.
|
1652
|
+
#
|
1653
|
+
# @option params [String] :next_token
|
1654
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
1655
|
+
# previous response; otherwise **null** to receive the first set of
|
1656
|
+
# results.
|
1657
|
+
#
|
1658
|
+
# @option params [Integer] :max_results
|
1659
|
+
# The maximum number of results to return in this operation.
|
1660
|
+
#
|
1661
|
+
# @return [Types::ListDeviceProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1662
|
+
#
|
1663
|
+
# * {Types::ListDeviceProfilesResponse#next_token #next_token} => String
|
1664
|
+
# * {Types::ListDeviceProfilesResponse#device_profile_list #device_profile_list} => Array<Types::DeviceProfile>
|
1665
|
+
#
|
1666
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1667
|
+
#
|
1668
|
+
# @example Request syntax with placeholder values
|
1669
|
+
#
|
1670
|
+
# resp = client.list_device_profiles({
|
1671
|
+
# next_token: "NextToken",
|
1672
|
+
# max_results: 1,
|
1673
|
+
# })
|
1674
|
+
#
|
1675
|
+
# @example Response structure
|
1676
|
+
#
|
1677
|
+
# resp.next_token #=> String
|
1678
|
+
# resp.device_profile_list #=> Array
|
1679
|
+
# resp.device_profile_list[0].arn #=> String
|
1680
|
+
# resp.device_profile_list[0].name #=> String
|
1681
|
+
# resp.device_profile_list[0].id #=> String
|
1682
|
+
#
|
1683
|
+
# @overload list_device_profiles(params = {})
|
1684
|
+
# @param [Hash] params ({})
|
1685
|
+
def list_device_profiles(params = {}, options = {})
|
1686
|
+
req = build_request(:list_device_profiles, params)
|
1687
|
+
req.send_request(options)
|
1688
|
+
end
|
1689
|
+
|
1690
|
+
# Lists the partner accounts associated with your AWS account.
|
1691
|
+
#
|
1692
|
+
# @option params [String] :next_token
|
1693
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
1694
|
+
# previous response; otherwise **null** to receive the first set of
|
1695
|
+
# results.
|
1696
|
+
#
|
1697
|
+
# @option params [Integer] :max_results
|
1698
|
+
# The maximum number of results to return in this operation.
|
1699
|
+
#
|
1700
|
+
# @return [Types::ListPartnerAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1701
|
+
#
|
1702
|
+
# * {Types::ListPartnerAccountsResponse#next_token #next_token} => String
|
1703
|
+
# * {Types::ListPartnerAccountsResponse#sidewalk #sidewalk} => Array<Types::SidewalkAccountInfoWithFingerprint>
|
1704
|
+
#
|
1705
|
+
# @example Request syntax with placeholder values
|
1706
|
+
#
|
1707
|
+
# resp = client.list_partner_accounts({
|
1708
|
+
# next_token: "NextToken",
|
1709
|
+
# max_results: 1,
|
1710
|
+
# })
|
1711
|
+
#
|
1712
|
+
# @example Response structure
|
1713
|
+
#
|
1714
|
+
# resp.next_token #=> String
|
1715
|
+
# resp.sidewalk #=> Array
|
1716
|
+
# resp.sidewalk[0].amazon_id #=> String
|
1717
|
+
# resp.sidewalk[0].app_server_private_key #=> String
|
1718
|
+
#
|
1719
|
+
# @overload list_partner_accounts(params = {})
|
1720
|
+
# @param [Hash] params ({})
|
1721
|
+
def list_partner_accounts(params = {}, options = {})
|
1722
|
+
req = build_request(:list_partner_accounts, params)
|
1723
|
+
req.send_request(options)
|
1724
|
+
end
|
1725
|
+
|
1726
|
+
# Lists the service profiles registered to your AWS account.
|
1727
|
+
#
|
1728
|
+
# @option params [String] :next_token
|
1729
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
1730
|
+
# previous response; otherwise **null** to receive the first set of
|
1731
|
+
# results.
|
1732
|
+
#
|
1733
|
+
# @option params [Integer] :max_results
|
1734
|
+
# The maximum number of results to return in this operation.
|
1735
|
+
#
|
1736
|
+
# @return [Types::ListServiceProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1737
|
+
#
|
1738
|
+
# * {Types::ListServiceProfilesResponse#next_token #next_token} => String
|
1739
|
+
# * {Types::ListServiceProfilesResponse#service_profile_list #service_profile_list} => Array<Types::ServiceProfile>
|
1740
|
+
#
|
1741
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1742
|
+
#
|
1743
|
+
# @example Request syntax with placeholder values
|
1744
|
+
#
|
1745
|
+
# resp = client.list_service_profiles({
|
1746
|
+
# next_token: "NextToken",
|
1747
|
+
# max_results: 1,
|
1748
|
+
# })
|
1749
|
+
#
|
1750
|
+
# @example Response structure
|
1751
|
+
#
|
1752
|
+
# resp.next_token #=> String
|
1753
|
+
# resp.service_profile_list #=> Array
|
1754
|
+
# resp.service_profile_list[0].arn #=> String
|
1755
|
+
# resp.service_profile_list[0].name #=> String
|
1756
|
+
# resp.service_profile_list[0].id #=> String
|
1757
|
+
#
|
1758
|
+
# @overload list_service_profiles(params = {})
|
1759
|
+
# @param [Hash] params ({})
|
1760
|
+
def list_service_profiles(params = {}, options = {})
|
1761
|
+
req = build_request(:list_service_profiles, params)
|
1762
|
+
req.send_request(options)
|
1763
|
+
end
|
1764
|
+
|
1765
|
+
# Lists the tags (metadata) you have assigned to the resource.
|
1766
|
+
#
|
1767
|
+
# @option params [required, String] :resource_arn
|
1768
|
+
# The ARN of the resource for which to list tags.
|
1769
|
+
#
|
1770
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1771
|
+
#
|
1772
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1773
|
+
#
|
1774
|
+
# @example Request syntax with placeholder values
|
1775
|
+
#
|
1776
|
+
# resp = client.list_tags_for_resource({
|
1777
|
+
# resource_arn: "AmazonResourceName", # required
|
1778
|
+
# })
|
1779
|
+
#
|
1780
|
+
# @example Response structure
|
1781
|
+
#
|
1782
|
+
# resp.tags #=> Array
|
1783
|
+
# resp.tags[0].key #=> String
|
1784
|
+
# resp.tags[0].value #=> String
|
1785
|
+
#
|
1786
|
+
# @overload list_tags_for_resource(params = {})
|
1787
|
+
# @param [Hash] params ({})
|
1788
|
+
def list_tags_for_resource(params = {}, options = {})
|
1789
|
+
req = build_request(:list_tags_for_resource, params)
|
1790
|
+
req.send_request(options)
|
1791
|
+
end
|
1792
|
+
|
1793
|
+
# Lists the wireless devices registered to your AWS account.
|
1794
|
+
#
|
1795
|
+
# @option params [Integer] :max_results
|
1796
|
+
# The maximum number of results to return in this operation.
|
1797
|
+
#
|
1798
|
+
# @option params [String] :next_token
|
1799
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
1800
|
+
# previous response; otherwise **null** to receive the first set of
|
1801
|
+
# results.
|
1802
|
+
#
|
1803
|
+
# @option params [String] :destination_name
|
1804
|
+
# A filter to list only the wireless devices that use this destination.
|
1805
|
+
#
|
1806
|
+
# @option params [String] :device_profile_id
|
1807
|
+
# A filter to list only the wireless devices that use this device
|
1808
|
+
# profile.
|
1809
|
+
#
|
1810
|
+
# @option params [String] :service_profile_id
|
1811
|
+
# A filter to list only the wireless devices that use this service
|
1812
|
+
# profile.
|
1813
|
+
#
|
1814
|
+
# @option params [String] :wireless_device_type
|
1815
|
+
# A filter to list only the wireless devices that use this wireless
|
1816
|
+
# device type.
|
1817
|
+
#
|
1818
|
+
# @return [Types::ListWirelessDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1819
|
+
#
|
1820
|
+
# * {Types::ListWirelessDevicesResponse#next_token #next_token} => String
|
1821
|
+
# * {Types::ListWirelessDevicesResponse#wireless_device_list #wireless_device_list} => Array<Types::WirelessDeviceStatistics>
|
1822
|
+
#
|
1823
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1824
|
+
#
|
1825
|
+
# @example Request syntax with placeholder values
|
1826
|
+
#
|
1827
|
+
# resp = client.list_wireless_devices({
|
1828
|
+
# max_results: 1,
|
1829
|
+
# next_token: "NextToken",
|
1830
|
+
# destination_name: "DestinationName",
|
1831
|
+
# device_profile_id: "DeviceProfileId",
|
1832
|
+
# service_profile_id: "ServiceProfileId",
|
1833
|
+
# wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
|
1834
|
+
# })
|
1835
|
+
#
|
1836
|
+
# @example Response structure
|
1837
|
+
#
|
1838
|
+
# resp.next_token #=> String
|
1839
|
+
# resp.wireless_device_list #=> Array
|
1840
|
+
# resp.wireless_device_list[0].arn #=> String
|
1841
|
+
# resp.wireless_device_list[0].id #=> String
|
1842
|
+
# resp.wireless_device_list[0].type #=> String, one of "Sidewalk", "LoRaWAN"
|
1843
|
+
# resp.wireless_device_list[0].name #=> String
|
1844
|
+
# resp.wireless_device_list[0].destination_name #=> String
|
1845
|
+
# resp.wireless_device_list[0].last_uplink_received_at #=> String
|
1846
|
+
# resp.wireless_device_list[0].lo_ra_wan.dev_eui #=> String
|
1847
|
+
# resp.wireless_device_list[0].sidewalk.amazon_id #=> String
|
1848
|
+
#
|
1849
|
+
# @overload list_wireless_devices(params = {})
|
1850
|
+
# @param [Hash] params ({})
|
1851
|
+
def list_wireless_devices(params = {}, options = {})
|
1852
|
+
req = build_request(:list_wireless_devices, params)
|
1853
|
+
req.send_request(options)
|
1854
|
+
end
|
1855
|
+
|
1856
|
+
# List the wireless gateway tasks definitions registered to your AWS
|
1857
|
+
# account.
|
1858
|
+
#
|
1859
|
+
# @option params [Integer] :max_results
|
1860
|
+
# The maximum number of results to return in this operation.
|
1861
|
+
#
|
1862
|
+
# @option params [String] :next_token
|
1863
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
1864
|
+
# previous response; otherwise **null** to receive the first set of
|
1865
|
+
# results.
|
1866
|
+
#
|
1867
|
+
# @option params [String] :task_definition_type
|
1868
|
+
# A filter to list only the wireless gateway task definitions that use
|
1869
|
+
# this task definition type.
|
1870
|
+
#
|
1871
|
+
# @return [Types::ListWirelessGatewayTaskDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1872
|
+
#
|
1873
|
+
# * {Types::ListWirelessGatewayTaskDefinitionsResponse#next_token #next_token} => String
|
1874
|
+
# * {Types::ListWirelessGatewayTaskDefinitionsResponse#task_definitions #task_definitions} => Array<Types::UpdateWirelessGatewayTaskEntry>
|
1875
|
+
#
|
1876
|
+
# @example Request syntax with placeholder values
|
1877
|
+
#
|
1878
|
+
# resp = client.list_wireless_gateway_task_definitions({
|
1879
|
+
# max_results: 1,
|
1880
|
+
# next_token: "NextToken",
|
1881
|
+
# task_definition_type: "UPDATE", # accepts UPDATE
|
1882
|
+
# })
|
1883
|
+
#
|
1884
|
+
# @example Response structure
|
1885
|
+
#
|
1886
|
+
# resp.next_token #=> String
|
1887
|
+
# resp.task_definitions #=> Array
|
1888
|
+
# resp.task_definitions[0].id #=> String
|
1889
|
+
# resp.task_definitions[0].lo_ra_wan.current_version.package_version #=> String
|
1890
|
+
# resp.task_definitions[0].lo_ra_wan.current_version.model #=> String
|
1891
|
+
# resp.task_definitions[0].lo_ra_wan.current_version.station #=> String
|
1892
|
+
# resp.task_definitions[0].lo_ra_wan.update_version.package_version #=> String
|
1893
|
+
# resp.task_definitions[0].lo_ra_wan.update_version.model #=> String
|
1894
|
+
# resp.task_definitions[0].lo_ra_wan.update_version.station #=> String
|
1895
|
+
#
|
1896
|
+
# @overload list_wireless_gateway_task_definitions(params = {})
|
1897
|
+
# @param [Hash] params ({})
|
1898
|
+
def list_wireless_gateway_task_definitions(params = {}, options = {})
|
1899
|
+
req = build_request(:list_wireless_gateway_task_definitions, params)
|
1900
|
+
req.send_request(options)
|
1901
|
+
end
|
1902
|
+
|
1903
|
+
# Lists the wireless gateways registered to your AWS account.
|
1904
|
+
#
|
1905
|
+
# @option params [String] :next_token
|
1906
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
1907
|
+
# previous response; otherwise **null** to receive the first set of
|
1908
|
+
# results.
|
1909
|
+
#
|
1910
|
+
# @option params [Integer] :max_results
|
1911
|
+
# The maximum number of results to return in this operation.
|
1912
|
+
#
|
1913
|
+
# @return [Types::ListWirelessGatewaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1914
|
+
#
|
1915
|
+
# * {Types::ListWirelessGatewaysResponse#next_token #next_token} => String
|
1916
|
+
# * {Types::ListWirelessGatewaysResponse#wireless_gateway_list #wireless_gateway_list} => Array<Types::WirelessGatewayStatistics>
|
1917
|
+
#
|
1918
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1919
|
+
#
|
1920
|
+
# @example Request syntax with placeholder values
|
1921
|
+
#
|
1922
|
+
# resp = client.list_wireless_gateways({
|
1923
|
+
# next_token: "NextToken",
|
1924
|
+
# max_results: 1,
|
1925
|
+
# })
|
1926
|
+
#
|
1927
|
+
# @example Response structure
|
1928
|
+
#
|
1929
|
+
# resp.next_token #=> String
|
1930
|
+
# resp.wireless_gateway_list #=> Array
|
1931
|
+
# resp.wireless_gateway_list[0].arn #=> String
|
1932
|
+
# resp.wireless_gateway_list[0].id #=> String
|
1933
|
+
# resp.wireless_gateway_list[0].name #=> String
|
1934
|
+
# resp.wireless_gateway_list[0].description #=> String
|
1935
|
+
# resp.wireless_gateway_list[0].lo_ra_wan.gateway_eui #=> String
|
1936
|
+
# resp.wireless_gateway_list[0].lo_ra_wan.rf_region #=> String
|
1937
|
+
# resp.wireless_gateway_list[0].last_uplink_received_at #=> String
|
1938
|
+
#
|
1939
|
+
# @overload list_wireless_gateways(params = {})
|
1940
|
+
# @param [Hash] params ({})
|
1941
|
+
def list_wireless_gateways(params = {}, options = {})
|
1942
|
+
req = build_request(:list_wireless_gateways, params)
|
1943
|
+
req.send_request(options)
|
1944
|
+
end
|
1945
|
+
|
1946
|
+
# Sends a decrypted application data frame to a device.
|
1947
|
+
#
|
1948
|
+
# @option params [required, String] :id
|
1949
|
+
# The ID of the wireless device to receive the data.
|
1950
|
+
#
|
1951
|
+
# @option params [required, Integer] :transmit_mode
|
1952
|
+
# The transmit mode to use to send data to the wireless device. Can be:
|
1953
|
+
# `0` for UM (unacknowledge mode), `1` for AM (acknowledge mode), or `2`
|
1954
|
+
# for (TM) transparent mode.
|
1955
|
+
#
|
1956
|
+
# @option params [required, String] :payload_data
|
1957
|
+
# The message payload to send.
|
1958
|
+
#
|
1959
|
+
# @option params [Types::WirelessMetadata] :wireless_metadata
|
1960
|
+
# Metadata about the message request.
|
1961
|
+
#
|
1962
|
+
# @return [Types::SendDataToWirelessDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1963
|
+
#
|
1964
|
+
# * {Types::SendDataToWirelessDeviceResponse#message_id #message_id} => String
|
1965
|
+
#
|
1966
|
+
# @example Request syntax with placeholder values
|
1967
|
+
#
|
1968
|
+
# resp = client.send_data_to_wireless_device({
|
1969
|
+
# id: "WirelessDeviceId", # required
|
1970
|
+
# transmit_mode: 1, # required
|
1971
|
+
# payload_data: "PayloadData", # required
|
1972
|
+
# wireless_metadata: {
|
1973
|
+
# lo_ra_wan: {
|
1974
|
+
# f_port: 1,
|
1975
|
+
# },
|
1976
|
+
# sidewalk: {
|
1977
|
+
# seq: 1,
|
1978
|
+
# },
|
1979
|
+
# },
|
1980
|
+
# })
|
1981
|
+
#
|
1982
|
+
# @example Response structure
|
1983
|
+
#
|
1984
|
+
# resp.message_id #=> String
|
1985
|
+
#
|
1986
|
+
# @overload send_data_to_wireless_device(params = {})
|
1987
|
+
# @param [Hash] params ({})
|
1988
|
+
def send_data_to_wireless_device(params = {}, options = {})
|
1989
|
+
req = build_request(:send_data_to_wireless_device, params)
|
1990
|
+
req.send_request(options)
|
1991
|
+
end
|
1992
|
+
|
1993
|
+
# Adds a tag to a resource.
|
1994
|
+
#
|
1995
|
+
# @option params [required, String] :resource_arn
|
1996
|
+
# The ARN of the resource to add tags to.
|
1997
|
+
#
|
1998
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1999
|
+
# Adds to or modifies the tags of the given resource. Tags are metadata
|
2000
|
+
# that can be used to manage a resource.
|
2001
|
+
#
|
2002
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2003
|
+
#
|
2004
|
+
# @example Request syntax with placeholder values
|
2005
|
+
#
|
2006
|
+
# resp = client.tag_resource({
|
2007
|
+
# resource_arn: "AmazonResourceName", # required
|
2008
|
+
# tags: [ # required
|
2009
|
+
# {
|
2010
|
+
# key: "TagKey", # required
|
2011
|
+
# value: "TagValue", # required
|
2012
|
+
# },
|
2013
|
+
# ],
|
2014
|
+
# })
|
2015
|
+
#
|
2016
|
+
# @overload tag_resource(params = {})
|
2017
|
+
# @param [Hash] params ({})
|
2018
|
+
def tag_resource(params = {}, options = {})
|
2019
|
+
req = build_request(:tag_resource, params)
|
2020
|
+
req.send_request(options)
|
2021
|
+
end
|
2022
|
+
|
2023
|
+
# Simulates a provisioned device by sending an uplink data payload of
|
2024
|
+
# `Hello`.
|
2025
|
+
#
|
2026
|
+
# @option params [required, String] :id
|
2027
|
+
# The ID of the wireless device to test.
|
2028
|
+
#
|
2029
|
+
# @return [Types::TestWirelessDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2030
|
+
#
|
2031
|
+
# * {Types::TestWirelessDeviceResponse#result #result} => String
|
2032
|
+
#
|
2033
|
+
# @example Request syntax with placeholder values
|
2034
|
+
#
|
2035
|
+
# resp = client.test_wireless_device({
|
2036
|
+
# id: "WirelessDeviceId", # required
|
2037
|
+
# })
|
2038
|
+
#
|
2039
|
+
# @example Response structure
|
2040
|
+
#
|
2041
|
+
# resp.result #=> String
|
2042
|
+
#
|
2043
|
+
# @overload test_wireless_device(params = {})
|
2044
|
+
# @param [Hash] params ({})
|
2045
|
+
def test_wireless_device(params = {}, options = {})
|
2046
|
+
req = build_request(:test_wireless_device, params)
|
2047
|
+
req.send_request(options)
|
2048
|
+
end
|
2049
|
+
|
2050
|
+
# Removes one or more tags from a resource.
|
2051
|
+
#
|
2052
|
+
# @option params [required, String] :resource_arn
|
2053
|
+
# The ARN of the resource to remove tags from.
|
2054
|
+
#
|
2055
|
+
# @option params [required, Array<String>] :tag_keys
|
2056
|
+
# A list of the keys of the tags to remove from the resource.
|
2057
|
+
#
|
2058
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2059
|
+
#
|
2060
|
+
# @example Request syntax with placeholder values
|
2061
|
+
#
|
2062
|
+
# resp = client.untag_resource({
|
2063
|
+
# resource_arn: "AmazonResourceName", # required
|
2064
|
+
# tag_keys: ["TagKey"], # required
|
2065
|
+
# })
|
2066
|
+
#
|
2067
|
+
# @overload untag_resource(params = {})
|
2068
|
+
# @param [Hash] params ({})
|
2069
|
+
def untag_resource(params = {}, options = {})
|
2070
|
+
req = build_request(:untag_resource, params)
|
2071
|
+
req.send_request(options)
|
2072
|
+
end
|
2073
|
+
|
2074
|
+
# Updates properties of a destination.
|
2075
|
+
#
|
2076
|
+
# @option params [required, String] :name
|
2077
|
+
# The new name of the resource.
|
2078
|
+
#
|
2079
|
+
# @option params [String] :expression_type
|
2080
|
+
# The type of value in `Expression`.
|
2081
|
+
#
|
2082
|
+
# @option params [String] :expression
|
2083
|
+
# The new rule name or topic rule to send messages to.
|
2084
|
+
#
|
2085
|
+
# @option params [String] :description
|
2086
|
+
# A new description of the resource.
|
2087
|
+
#
|
2088
|
+
# @option params [String] :role_arn
|
2089
|
+
# The ARN of the IAM Role that authorizes the destination.
|
2090
|
+
#
|
2091
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2092
|
+
#
|
2093
|
+
# @example Request syntax with placeholder values
|
2094
|
+
#
|
2095
|
+
# resp = client.update_destination({
|
2096
|
+
# name: "DestinationName", # required
|
2097
|
+
# expression_type: "RuleName", # accepts RuleName
|
2098
|
+
# expression: "Expression",
|
2099
|
+
# description: "Description",
|
2100
|
+
# role_arn: "RoleArn",
|
2101
|
+
# })
|
2102
|
+
#
|
2103
|
+
# @overload update_destination(params = {})
|
2104
|
+
# @param [Hash] params ({})
|
2105
|
+
def update_destination(params = {}, options = {})
|
2106
|
+
req = build_request(:update_destination, params)
|
2107
|
+
req.send_request(options)
|
2108
|
+
end
|
2109
|
+
|
2110
|
+
# Updates properties of a partner account.
|
2111
|
+
#
|
2112
|
+
# @option params [required, Types::SidewalkUpdateAccount] :sidewalk
|
2113
|
+
# The Sidewalk account credentials.
|
2114
|
+
#
|
2115
|
+
# @option params [required, String] :partner_account_id
|
2116
|
+
# The ID of the partner account to update.
|
2117
|
+
#
|
2118
|
+
# @option params [required, String] :partner_type
|
2119
|
+
# The partner type.
|
2120
|
+
#
|
2121
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2122
|
+
#
|
2123
|
+
# @example Request syntax with placeholder values
|
2124
|
+
#
|
2125
|
+
# resp = client.update_partner_account({
|
2126
|
+
# sidewalk: { # required
|
2127
|
+
# app_server_private_key: "AppServerPrivateKey",
|
2128
|
+
# },
|
2129
|
+
# partner_account_id: "PartnerAccountId", # required
|
2130
|
+
# partner_type: "Sidewalk", # required, accepts Sidewalk
|
2131
|
+
# })
|
2132
|
+
#
|
2133
|
+
# @overload update_partner_account(params = {})
|
2134
|
+
# @param [Hash] params ({})
|
2135
|
+
def update_partner_account(params = {}, options = {})
|
2136
|
+
req = build_request(:update_partner_account, params)
|
2137
|
+
req.send_request(options)
|
2138
|
+
end
|
2139
|
+
|
2140
|
+
# Updates properties of a wireless device.
|
2141
|
+
#
|
2142
|
+
# @option params [required, String] :id
|
2143
|
+
# The ID of the resource to update.
|
2144
|
+
#
|
2145
|
+
# @option params [String] :destination_name
|
2146
|
+
# The name of the new destination for the device.
|
2147
|
+
#
|
2148
|
+
# @option params [String] :name
|
2149
|
+
# The new name of the resource.
|
2150
|
+
#
|
2151
|
+
# @option params [String] :description
|
2152
|
+
# A new description of the resource.
|
2153
|
+
#
|
2154
|
+
# @option params [Types::LoRaWANUpdateDevice] :lo_ra_wan
|
2155
|
+
# The updated wireless device's configuration.
|
2156
|
+
#
|
2157
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2158
|
+
#
|
2159
|
+
# @example Request syntax with placeholder values
|
2160
|
+
#
|
2161
|
+
# resp = client.update_wireless_device({
|
2162
|
+
# id: "WirelessDeviceId", # required
|
2163
|
+
# destination_name: "DestinationName",
|
2164
|
+
# name: "WirelessDeviceName",
|
2165
|
+
# description: "Description",
|
2166
|
+
# lo_ra_wan: {
|
2167
|
+
# device_profile_id: "DeviceProfileId",
|
2168
|
+
# service_profile_id: "ServiceProfileId",
|
2169
|
+
# },
|
2170
|
+
# })
|
2171
|
+
#
|
2172
|
+
# @overload update_wireless_device(params = {})
|
2173
|
+
# @param [Hash] params ({})
|
2174
|
+
def update_wireless_device(params = {}, options = {})
|
2175
|
+
req = build_request(:update_wireless_device, params)
|
2176
|
+
req.send_request(options)
|
2177
|
+
end
|
2178
|
+
|
2179
|
+
# Updates properties of a wireless gateway.
|
2180
|
+
#
|
2181
|
+
# @option params [required, String] :id
|
2182
|
+
# The ID of the resource to update.
|
2183
|
+
#
|
2184
|
+
# @option params [String] :name
|
2185
|
+
# The new name of the resource.
|
2186
|
+
#
|
2187
|
+
# @option params [String] :description
|
2188
|
+
# A new description of the resource.
|
2189
|
+
#
|
2190
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2191
|
+
#
|
2192
|
+
# @example Request syntax with placeholder values
|
2193
|
+
#
|
2194
|
+
# resp = client.update_wireless_gateway({
|
2195
|
+
# id: "WirelessGatewayId", # required
|
2196
|
+
# name: "WirelessGatewayName",
|
2197
|
+
# description: "Description",
|
2198
|
+
# })
|
2199
|
+
#
|
2200
|
+
# @overload update_wireless_gateway(params = {})
|
2201
|
+
# @param [Hash] params ({})
|
2202
|
+
def update_wireless_gateway(params = {}, options = {})
|
2203
|
+
req = build_request(:update_wireless_gateway, params)
|
2204
|
+
req.send_request(options)
|
2205
|
+
end
|
2206
|
+
|
2207
|
+
# @!endgroup
|
2208
|
+
|
2209
|
+
# @param params ({})
|
2210
|
+
# @api private
|
2211
|
+
def build_request(operation_name, params = {})
|
2212
|
+
handlers = @handlers.for(operation_name)
|
2213
|
+
context = Seahorse::Client::RequestContext.new(
|
2214
|
+
operation_name: operation_name,
|
2215
|
+
operation: config.api.operation(operation_name),
|
2216
|
+
client: self,
|
2217
|
+
params: params,
|
2218
|
+
config: config)
|
2219
|
+
context[:gem_name] = 'aws-sdk-iotwireless'
|
2220
|
+
context[:gem_version] = '1.0.0'
|
2221
|
+
Seahorse::Client::Request.new(handlers, context)
|
2222
|
+
end
|
2223
|
+
|
2224
|
+
# @api private
|
2225
|
+
# @deprecated
|
2226
|
+
def waiter_names
|
2227
|
+
[]
|
2228
|
+
end
|
2229
|
+
|
2230
|
+
class << self
|
2231
|
+
|
2232
|
+
# @api private
|
2233
|
+
attr_reader :identifier
|
2234
|
+
|
2235
|
+
# @api private
|
2236
|
+
def errors_module
|
2237
|
+
Errors
|
2238
|
+
end
|
2239
|
+
|
2240
|
+
end
|
2241
|
+
end
|
2242
|
+
end
|