aws-sdk-iotthingsgraph 1.2.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: b473e95e29c2f4bce8b73edba0247450dcb7b469
4
- data.tar.gz: 7ebcef50dc1314c496f7e7fbef950672ec93810f
2
+ SHA256:
3
+ metadata.gz: 6b1f73b18176bc7a29e2a65602ea72bd47e0dabd60470758b0d3ea966947c8d8
4
+ data.tar.gz: d923f6a8ff1fab7bf18d7494392523e2031c3400d024707b6d85244ba8d7ee9d
5
5
  SHA512:
6
- metadata.gz: fd9439c87d34e75955886fe991a15069c4734cfacbadef3f7f158ea65a3ae89734282b900ce7d9f06f9d3b22c8885f72c80abbba4d1f31a970c0e54e55e7188a
7
- data.tar.gz: 6dd810df28850600ab1426fbcc6263e89b63aef5daae79e629b39ac334e7ba613a460a5af2387b1c0aa0b4fd61a6e2223232905e8552a22ec8cfd2a52598cfef
6
+ metadata.gz: f266c049a7aa5907c468fd0d858bb88410e506b01d00914b9b08b35232792aba706595769d15eff3b4a133c9085d1684ef245421e2d54daa706a3667e5e99737
7
+ data.tar.gz: edb949f074c20981083820b7b74d90b9e029ad78fb8b7831d91d01383b4b16e53238f8f4dec1ff2f96b0261997aea39bea4563199da7ab1691cfd0e3970b5892
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-iotthingsgraph/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # io_t_things_graph = Aws::IoTThingsGraph::Client.new
28
+ # resp = io_t_things_graph.associate_entity_to_thing(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS IoT Things Graph all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS IoT Things Graph are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::IoTThingsGraph::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS IoT Things Graph API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-iotthingsgraph/customizations'
42
45
  # @service
43
46
  module Aws::IoTThingsGraph
44
47
 
45
- GEM_VERSION = '1.2.0'
48
+ GEM_VERSION = '1.7.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:iotthingsgraph)
31
31
 
32
32
  module Aws::IoTThingsGraph
33
+ # An API client for IoTThingsGraph. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::IoTThingsGraph::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::IoTThingsGraph
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::IoTThingsGraph
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::IoTThingsGraph
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::IoTThingsGraph
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::IoTThingsGraph
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::IoTThingsGraph
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::IoTThingsGraph
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::IoTThingsGraph
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::IoTThingsGraph
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -889,6 +943,8 @@ module Aws::IoTThingsGraph
889
943
  # * {Types::GetFlowTemplateRevisionsResponse#summaries #summaries} => Array&lt;Types::FlowTemplateSummary&gt;
890
944
  # * {Types::GetFlowTemplateRevisionsResponse#next_token #next_token} => String
891
945
  #
946
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
947
+ #
892
948
  # @example Request syntax with placeholder values
893
949
  #
894
950
  # resp = client.get_flow_template_revisions({
@@ -1052,6 +1108,8 @@ module Aws::IoTThingsGraph
1052
1108
  # * {Types::GetSystemTemplateRevisionsResponse#summaries #summaries} => Array&lt;Types::SystemTemplateSummary&gt;
1053
1109
  # * {Types::GetSystemTemplateRevisionsResponse#next_token #next_token} => String
1054
1110
  #
1111
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1112
+ #
1055
1113
  # @example Request syntax with placeholder values
1056
1114
  #
1057
1115
  # resp = client.get_system_template_revisions({
@@ -1134,6 +1192,8 @@ module Aws::IoTThingsGraph
1134
1192
  # * {Types::ListFlowExecutionMessagesResponse#messages #messages} => Array&lt;Types::FlowExecutionMessage&gt;
1135
1193
  # * {Types::ListFlowExecutionMessagesResponse#next_token #next_token} => String
1136
1194
  #
1195
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1196
+ #
1137
1197
  # @example Request syntax with placeholder values
1138
1198
  #
1139
1199
  # resp = client.list_flow_execution_messages({
@@ -1175,6 +1235,8 @@ module Aws::IoTThingsGraph
1175
1235
  # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
1176
1236
  # * {Types::ListTagsForResourceResponse#next_token #next_token} => String
1177
1237
  #
1238
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1239
+ #
1178
1240
  # @example Request syntax with placeholder values
1179
1241
  #
1180
1242
  # resp = client.list_tags_for_resource({
@@ -1230,6 +1292,8 @@ module Aws::IoTThingsGraph
1230
1292
  # * {Types::SearchEntitiesResponse#descriptions #descriptions} => Array&lt;Types::EntityDescription&gt;
1231
1293
  # * {Types::SearchEntitiesResponse#next_token #next_token} => String
1232
1294
  #
1295
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1296
+ #
1233
1297
  # @example Request syntax with placeholder values
1234
1298
  #
1235
1299
  # resp = client.search_entities({
@@ -1289,6 +1353,8 @@ module Aws::IoTThingsGraph
1289
1353
  # * {Types::SearchFlowExecutionsResponse#summaries #summaries} => Array&lt;Types::FlowExecutionSummary&gt;
1290
1354
  # * {Types::SearchFlowExecutionsResponse#next_token #next_token} => String
1291
1355
  #
1356
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1357
+ #
1292
1358
  # @example Request syntax with placeholder values
1293
1359
  #
1294
1360
  # resp = client.search_flow_executions({
@@ -1336,6 +1402,8 @@ module Aws::IoTThingsGraph
1336
1402
  # * {Types::SearchFlowTemplatesResponse#summaries #summaries} => Array&lt;Types::FlowTemplateSummary&gt;
1337
1403
  # * {Types::SearchFlowTemplatesResponse#next_token #next_token} => String
1338
1404
  #
1405
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1406
+ #
1339
1407
  # @example Request syntax with placeholder values
1340
1408
  #
1341
1409
  # resp = client.search_flow_templates({
@@ -1386,6 +1454,8 @@ module Aws::IoTThingsGraph
1386
1454
  # * {Types::SearchSystemInstancesResponse#summaries #summaries} => Array&lt;Types::SystemInstanceSummary&gt;
1387
1455
  # * {Types::SearchSystemInstancesResponse#next_token #next_token} => String
1388
1456
  #
1457
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1458
+ #
1389
1459
  # @example Request syntax with placeholder values
1390
1460
  #
1391
1461
  # resp = client.search_system_instances({
@@ -1440,6 +1510,8 @@ module Aws::IoTThingsGraph
1440
1510
  # * {Types::SearchSystemTemplatesResponse#summaries #summaries} => Array&lt;Types::SystemTemplateSummary&gt;
1441
1511
  # * {Types::SearchSystemTemplatesResponse#next_token #next_token} => String
1442
1512
  #
1513
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1514
+ #
1443
1515
  # @example Request syntax with placeholder values
1444
1516
  #
1445
1517
  # resp = client.search_system_templates({
@@ -1503,6 +1575,8 @@ module Aws::IoTThingsGraph
1503
1575
  # * {Types::SearchThingsResponse#things #things} => Array&lt;Types::Thing&gt;
1504
1576
  # * {Types::SearchThingsResponse#next_token #next_token} => String
1505
1577
  #
1578
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1579
+ #
1506
1580
  # @example Request syntax with placeholder values
1507
1581
  #
1508
1582
  # resp = client.search_things({
@@ -1804,7 +1878,7 @@ module Aws::IoTThingsGraph
1804
1878
  params: params,
1805
1879
  config: config)
1806
1880
  context[:gem_name] = 'aws-sdk-iotthingsgraph'
1807
- context[:gem_version] = '1.2.0'
1881
+ context[:gem_version] = '1.7.0'
1808
1882
  Seahorse::Client::Request.new(handlers, context)
1809
1883
  end
1810
1884
 
@@ -6,6 +6,35 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoTThingsGraph
9
+
10
+ # When IoTThingsGraph returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::IoTThingsGraph::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all IoTThingsGraph errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::IoTThingsGraph::Errors::ServiceError
18
+ # # rescues all IoTThingsGraph API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {InternalFailureException}
29
+ # * {InvalidRequestException}
30
+ # * {LimitExceededException}
31
+ # * {ResourceAlreadyExistsException}
32
+ # * {ResourceInUseException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ThrottlingException}
35
+ #
36
+ # Additionally, error classes are dynamically generated for service errors based on the error code
37
+ # if they are not defined above.
9
38
  module Errors
10
39
 
11
40
  extend Aws::Errors::DynamicErrors
@@ -23,7 +52,6 @@ module Aws::IoTThingsGraph
23
52
  def message
24
53
  @message || @data[:message]
25
54
  end
26
-
27
55
  end
28
56
 
29
57
  class InvalidRequestException < ServiceError
@@ -39,7 +67,6 @@ module Aws::IoTThingsGraph
39
67
  def message
40
68
  @message || @data[:message]
41
69
  end
42
-
43
70
  end
44
71
 
45
72
  class LimitExceededException < ServiceError
@@ -55,7 +82,6 @@ module Aws::IoTThingsGraph
55
82
  def message
56
83
  @message || @data[:message]
57
84
  end
58
-
59
85
  end
60
86
 
61
87
  class ResourceAlreadyExistsException < ServiceError
@@ -71,7 +97,6 @@ module Aws::IoTThingsGraph
71
97
  def message
72
98
  @message || @data[:message]
73
99
  end
74
-
75
100
  end
76
101
 
77
102
  class ResourceInUseException < ServiceError
@@ -87,7 +112,6 @@ module Aws::IoTThingsGraph
87
112
  def message
88
113
  @message || @data[:message]
89
114
  end
90
-
91
115
  end
92
116
 
93
117
  class ResourceNotFoundException < ServiceError
@@ -103,7 +127,6 @@ module Aws::IoTThingsGraph
103
127
  def message
104
128
  @message || @data[:message]
105
129
  end
106
-
107
130
  end
108
131
 
109
132
  class ThrottlingException < ServiceError
@@ -119,7 +142,6 @@ module Aws::IoTThingsGraph
119
142
  def message
120
143
  @message || @data[:message]
121
144
  end
122
-
123
145
  end
124
146
 
125
147
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IoTThingsGraph
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-iotthingsgraph
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-07-01 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.58.0
22
+ version: 3.71.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.58.0
32
+ version: 3.71.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - AWS IoT Things Graph