aws-sdk-iot1clickdevicesservice 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,309 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::IoT1ClickDevicesService
9
+ # @api private
10
+ module ClientApi
11
+
12
+ include Seahorse::Model
13
+
14
+ Attributes = Shapes::StructureShape.new(name: 'Attributes')
15
+ ClaimDevicesByClaimCodeRequest = Shapes::StructureShape.new(name: 'ClaimDevicesByClaimCodeRequest')
16
+ ClaimDevicesByClaimCodeResponse = Shapes::StructureShape.new(name: 'ClaimDevicesByClaimCodeResponse')
17
+ DescribeDeviceRequest = Shapes::StructureShape.new(name: 'DescribeDeviceRequest')
18
+ DescribeDeviceResponse = Shapes::StructureShape.new(name: 'DescribeDeviceResponse')
19
+ Device = Shapes::StructureShape.new(name: 'Device')
20
+ DeviceAttributes = Shapes::MapShape.new(name: 'DeviceAttributes')
21
+ DeviceClaimResponse = Shapes::StructureShape.new(name: 'DeviceClaimResponse')
22
+ DeviceDescription = Shapes::StructureShape.new(name: 'DeviceDescription')
23
+ DeviceEvent = Shapes::StructureShape.new(name: 'DeviceEvent')
24
+ DeviceEventsResponse = Shapes::StructureShape.new(name: 'DeviceEventsResponse')
25
+ DeviceMethod = Shapes::StructureShape.new(name: 'DeviceMethod')
26
+ Empty = Shapes::StructureShape.new(name: 'Empty')
27
+ FinalizeDeviceClaimRequest = Shapes::StructureShape.new(name: 'FinalizeDeviceClaimRequest')
28
+ FinalizeDeviceClaimResponse = Shapes::StructureShape.new(name: 'FinalizeDeviceClaimResponse')
29
+ ForbiddenException = Shapes::StructureShape.new(name: 'ForbiddenException')
30
+ GetDeviceMethodsRequest = Shapes::StructureShape.new(name: 'GetDeviceMethodsRequest')
31
+ GetDeviceMethodsResponse = Shapes::StructureShape.new(name: 'GetDeviceMethodsResponse')
32
+ InitiateDeviceClaimRequest = Shapes::StructureShape.new(name: 'InitiateDeviceClaimRequest')
33
+ InitiateDeviceClaimResponse = Shapes::StructureShape.new(name: 'InitiateDeviceClaimResponse')
34
+ InternalFailureException = Shapes::StructureShape.new(name: 'InternalFailureException')
35
+ InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
36
+ InvokeDeviceMethodRequest = Shapes::StructureShape.new(name: 'InvokeDeviceMethodRequest')
37
+ InvokeDeviceMethodResponse = Shapes::StructureShape.new(name: 'InvokeDeviceMethodResponse')
38
+ ListDeviceEventsRequest = Shapes::StructureShape.new(name: 'ListDeviceEventsRequest')
39
+ ListDeviceEventsResponse = Shapes::StructureShape.new(name: 'ListDeviceEventsResponse')
40
+ ListDevicesRequest = Shapes::StructureShape.new(name: 'ListDevicesRequest')
41
+ ListDevicesResponse = Shapes::StructureShape.new(name: 'ListDevicesResponse')
42
+ MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
43
+ PreconditionFailedException = Shapes::StructureShape.new(name: 'PreconditionFailedException')
44
+ RangeNotSatisfiableException = Shapes::StructureShape.new(name: 'RangeNotSatisfiableException')
45
+ ResourceConflictException = Shapes::StructureShape.new(name: 'ResourceConflictException')
46
+ ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
47
+ UnclaimDeviceRequest = Shapes::StructureShape.new(name: 'UnclaimDeviceRequest')
48
+ UnclaimDeviceResponse = Shapes::StructureShape.new(name: 'UnclaimDeviceResponse')
49
+ UpdateDeviceStateRequest = Shapes::StructureShape.new(name: 'UpdateDeviceStateRequest')
50
+ UpdateDeviceStateResponse = Shapes::StructureShape.new(name: 'UpdateDeviceStateResponse')
51
+ __boolean = Shapes::BooleanShape.new(name: '__boolean')
52
+ __double = Shapes::FloatShape.new(name: '__double')
53
+ __doubleMin0Max100 = Shapes::FloatShape.new(name: '__doubleMin0Max100')
54
+ __integer = Shapes::IntegerShape.new(name: '__integer')
55
+ __listOfDeviceDescription = Shapes::ListShape.new(name: '__listOfDeviceDescription')
56
+ __listOfDeviceEvent = Shapes::ListShape.new(name: '__listOfDeviceEvent')
57
+ __listOfDeviceMethod = Shapes::ListShape.new(name: '__listOfDeviceMethod')
58
+ __long = Shapes::IntegerShape.new(name: '__long')
59
+ __string = Shapes::StringShape.new(name: '__string')
60
+ __stringMin12Max40 = Shapes::StringShape.new(name: '__stringMin12Max40')
61
+ __timestampIso8601 = Shapes::TimestampShape.new(name: '__timestampIso8601', timestampFormat: "iso8601")
62
+ __timestampUnix = Shapes::TimestampShape.new(name: '__timestampUnix', timestampFormat: "unixTimestamp")
63
+
64
+ Attributes.struct_class = Types::Attributes
65
+
66
+ ClaimDevicesByClaimCodeRequest.add_member(:claim_code, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "claimCode"))
67
+ ClaimDevicesByClaimCodeRequest.struct_class = Types::ClaimDevicesByClaimCodeRequest
68
+
69
+ ClaimDevicesByClaimCodeResponse.add_member(:claim_code, Shapes::ShapeRef.new(shape: __stringMin12Max40, location_name: "claimCode"))
70
+ ClaimDevicesByClaimCodeResponse.add_member(:total, Shapes::ShapeRef.new(shape: __integer, location_name: "total"))
71
+ ClaimDevicesByClaimCodeResponse.struct_class = Types::ClaimDevicesByClaimCodeResponse
72
+
73
+ DescribeDeviceRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
74
+ DescribeDeviceRequest.struct_class = Types::DescribeDeviceRequest
75
+
76
+ DescribeDeviceResponse.add_member(:device_description, Shapes::ShapeRef.new(shape: DeviceDescription, location_name: "deviceDescription"))
77
+ DescribeDeviceResponse.struct_class = Types::DescribeDeviceResponse
78
+
79
+ Device.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "attributes"))
80
+ Device.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, location_name: "deviceId"))
81
+ Device.add_member(:type, Shapes::ShapeRef.new(shape: __string, location_name: "type"))
82
+ Device.struct_class = Types::Device
83
+
84
+ DeviceAttributes.key = Shapes::ShapeRef.new(shape: __string)
85
+ DeviceAttributes.value = Shapes::ShapeRef.new(shape: __string)
86
+
87
+ DeviceClaimResponse.add_member(:state, Shapes::ShapeRef.new(shape: __string, location_name: "state"))
88
+ DeviceClaimResponse.struct_class = Types::DeviceClaimResponse
89
+
90
+ DeviceDescription.add_member(:attributes, Shapes::ShapeRef.new(shape: DeviceAttributes, location_name: "attributes"))
91
+ DeviceDescription.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, location_name: "deviceId"))
92
+ DeviceDescription.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "enabled"))
93
+ DeviceDescription.add_member(:remaining_life, Shapes::ShapeRef.new(shape: __doubleMin0Max100, location_name: "remainingLife"))
94
+ DeviceDescription.add_member(:type, Shapes::ShapeRef.new(shape: __string, location_name: "type"))
95
+ DeviceDescription.struct_class = Types::DeviceDescription
96
+
97
+ DeviceEvent.add_member(:device, Shapes::ShapeRef.new(shape: Device, location_name: "device"))
98
+ DeviceEvent.add_member(:std_event, Shapes::ShapeRef.new(shape: __string, location_name: "stdEvent"))
99
+ DeviceEvent.struct_class = Types::DeviceEvent
100
+
101
+ DeviceEventsResponse.add_member(:events, Shapes::ShapeRef.new(shape: __listOfDeviceEvent, location_name: "events"))
102
+ DeviceEventsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "nextToken"))
103
+ DeviceEventsResponse.struct_class = Types::DeviceEventsResponse
104
+
105
+ DeviceMethod.add_member(:device_type, Shapes::ShapeRef.new(shape: __string, location_name: "deviceType"))
106
+ DeviceMethod.add_member(:method_name, Shapes::ShapeRef.new(shape: __string, location_name: "methodName"))
107
+ DeviceMethod.struct_class = Types::DeviceMethod
108
+
109
+ Empty.struct_class = Types::Empty
110
+
111
+ FinalizeDeviceClaimRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
112
+ FinalizeDeviceClaimRequest.struct_class = Types::FinalizeDeviceClaimRequest
113
+
114
+ FinalizeDeviceClaimResponse.add_member(:state, Shapes::ShapeRef.new(shape: __string, location_name: "state"))
115
+ FinalizeDeviceClaimResponse.struct_class = Types::FinalizeDeviceClaimResponse
116
+
117
+ GetDeviceMethodsRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
118
+ GetDeviceMethodsRequest.struct_class = Types::GetDeviceMethodsRequest
119
+
120
+ GetDeviceMethodsResponse.add_member(:device_methods, Shapes::ShapeRef.new(shape: __listOfDeviceMethod, location_name: "deviceMethods"))
121
+ GetDeviceMethodsResponse.struct_class = Types::GetDeviceMethodsResponse
122
+
123
+ InitiateDeviceClaimRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
124
+ InitiateDeviceClaimRequest.struct_class = Types::InitiateDeviceClaimRequest
125
+
126
+ InitiateDeviceClaimResponse.add_member(:state, Shapes::ShapeRef.new(shape: __string, location_name: "state"))
127
+ InitiateDeviceClaimResponse.struct_class = Types::InitiateDeviceClaimResponse
128
+
129
+ InvokeDeviceMethodRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
130
+ InvokeDeviceMethodRequest.add_member(:device_method, Shapes::ShapeRef.new(shape: DeviceMethod, location_name: "deviceMethod"))
131
+ InvokeDeviceMethodRequest.add_member(:device_method_parameters, Shapes::ShapeRef.new(shape: __string, location_name: "deviceMethodParameters"))
132
+ InvokeDeviceMethodRequest.struct_class = Types::InvokeDeviceMethodRequest
133
+
134
+ InvokeDeviceMethodResponse.add_member(:device_method_response, Shapes::ShapeRef.new(shape: __string, location_name: "deviceMethodResponse"))
135
+ InvokeDeviceMethodResponse.struct_class = Types::InvokeDeviceMethodResponse
136
+
137
+ ListDeviceEventsRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
138
+ ListDeviceEventsRequest.add_member(:from_time_stamp, Shapes::ShapeRef.new(shape: __timestampIso8601, required: true, location: "querystring", location_name: "fromTimeStamp"))
139
+ ListDeviceEventsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
140
+ ListDeviceEventsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "nextToken"))
141
+ ListDeviceEventsRequest.add_member(:to_time_stamp, Shapes::ShapeRef.new(shape: __timestampIso8601, required: true, location: "querystring", location_name: "toTimeStamp"))
142
+ ListDeviceEventsRequest.struct_class = Types::ListDeviceEventsRequest
143
+
144
+ ListDeviceEventsResponse.add_member(:events, Shapes::ShapeRef.new(shape: __listOfDeviceEvent, location_name: "events"))
145
+ ListDeviceEventsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "nextToken"))
146
+ ListDeviceEventsResponse.struct_class = Types::ListDeviceEventsResponse
147
+
148
+ ListDevicesRequest.add_member(:device_type, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "deviceType"))
149
+ ListDevicesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
150
+ ListDevicesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "nextToken"))
151
+ ListDevicesRequest.struct_class = Types::ListDevicesRequest
152
+
153
+ ListDevicesResponse.add_member(:devices, Shapes::ShapeRef.new(shape: __listOfDeviceDescription, location_name: "devices"))
154
+ ListDevicesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "nextToken"))
155
+ ListDevicesResponse.struct_class = Types::ListDevicesResponse
156
+
157
+ UnclaimDeviceRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
158
+ UnclaimDeviceRequest.struct_class = Types::UnclaimDeviceRequest
159
+
160
+ UnclaimDeviceResponse.add_member(:state, Shapes::ShapeRef.new(shape: __string, location_name: "state"))
161
+ UnclaimDeviceResponse.struct_class = Types::UnclaimDeviceResponse
162
+
163
+ UpdateDeviceStateRequest.add_member(:device_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "deviceId"))
164
+ UpdateDeviceStateRequest.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "enabled"))
165
+ UpdateDeviceStateRequest.struct_class = Types::UpdateDeviceStateRequest
166
+
167
+ UpdateDeviceStateResponse.struct_class = Types::UpdateDeviceStateResponse
168
+
169
+ __listOfDeviceDescription.member = Shapes::ShapeRef.new(shape: DeviceDescription)
170
+
171
+ __listOfDeviceEvent.member = Shapes::ShapeRef.new(shape: DeviceEvent)
172
+
173
+ __listOfDeviceMethod.member = Shapes::ShapeRef.new(shape: DeviceMethod)
174
+
175
+
176
+ # @api private
177
+ API = Seahorse::Model::Api.new.tap do |api|
178
+
179
+ api.version = "2018-05-14"
180
+
181
+ api.metadata = {
182
+ "endpointPrefix" => "devices.iot1click",
183
+ "jsonVersion" => "1.1",
184
+ "protocol" => "rest-json",
185
+ "serviceFullName" => "AWS IoT 1-Click Devices Service",
186
+ "signatureVersion" => "v4",
187
+ "signingName" => "iot1click",
188
+ }
189
+
190
+ api.add_operation(:claim_devices_by_claim_code, Seahorse::Model::Operation.new.tap do |o|
191
+ o.name = "ClaimDevicesByClaimCode"
192
+ o.http_method = "PUT"
193
+ o.http_request_uri = "/claims/{claimCode}"
194
+ o.input = Shapes::ShapeRef.new(shape: ClaimDevicesByClaimCodeRequest)
195
+ o.output = Shapes::ShapeRef.new(shape: ClaimDevicesByClaimCodeResponse)
196
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
197
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
198
+ o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
199
+ end)
200
+
201
+ api.add_operation(:describe_device, Seahorse::Model::Operation.new.tap do |o|
202
+ o.name = "DescribeDevice"
203
+ o.http_method = "GET"
204
+ o.http_request_uri = "/devices/{deviceId}"
205
+ o.input = Shapes::ShapeRef.new(shape: DescribeDeviceRequest)
206
+ o.output = Shapes::ShapeRef.new(shape: DescribeDeviceResponse)
207
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
208
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
209
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
210
+ end)
211
+
212
+ api.add_operation(:finalize_device_claim, Seahorse::Model::Operation.new.tap do |o|
213
+ o.name = "FinalizeDeviceClaim"
214
+ o.http_method = "PUT"
215
+ o.http_request_uri = "/devices/{deviceId}/finalize-claim"
216
+ o.input = Shapes::ShapeRef.new(shape: FinalizeDeviceClaimRequest)
217
+ o.output = Shapes::ShapeRef.new(shape: FinalizeDeviceClaimResponse)
218
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
219
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
220
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
221
+ o.errors << Shapes::ShapeRef.new(shape: PreconditionFailedException)
222
+ o.errors << Shapes::ShapeRef.new(shape: ResourceConflictException)
223
+ end)
224
+
225
+ api.add_operation(:get_device_methods, Seahorse::Model::Operation.new.tap do |o|
226
+ o.name = "GetDeviceMethods"
227
+ o.http_method = "GET"
228
+ o.http_request_uri = "/devices/{deviceId}/methods"
229
+ o.input = Shapes::ShapeRef.new(shape: GetDeviceMethodsRequest)
230
+ o.output = Shapes::ShapeRef.new(shape: GetDeviceMethodsResponse)
231
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
232
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
233
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
234
+ end)
235
+
236
+ api.add_operation(:initiate_device_claim, Seahorse::Model::Operation.new.tap do |o|
237
+ o.name = "InitiateDeviceClaim"
238
+ o.http_method = "PUT"
239
+ o.http_request_uri = "/devices/{deviceId}/initiate-claim"
240
+ o.input = Shapes::ShapeRef.new(shape: InitiateDeviceClaimRequest)
241
+ o.output = Shapes::ShapeRef.new(shape: InitiateDeviceClaimResponse)
242
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
243
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
244
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
245
+ o.errors << Shapes::ShapeRef.new(shape: ResourceConflictException)
246
+ end)
247
+
248
+ api.add_operation(:invoke_device_method, Seahorse::Model::Operation.new.tap do |o|
249
+ o.name = "InvokeDeviceMethod"
250
+ o.http_method = "POST"
251
+ o.http_request_uri = "/devices/{deviceId}/methods"
252
+ o.input = Shapes::ShapeRef.new(shape: InvokeDeviceMethodRequest)
253
+ o.output = Shapes::ShapeRef.new(shape: InvokeDeviceMethodResponse)
254
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
255
+ o.errors << Shapes::ShapeRef.new(shape: PreconditionFailedException)
256
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
257
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
258
+ o.errors << Shapes::ShapeRef.new(shape: RangeNotSatisfiableException)
259
+ o.errors << Shapes::ShapeRef.new(shape: ResourceConflictException)
260
+ end)
261
+
262
+ api.add_operation(:list_device_events, Seahorse::Model::Operation.new.tap do |o|
263
+ o.name = "ListDeviceEvents"
264
+ o.http_method = "GET"
265
+ o.http_request_uri = "/devices/{deviceId}/events"
266
+ o.input = Shapes::ShapeRef.new(shape: ListDeviceEventsRequest)
267
+ o.output = Shapes::ShapeRef.new(shape: ListDeviceEventsResponse)
268
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
269
+ o.errors << Shapes::ShapeRef.new(shape: RangeNotSatisfiableException)
270
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
271
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
272
+ end)
273
+
274
+ api.add_operation(:list_devices, Seahorse::Model::Operation.new.tap do |o|
275
+ o.name = "ListDevices"
276
+ o.http_method = "GET"
277
+ o.http_request_uri = "/devices"
278
+ o.input = Shapes::ShapeRef.new(shape: ListDevicesRequest)
279
+ o.output = Shapes::ShapeRef.new(shape: ListDevicesResponse)
280
+ o.errors << Shapes::ShapeRef.new(shape: RangeNotSatisfiableException)
281
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
282
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
283
+ end)
284
+
285
+ api.add_operation(:unclaim_device, Seahorse::Model::Operation.new.tap do |o|
286
+ o.name = "UnclaimDevice"
287
+ o.http_method = "PUT"
288
+ o.http_request_uri = "/devices/{deviceId}/unclaim"
289
+ o.input = Shapes::ShapeRef.new(shape: UnclaimDeviceRequest)
290
+ o.output = Shapes::ShapeRef.new(shape: UnclaimDeviceResponse)
291
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
292
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
293
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
294
+ end)
295
+
296
+ api.add_operation(:update_device_state, Seahorse::Model::Operation.new.tap do |o|
297
+ o.name = "UpdateDeviceState"
298
+ o.http_method = "PUT"
299
+ o.http_request_uri = "/devices/{deviceId}/state"
300
+ o.input = Shapes::ShapeRef.new(shape: UpdateDeviceStateRequest)
301
+ o.output = Shapes::ShapeRef.new(shape: UpdateDeviceStateResponse)
302
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
303
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
304
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
305
+ end)
306
+ end
307
+
308
+ end
309
+ end
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::IoT1ClickDevicesService
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::IoT1ClickDevicesService
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,482 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::IoT1ClickDevicesService
9
+ module Types
10
+
11
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/Attributes AWS API Documentation
12
+ #
13
+ class Attributes < Aws::EmptyStructure; end
14
+
15
+ # @note When making an API call, you may pass ClaimDevicesByClaimCodeRequest
16
+ # data as a hash:
17
+ #
18
+ # {
19
+ # claim_code: "__string", # required
20
+ # }
21
+ #
22
+ # @!attribute [rw] claim_code
23
+ # @return [String]
24
+ #
25
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ClaimDevicesByClaimCodeRequest AWS API Documentation
26
+ #
27
+ class ClaimDevicesByClaimCodeRequest < Struct.new(
28
+ :claim_code)
29
+ include Aws::Structure
30
+ end
31
+
32
+ # @!attribute [rw] claim_code
33
+ # The claim code provided by the device manufacturer.
34
+ # @return [String]
35
+ #
36
+ # @!attribute [rw] total
37
+ # The total number of devices associated with the claim code that has
38
+ # been processed in the claim request.
39
+ # @return [Integer]
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ClaimDevicesByClaimCodeResponse AWS API Documentation
42
+ #
43
+ class ClaimDevicesByClaimCodeResponse < Struct.new(
44
+ :claim_code,
45
+ :total)
46
+ include Aws::Structure
47
+ end
48
+
49
+ # @note When making an API call, you may pass DescribeDeviceRequest
50
+ # data as a hash:
51
+ #
52
+ # {
53
+ # device_id: "__string", # required
54
+ # }
55
+ #
56
+ # @!attribute [rw] device_id
57
+ # @return [String]
58
+ #
59
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DescribeDeviceRequest AWS API Documentation
60
+ #
61
+ class DescribeDeviceRequest < Struct.new(
62
+ :device_id)
63
+ include Aws::Structure
64
+ end
65
+
66
+ # @!attribute [rw] device_description
67
+ # Device details.
68
+ # @return [Types::DeviceDescription]
69
+ #
70
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DescribeDeviceResponse AWS API Documentation
71
+ #
72
+ class DescribeDeviceResponse < Struct.new(
73
+ :device_description)
74
+ include Aws::Structure
75
+ end
76
+
77
+ # @!attribute [rw] attributes
78
+ # The user specified attributes associated with the device for an
79
+ # event.
80
+ # @return [Types::Attributes]
81
+ #
82
+ # @!attribute [rw] device_id
83
+ # The unique identifier of the device.
84
+ # @return [String]
85
+ #
86
+ # @!attribute [rw] type
87
+ # The device type, such as "button".
88
+ # @return [String]
89
+ #
90
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/Device AWS API Documentation
91
+ #
92
+ class Device < Struct.new(
93
+ :attributes,
94
+ :device_id,
95
+ :type)
96
+ include Aws::Structure
97
+ end
98
+
99
+ # @!attribute [rw] state
100
+ # The device's final claim state.
101
+ # @return [String]
102
+ #
103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceClaimResponse AWS API Documentation
104
+ #
105
+ class DeviceClaimResponse < Struct.new(
106
+ :state)
107
+ include Aws::Structure
108
+ end
109
+
110
+ # @!attribute [rw] attributes
111
+ # An array of zero or more elements of DeviceAttribute objects
112
+ # providing user specified device attributes.
113
+ # @return [Hash<String,String>]
114
+ #
115
+ # @!attribute [rw] device_id
116
+ # The unique identifier of the device.
117
+ # @return [String]
118
+ #
119
+ # @!attribute [rw] enabled
120
+ # A Boolean value indicating whether or not the device is enabled.
121
+ # @return [Boolean]
122
+ #
123
+ # @!attribute [rw] remaining_life
124
+ # A value between 0 and 1 inclusive, representing the fraction of life
125
+ # remaining for the device.
126
+ # @return [Float]
127
+ #
128
+ # @!attribute [rw] type
129
+ # The type of the device, such as "button".
130
+ # @return [String]
131
+ #
132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceDescription AWS API Documentation
133
+ #
134
+ class DeviceDescription < Struct.new(
135
+ :attributes,
136
+ :device_id,
137
+ :enabled,
138
+ :remaining_life,
139
+ :type)
140
+ include Aws::Structure
141
+ end
142
+
143
+ # @!attribute [rw] device
144
+ # An object representing the device associated with the event.
145
+ # @return [Types::Device]
146
+ #
147
+ # @!attribute [rw] std_event
148
+ # A serialized JSON object representing the device-type specific
149
+ # event.
150
+ # @return [String]
151
+ #
152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceEvent AWS API Documentation
153
+ #
154
+ class DeviceEvent < Struct.new(
155
+ :device,
156
+ :std_event)
157
+ include Aws::Structure
158
+ end
159
+
160
+ # @!attribute [rw] events
161
+ # An array of zero or more elements describing the event(s) associated
162
+ # with the device.
163
+ # @return [Array<Types::DeviceEvent>]
164
+ #
165
+ # @!attribute [rw] next_token
166
+ # The token to retrieve the next set of results.
167
+ # @return [String]
168
+ #
169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceEventsResponse AWS API Documentation
170
+ #
171
+ class DeviceEventsResponse < Struct.new(
172
+ :events,
173
+ :next_token)
174
+ include Aws::Structure
175
+ end
176
+
177
+ # @note When making an API call, you may pass DeviceMethod
178
+ # data as a hash:
179
+ #
180
+ # {
181
+ # device_type: "__string",
182
+ # method_name: "__string",
183
+ # }
184
+ #
185
+ # @!attribute [rw] device_type
186
+ # The type of the device, such as "button".
187
+ # @return [String]
188
+ #
189
+ # @!attribute [rw] method_name
190
+ # The name of the method applicable to the deviceType.
191
+ # @return [String]
192
+ #
193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceMethod AWS API Documentation
194
+ #
195
+ class DeviceMethod < Struct.new(
196
+ :device_type,
197
+ :method_name)
198
+ include Aws::Structure
199
+ end
200
+
201
+ # On success, an empty object is returned.
202
+ #
203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/Empty AWS API Documentation
204
+ #
205
+ class Empty < Aws::EmptyStructure; end
206
+
207
+ # @note When making an API call, you may pass FinalizeDeviceClaimRequest
208
+ # data as a hash:
209
+ #
210
+ # {
211
+ # device_id: "__string", # required
212
+ # }
213
+ #
214
+ # @!attribute [rw] device_id
215
+ # @return [String]
216
+ #
217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/FinalizeDeviceClaimRequest AWS API Documentation
218
+ #
219
+ class FinalizeDeviceClaimRequest < Struct.new(
220
+ :device_id)
221
+ include Aws::Structure
222
+ end
223
+
224
+ # @!attribute [rw] state
225
+ # @return [String]
226
+ #
227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/FinalizeDeviceClaimResponse AWS API Documentation
228
+ #
229
+ class FinalizeDeviceClaimResponse < Struct.new(
230
+ :state)
231
+ include Aws::Structure
232
+ end
233
+
234
+ # @note When making an API call, you may pass GetDeviceMethodsRequest
235
+ # data as a hash:
236
+ #
237
+ # {
238
+ # device_id: "__string", # required
239
+ # }
240
+ #
241
+ # @!attribute [rw] device_id
242
+ # @return [String]
243
+ #
244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/GetDeviceMethodsRequest AWS API Documentation
245
+ #
246
+ class GetDeviceMethodsRequest < Struct.new(
247
+ :device_id)
248
+ include Aws::Structure
249
+ end
250
+
251
+ # @!attribute [rw] device_methods
252
+ # List of available device APIs.
253
+ # @return [Array<Types::DeviceMethod>]
254
+ #
255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/GetDeviceMethodsResponse AWS API Documentation
256
+ #
257
+ class GetDeviceMethodsResponse < Struct.new(
258
+ :device_methods)
259
+ include Aws::Structure
260
+ end
261
+
262
+ # @note When making an API call, you may pass InitiateDeviceClaimRequest
263
+ # data as a hash:
264
+ #
265
+ # {
266
+ # device_id: "__string", # required
267
+ # }
268
+ #
269
+ # @!attribute [rw] device_id
270
+ # @return [String]
271
+ #
272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InitiateDeviceClaimRequest AWS API Documentation
273
+ #
274
+ class InitiateDeviceClaimRequest < Struct.new(
275
+ :device_id)
276
+ include Aws::Structure
277
+ end
278
+
279
+ # @!attribute [rw] state
280
+ # @return [String]
281
+ #
282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InitiateDeviceClaimResponse AWS API Documentation
283
+ #
284
+ class InitiateDeviceClaimResponse < Struct.new(
285
+ :state)
286
+ include Aws::Structure
287
+ end
288
+
289
+ # @note When making an API call, you may pass InvokeDeviceMethodRequest
290
+ # data as a hash:
291
+ #
292
+ # {
293
+ # device_id: "__string", # required
294
+ # device_method: {
295
+ # device_type: "__string",
296
+ # method_name: "__string",
297
+ # },
298
+ # device_method_parameters: "__string",
299
+ # }
300
+ #
301
+ # @!attribute [rw] device_id
302
+ # @return [String]
303
+ #
304
+ # @!attribute [rw] device_method
305
+ # The device method to invoke.
306
+ # @return [Types::DeviceMethod]
307
+ #
308
+ # @!attribute [rw] device_method_parameters
309
+ # A JSON encoded string containing the device method request
310
+ # parameters.
311
+ # @return [String]
312
+ #
313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InvokeDeviceMethodRequest AWS API Documentation
314
+ #
315
+ class InvokeDeviceMethodRequest < Struct.new(
316
+ :device_id,
317
+ :device_method,
318
+ :device_method_parameters)
319
+ include Aws::Structure
320
+ end
321
+
322
+ # @!attribute [rw] device_method_response
323
+ # A JSON encoded string containing the device method response.
324
+ # @return [String]
325
+ #
326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InvokeDeviceMethodResponse AWS API Documentation
327
+ #
328
+ class InvokeDeviceMethodResponse < Struct.new(
329
+ :device_method_response)
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @note When making an API call, you may pass ListDeviceEventsRequest
334
+ # data as a hash:
335
+ #
336
+ # {
337
+ # device_id: "__string", # required
338
+ # from_time_stamp: Time.now, # required
339
+ # max_results: 1,
340
+ # next_token: "__string",
341
+ # to_time_stamp: Time.now, # required
342
+ # }
343
+ #
344
+ # @!attribute [rw] device_id
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] from_time_stamp
348
+ # @return [Time]
349
+ #
350
+ # @!attribute [rw] max_results
351
+ # @return [Integer]
352
+ #
353
+ # @!attribute [rw] next_token
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] to_time_stamp
357
+ # @return [Time]
358
+ #
359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDeviceEventsRequest AWS API Documentation
360
+ #
361
+ class ListDeviceEventsRequest < Struct.new(
362
+ :device_id,
363
+ :from_time_stamp,
364
+ :max_results,
365
+ :next_token,
366
+ :to_time_stamp)
367
+ include Aws::Structure
368
+ end
369
+
370
+ # @!attribute [rw] events
371
+ # @return [Array<Types::DeviceEvent>]
372
+ #
373
+ # @!attribute [rw] next_token
374
+ # @return [String]
375
+ #
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDeviceEventsResponse AWS API Documentation
377
+ #
378
+ class ListDeviceEventsResponse < Struct.new(
379
+ :events,
380
+ :next_token)
381
+ include Aws::Structure
382
+ end
383
+
384
+ # @note When making an API call, you may pass ListDevicesRequest
385
+ # data as a hash:
386
+ #
387
+ # {
388
+ # device_type: "__string",
389
+ # max_results: 1,
390
+ # next_token: "__string",
391
+ # }
392
+ #
393
+ # @!attribute [rw] device_type
394
+ # @return [String]
395
+ #
396
+ # @!attribute [rw] max_results
397
+ # @return [Integer]
398
+ #
399
+ # @!attribute [rw] next_token
400
+ # @return [String]
401
+ #
402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDevicesRequest AWS API Documentation
403
+ #
404
+ class ListDevicesRequest < Struct.new(
405
+ :device_type,
406
+ :max_results,
407
+ :next_token)
408
+ include Aws::Structure
409
+ end
410
+
411
+ # @!attribute [rw] devices
412
+ # A list of devices.
413
+ # @return [Array<Types::DeviceDescription>]
414
+ #
415
+ # @!attribute [rw] next_token
416
+ # The token to retrieve the next set of results.
417
+ # @return [String]
418
+ #
419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDevicesResponse AWS API Documentation
420
+ #
421
+ class ListDevicesResponse < Struct.new(
422
+ :devices,
423
+ :next_token)
424
+ include Aws::Structure
425
+ end
426
+
427
+ # @note When making an API call, you may pass UnclaimDeviceRequest
428
+ # data as a hash:
429
+ #
430
+ # {
431
+ # device_id: "__string", # required
432
+ # }
433
+ #
434
+ # @!attribute [rw] device_id
435
+ # @return [String]
436
+ #
437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UnclaimDeviceRequest AWS API Documentation
438
+ #
439
+ class UnclaimDeviceRequest < Struct.new(
440
+ :device_id)
441
+ include Aws::Structure
442
+ end
443
+
444
+ # @!attribute [rw] state
445
+ # @return [String]
446
+ #
447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UnclaimDeviceResponse AWS API Documentation
448
+ #
449
+ class UnclaimDeviceResponse < Struct.new(
450
+ :state)
451
+ include Aws::Structure
452
+ end
453
+
454
+ # @note When making an API call, you may pass UpdateDeviceStateRequest
455
+ # data as a hash:
456
+ #
457
+ # {
458
+ # device_id: "__string", # required
459
+ # enabled: false,
460
+ # }
461
+ #
462
+ # @!attribute [rw] device_id
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] enabled
466
+ # If true, the device is enabled. If false, the device is disabled.
467
+ # @return [Boolean]
468
+ #
469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UpdateDeviceStateRequest AWS API Documentation
470
+ #
471
+ class UpdateDeviceStateRequest < Struct.new(
472
+ :device_id,
473
+ :enabled)
474
+ include Aws::Structure
475
+ end
476
+
477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UpdateDeviceStateResponse AWS API Documentation
478
+ #
479
+ class UpdateDeviceStateResponse < Aws::EmptyStructure; end
480
+
481
+ end
482
+ end