forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
641 lines (567 loc) · 19 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package iotdataplane provides a client for AWS IoT Data Plane.
package iotdataplane
import (
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
"github.com/aws/aws-sdk-go/private/protocol/restjson"
)
const opDeleteThingShadow = "DeleteThingShadow"
// DeleteThingShadowRequest generates a "aws/request.Request" representing the
// client's request for the DeleteThingShadow operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See DeleteThingShadow for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the DeleteThingShadow method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the DeleteThingShadowRequest method.
// req, resp := client.DeleteThingShadowRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
func (c *IoTDataPlane) DeleteThingShadowRequest(input *DeleteThingShadowInput) (req *request.Request, output *DeleteThingShadowOutput) {
op := &request.Operation{
Name: opDeleteThingShadow,
HTTPMethod: "DELETE",
HTTPPath: "/things/{thingName}/shadow",
}
if input == nil {
input = &DeleteThingShadowInput{}
}
req = c.newRequest(op, input, output)
output = &DeleteThingShadowOutput{}
req.Data = output
return
}
// DeleteThingShadow API operation for AWS IoT Data Plane.
//
// Deletes the thing shadow for the specified thing.
//
// For more information, see DeleteThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html)
// in the AWS IoT Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Data Plane's
// API operation DeleteThingShadow for usage and error information.
//
// Returned Error Codes:
// * ResourceNotFoundException
// The specified resource does not exist.
//
// * InvalidRequestException
// The request is not valid.
//
// * ThrottlingException
// The rate exceeds the limit.
//
// * UnauthorizedException
// You are not authorized to perform this operation.
//
// * ServiceUnavailableException
// The service is temporarily unavailable.
//
// * InternalFailureException
// An unexpected error has occurred.
//
// * MethodNotAllowedException
// The specified combination of HTTP verb and URI is not supported.
//
// * UnsupportedDocumentEncodingException
// The document encoding is not supported.
//
func (c *IoTDataPlane) DeleteThingShadow(input *DeleteThingShadowInput) (*DeleteThingShadowOutput, error) {
req, out := c.DeleteThingShadowRequest(input)
err := req.Send()
return out, err
}
const opGetThingShadow = "GetThingShadow"
// GetThingShadowRequest generates a "aws/request.Request" representing the
// client's request for the GetThingShadow operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See GetThingShadow for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the GetThingShadow method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the GetThingShadowRequest method.
// req, resp := client.GetThingShadowRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
func (c *IoTDataPlane) GetThingShadowRequest(input *GetThingShadowInput) (req *request.Request, output *GetThingShadowOutput) {
op := &request.Operation{
Name: opGetThingShadow,
HTTPMethod: "GET",
HTTPPath: "/things/{thingName}/shadow",
}
if input == nil {
input = &GetThingShadowInput{}
}
req = c.newRequest(op, input, output)
output = &GetThingShadowOutput{}
req.Data = output
return
}
// GetThingShadow API operation for AWS IoT Data Plane.
//
// Gets the thing shadow for the specified thing.
//
// For more information, see GetThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html)
// in the AWS IoT Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Data Plane's
// API operation GetThingShadow for usage and error information.
//
// Returned Error Codes:
// * InvalidRequestException
// The request is not valid.
//
// * ResourceNotFoundException
// The specified resource does not exist.
//
// * ThrottlingException
// The rate exceeds the limit.
//
// * UnauthorizedException
// You are not authorized to perform this operation.
//
// * ServiceUnavailableException
// The service is temporarily unavailable.
//
// * InternalFailureException
// An unexpected error has occurred.
//
// * MethodNotAllowedException
// The specified combination of HTTP verb and URI is not supported.
//
// * UnsupportedDocumentEncodingException
// The document encoding is not supported.
//
func (c *IoTDataPlane) GetThingShadow(input *GetThingShadowInput) (*GetThingShadowOutput, error) {
req, out := c.GetThingShadowRequest(input)
err := req.Send()
return out, err
}
const opPublish = "Publish"
// PublishRequest generates a "aws/request.Request" representing the
// client's request for the Publish operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See Publish for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the Publish method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the PublishRequest method.
// req, resp := client.PublishRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
func (c *IoTDataPlane) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput) {
op := &request.Operation{
Name: opPublish,
HTTPMethod: "POST",
HTTPPath: "/topics/{topic}",
}
if input == nil {
input = &PublishInput{}
}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(restjson.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output = &PublishOutput{}
req.Data = output
return
}
// Publish API operation for AWS IoT Data Plane.
//
// Publishes state information.
//
// For more information, see HTTP Protocol (http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http)
// in the AWS IoT Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Data Plane's
// API operation Publish for usage and error information.
//
// Returned Error Codes:
// * InternalFailureException
// An unexpected error has occurred.
//
// * InvalidRequestException
// The request is not valid.
//
// * UnauthorizedException
// You are not authorized to perform this operation.
//
// * MethodNotAllowedException
// The specified combination of HTTP verb and URI is not supported.
//
func (c *IoTDataPlane) Publish(input *PublishInput) (*PublishOutput, error) {
req, out := c.PublishRequest(input)
err := req.Send()
return out, err
}
const opUpdateThingShadow = "UpdateThingShadow"
// UpdateThingShadowRequest generates a "aws/request.Request" representing the
// client's request for the UpdateThingShadow operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See UpdateThingShadow for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the UpdateThingShadow method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the UpdateThingShadowRequest method.
// req, resp := client.UpdateThingShadowRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
func (c *IoTDataPlane) UpdateThingShadowRequest(input *UpdateThingShadowInput) (req *request.Request, output *UpdateThingShadowOutput) {
op := &request.Operation{
Name: opUpdateThingShadow,
HTTPMethod: "POST",
HTTPPath: "/things/{thingName}/shadow",
}
if input == nil {
input = &UpdateThingShadowInput{}
}
req = c.newRequest(op, input, output)
output = &UpdateThingShadowOutput{}
req.Data = output
return
}
// UpdateThingShadow API operation for AWS IoT Data Plane.
//
// Updates the thing shadow for the specified thing.
//
// For more information, see UpdateThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html)
// in the AWS IoT Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for AWS IoT Data Plane's
// API operation UpdateThingShadow for usage and error information.
//
// Returned Error Codes:
// * ConflictException
// The specified version does not match the version of the document.
//
// * RequestEntityTooLargeException
// The payload exceeds the maximum size allowed.
//
// * InvalidRequestException
// The request is not valid.
//
// * ThrottlingException
// The rate exceeds the limit.
//
// * UnauthorizedException
// You are not authorized to perform this operation.
//
// * ServiceUnavailableException
// The service is temporarily unavailable.
//
// * InternalFailureException
// An unexpected error has occurred.
//
// * MethodNotAllowedException
// The specified combination of HTTP verb and URI is not supported.
//
// * UnsupportedDocumentEncodingException
// The document encoding is not supported.
//
func (c *IoTDataPlane) UpdateThingShadow(input *UpdateThingShadowInput) (*UpdateThingShadowOutput, error) {
req, out := c.UpdateThingShadowRequest(input)
err := req.Send()
return out, err
}
// The input for the DeleteThingShadow operation.
type DeleteThingShadowInput struct {
_ struct{} `type:"structure"`
// The name of the thing.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DeleteThingShadowInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteThingShadowInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteThingShadowInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteThingShadowInput"}
if s.ThingName == nil {
invalidParams.Add(request.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetThingName sets the ThingName field's value.
func (s *DeleteThingShadowInput) SetThingName(v string) *DeleteThingShadowInput {
s.ThingName = &v
return s
}
// The output from the DeleteThingShadow operation.
type DeleteThingShadowOutput struct {
_ struct{} `type:"structure" payload:"Payload"`
// The state information, in JSON format.
//
// Payload is a required field
Payload []byte `locationName:"payload" type:"blob" required:"true"`
}
// String returns the string representation
func (s DeleteThingShadowOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteThingShadowOutput) GoString() string {
return s.String()
}
// SetPayload sets the Payload field's value.
func (s *DeleteThingShadowOutput) SetPayload(v []byte) *DeleteThingShadowOutput {
s.Payload = v
return s
}
// The input for the GetThingShadow operation.
type GetThingShadowInput struct {
_ struct{} `type:"structure"`
// The name of the thing.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s GetThingShadowInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetThingShadowInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetThingShadowInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetThingShadowInput"}
if s.ThingName == nil {
invalidParams.Add(request.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetThingName sets the ThingName field's value.
func (s *GetThingShadowInput) SetThingName(v string) *GetThingShadowInput {
s.ThingName = &v
return s
}
// The output from the GetThingShadow operation.
type GetThingShadowOutput struct {
_ struct{} `type:"structure" payload:"Payload"`
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob"`
}
// String returns the string representation
func (s GetThingShadowOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetThingShadowOutput) GoString() string {
return s.String()
}
// SetPayload sets the Payload field's value.
func (s *GetThingShadowOutput) SetPayload(v []byte) *GetThingShadowOutput {
s.Payload = v
return s
}
// The input for the Publish operation.
type PublishInput struct {
_ struct{} `type:"structure" payload:"Payload"`
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob"`
// The Quality of Service (QoS) level.
Qos *int64 `location:"querystring" locationName:"qos" type:"integer"`
// The name of the MQTT topic.
//
// Topic is a required field
Topic *string `location:"uri" locationName:"topic" type:"string" required:"true"`
}
// String returns the string representation
func (s PublishInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PublishInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *PublishInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "PublishInput"}
if s.Topic == nil {
invalidParams.Add(request.NewErrParamRequired("Topic"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPayload sets the Payload field's value.
func (s *PublishInput) SetPayload(v []byte) *PublishInput {
s.Payload = v
return s
}
// SetQos sets the Qos field's value.
func (s *PublishInput) SetQos(v int64) *PublishInput {
s.Qos = &v
return s
}
// SetTopic sets the Topic field's value.
func (s *PublishInput) SetTopic(v string) *PublishInput {
s.Topic = &v
return s
}
type PublishOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s PublishOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PublishOutput) GoString() string {
return s.String()
}
// The input for the UpdateThingShadow operation.
type UpdateThingShadowInput struct {
_ struct{} `type:"structure" payload:"Payload"`
// The state information, in JSON format.
//
// Payload is a required field
Payload []byte `locationName:"payload" type:"blob" required:"true"`
// The name of the thing.
//
// ThingName is a required field
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s UpdateThingShadowInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s UpdateThingShadowInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UpdateThingShadowInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "UpdateThingShadowInput"}
if s.Payload == nil {
invalidParams.Add(request.NewErrParamRequired("Payload"))
}
if s.ThingName == nil {
invalidParams.Add(request.NewErrParamRequired("ThingName"))
}
if s.ThingName != nil && len(*s.ThingName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ThingName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPayload sets the Payload field's value.
func (s *UpdateThingShadowInput) SetPayload(v []byte) *UpdateThingShadowInput {
s.Payload = v
return s
}
// SetThingName sets the ThingName field's value.
func (s *UpdateThingShadowInput) SetThingName(v string) *UpdateThingShadowInput {
s.ThingName = &v
return s
}
// The output from the UpdateThingShadow operation.
type UpdateThingShadowOutput struct {
_ struct{} `type:"structure" payload:"Payload"`
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob"`
}
// String returns the string representation
func (s UpdateThingShadowOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s UpdateThingShadowOutput) GoString() string {
return s.String()
}
// SetPayload sets the Payload field's value.
func (s *UpdateThingShadowOutput) SetPayload(v []byte) *UpdateThingShadowOutput {
s.Payload = v
return s
}