forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
1311 lines (1157 loc) · 45.9 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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package resourcegroupstaggingapi
import (
"fmt"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
)
const opGetResources = "GetResources"
// GetResourcesRequest generates a "aws/request.Request" representing the
// client's request for the GetResources operation. The "output" return
// value will be populated with the request's response once the request complets
// successfuly.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetResources for more information on using the GetResources
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the GetResourcesRequest method.
// req, resp := client.GetResourcesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResources
func (c *ResourceGroupsTaggingAPI) GetResourcesRequest(input *GetResourcesInput) (req *request.Request, output *GetResourcesOutput) {
op := &request.Operation{
Name: opGetResources,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"PaginationToken"},
OutputTokens: []string{"PaginationToken"},
LimitToken: "ResourcesPerPage",
TruncationToken: "",
},
}
if input == nil {
input = &GetResourcesInput{}
}
output = &GetResourcesOutput{}
req = c.newRequest(op, input, output)
return
}
// GetResources API operation for AWS Resource Groups Tagging API.
//
// Returns all the tagged resources that are associated with the specified tags
// (keys and values) located in the specified region for the AWS account. The
// tags and the resource types that you specify in the request are known as
// filters. The response includes all tags that are associated with the requested
// resources. If no filter is provided, this action returns a paginated resource
// list with the associated tags.
//
// 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 Resource Groups Tagging API's
// API operation GetResources for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// A parameter is missing or a malformed string or invalid or out-of-range value
// was supplied for the request parameter.
//
// * ErrCodeThrottledException "ThrottledException"
// The request was denied to limit the frequency of submitted requests.
//
// * ErrCodeInternalServiceException "InternalServiceException"
// The request processing failed because of an unknown error, exception, or
// failure. You can retry the request.
//
// * ErrCodePaginationTokenExpiredException "PaginationTokenExpiredException"
// A PaginationToken is valid for a maximum of 15 minutes. Your request was
// denied because the specified PaginationToken has expired.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResources
func (c *ResourceGroupsTaggingAPI) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error) {
req, out := c.GetResourcesRequest(input)
return out, req.Send()
}
// GetResourcesWithContext is the same as GetResources with the addition of
// the ability to pass a context and additional request options.
//
// See GetResources for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) GetResourcesWithContext(ctx aws.Context, input *GetResourcesInput, opts ...request.Option) (*GetResourcesOutput, error) {
req, out := c.GetResourcesRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// GetResourcesPages iterates over the pages of a GetResources operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See GetResources method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a GetResources operation.
// pageNum := 0
// err := client.GetResourcesPages(params,
// func(page *GetResourcesOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
//
func (c *ResourceGroupsTaggingAPI) GetResourcesPages(input *GetResourcesInput, fn func(*GetResourcesOutput, bool) bool) error {
return c.GetResourcesPagesWithContext(aws.BackgroundContext(), input, fn)
}
// GetResourcesPagesWithContext same as GetResourcesPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) GetResourcesPagesWithContext(ctx aws.Context, input *GetResourcesInput, fn func(*GetResourcesOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *GetResourcesInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.GetResourcesRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
cont := true
for p.Next() && cont {
cont = fn(p.Page().(*GetResourcesOutput), !p.HasNextPage())
}
return p.Err()
}
const opGetTagKeys = "GetTagKeys"
// GetTagKeysRequest generates a "aws/request.Request" representing the
// client's request for the GetTagKeys operation. The "output" return
// value will be populated with the request's response once the request complets
// successfuly.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetTagKeys for more information on using the GetTagKeys
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the GetTagKeysRequest method.
// req, resp := client.GetTagKeysRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagKeys
func (c *ResourceGroupsTaggingAPI) GetTagKeysRequest(input *GetTagKeysInput) (req *request.Request, output *GetTagKeysOutput) {
op := &request.Operation{
Name: opGetTagKeys,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"PaginationToken"},
OutputTokens: []string{"PaginationToken"},
LimitToken: "",
TruncationToken: "",
},
}
if input == nil {
input = &GetTagKeysInput{}
}
output = &GetTagKeysOutput{}
req = c.newRequest(op, input, output)
return
}
// GetTagKeys API operation for AWS Resource Groups Tagging API.
//
// Returns all tag keys in the specified region for the AWS account.
//
// 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 Resource Groups Tagging API's
// API operation GetTagKeys for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// A parameter is missing or a malformed string or invalid or out-of-range value
// was supplied for the request parameter.
//
// * ErrCodeThrottledException "ThrottledException"
// The request was denied to limit the frequency of submitted requests.
//
// * ErrCodeInternalServiceException "InternalServiceException"
// The request processing failed because of an unknown error, exception, or
// failure. You can retry the request.
//
// * ErrCodePaginationTokenExpiredException "PaginationTokenExpiredException"
// A PaginationToken is valid for a maximum of 15 minutes. Your request was
// denied because the specified PaginationToken has expired.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagKeys
func (c *ResourceGroupsTaggingAPI) GetTagKeys(input *GetTagKeysInput) (*GetTagKeysOutput, error) {
req, out := c.GetTagKeysRequest(input)
return out, req.Send()
}
// GetTagKeysWithContext is the same as GetTagKeys with the addition of
// the ability to pass a context and additional request options.
//
// See GetTagKeys for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) GetTagKeysWithContext(ctx aws.Context, input *GetTagKeysInput, opts ...request.Option) (*GetTagKeysOutput, error) {
req, out := c.GetTagKeysRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// GetTagKeysPages iterates over the pages of a GetTagKeys operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See GetTagKeys method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a GetTagKeys operation.
// pageNum := 0
// err := client.GetTagKeysPages(params,
// func(page *GetTagKeysOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
//
func (c *ResourceGroupsTaggingAPI) GetTagKeysPages(input *GetTagKeysInput, fn func(*GetTagKeysOutput, bool) bool) error {
return c.GetTagKeysPagesWithContext(aws.BackgroundContext(), input, fn)
}
// GetTagKeysPagesWithContext same as GetTagKeysPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) GetTagKeysPagesWithContext(ctx aws.Context, input *GetTagKeysInput, fn func(*GetTagKeysOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *GetTagKeysInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.GetTagKeysRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
cont := true
for p.Next() && cont {
cont = fn(p.Page().(*GetTagKeysOutput), !p.HasNextPage())
}
return p.Err()
}
const opGetTagValues = "GetTagValues"
// GetTagValuesRequest generates a "aws/request.Request" representing the
// client's request for the GetTagValues operation. The "output" return
// value will be populated with the request's response once the request complets
// successfuly.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetTagValues for more information on using the GetTagValues
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the GetTagValuesRequest method.
// req, resp := client.GetTagValuesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagValues
func (c *ResourceGroupsTaggingAPI) GetTagValuesRequest(input *GetTagValuesInput) (req *request.Request, output *GetTagValuesOutput) {
op := &request.Operation{
Name: opGetTagValues,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"PaginationToken"},
OutputTokens: []string{"PaginationToken"},
LimitToken: "",
TruncationToken: "",
},
}
if input == nil {
input = &GetTagValuesInput{}
}
output = &GetTagValuesOutput{}
req = c.newRequest(op, input, output)
return
}
// GetTagValues API operation for AWS Resource Groups Tagging API.
//
// Returns all tag values for the specified key in the specified region for
// the AWS account.
//
// 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 Resource Groups Tagging API's
// API operation GetTagValues for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// A parameter is missing or a malformed string or invalid or out-of-range value
// was supplied for the request parameter.
//
// * ErrCodeThrottledException "ThrottledException"
// The request was denied to limit the frequency of submitted requests.
//
// * ErrCodeInternalServiceException "InternalServiceException"
// The request processing failed because of an unknown error, exception, or
// failure. You can retry the request.
//
// * ErrCodePaginationTokenExpiredException "PaginationTokenExpiredException"
// A PaginationToken is valid for a maximum of 15 minutes. Your request was
// denied because the specified PaginationToken has expired.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagValues
func (c *ResourceGroupsTaggingAPI) GetTagValues(input *GetTagValuesInput) (*GetTagValuesOutput, error) {
req, out := c.GetTagValuesRequest(input)
return out, req.Send()
}
// GetTagValuesWithContext is the same as GetTagValues with the addition of
// the ability to pass a context and additional request options.
//
// See GetTagValues for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) GetTagValuesWithContext(ctx aws.Context, input *GetTagValuesInput, opts ...request.Option) (*GetTagValuesOutput, error) {
req, out := c.GetTagValuesRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// GetTagValuesPages iterates over the pages of a GetTagValues operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See GetTagValues method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a GetTagValues operation.
// pageNum := 0
// err := client.GetTagValuesPages(params,
// func(page *GetTagValuesOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
//
func (c *ResourceGroupsTaggingAPI) GetTagValuesPages(input *GetTagValuesInput, fn func(*GetTagValuesOutput, bool) bool) error {
return c.GetTagValuesPagesWithContext(aws.BackgroundContext(), input, fn)
}
// GetTagValuesPagesWithContext same as GetTagValuesPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) GetTagValuesPagesWithContext(ctx aws.Context, input *GetTagValuesInput, fn func(*GetTagValuesOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *GetTagValuesInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.GetTagValuesRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
cont := true
for p.Next() && cont {
cont = fn(p.Page().(*GetTagValuesOutput), !p.HasNextPage())
}
return p.Err()
}
const opTagResources = "TagResources"
// TagResourcesRequest generates a "aws/request.Request" representing the
// client's request for the TagResources operation. The "output" return
// value will be populated with the request's response once the request complets
// successfuly.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See TagResources for more information on using the TagResources
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the TagResourcesRequest method.
// req, resp := client.TagResourcesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/TagResources
func (c *ResourceGroupsTaggingAPI) TagResourcesRequest(input *TagResourcesInput) (req *request.Request, output *TagResourcesOutput) {
op := &request.Operation{
Name: opTagResources,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &TagResourcesInput{}
}
output = &TagResourcesOutput{}
req = c.newRequest(op, input, output)
return
}
// TagResources API operation for AWS Resource Groups Tagging API.
//
// Applies one or more tags to the specified resources. Note the following:
//
// * Not all resources can have tags. For a list of resources that support
// tagging, see Supported Resources (http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/supported-resources.html)
// in the AWS Resource Groups and Tag Editor User Guide.
//
// * Each resource can have up to 50 tags. For other limits, see Tag Restrictions
// (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions)
// in the Amazon EC2 User Guide for Linux Instances.
//
// * You can only tag resources that are located in the specified region
// for the AWS account.
//
// * To add tags to a resource, you need the necessary permissions for the
// service that the resource belongs to as well as permissions for adding
// tags. For more information, see Obtaining Permissions for Tagging (http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html)
// in the AWS Resource Groups and Tag Editor User 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 Resource Groups Tagging API's
// API operation TagResources for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// A parameter is missing or a malformed string or invalid or out-of-range value
// was supplied for the request parameter.
//
// * ErrCodeThrottledException "ThrottledException"
// The request was denied to limit the frequency of submitted requests.
//
// * ErrCodeInternalServiceException "InternalServiceException"
// The request processing failed because of an unknown error, exception, or
// failure. You can retry the request.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/TagResources
func (c *ResourceGroupsTaggingAPI) TagResources(input *TagResourcesInput) (*TagResourcesOutput, error) {
req, out := c.TagResourcesRequest(input)
return out, req.Send()
}
// TagResourcesWithContext is the same as TagResources with the addition of
// the ability to pass a context and additional request options.
//
// See TagResources for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) TagResourcesWithContext(ctx aws.Context, input *TagResourcesInput, opts ...request.Option) (*TagResourcesOutput, error) {
req, out := c.TagResourcesRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opUntagResources = "UntagResources"
// UntagResourcesRequest generates a "aws/request.Request" representing the
// client's request for the UntagResources operation. The "output" return
// value will be populated with the request's response once the request complets
// successfuly.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See UntagResources for more information on using the UntagResources
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
//
// // Example sending a request using the UntagResourcesRequest method.
// req, resp := client.UntagResourcesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/UntagResources
func (c *ResourceGroupsTaggingAPI) UntagResourcesRequest(input *UntagResourcesInput) (req *request.Request, output *UntagResourcesOutput) {
op := &request.Operation{
Name: opUntagResources,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &UntagResourcesInput{}
}
output = &UntagResourcesOutput{}
req = c.newRequest(op, input, output)
return
}
// UntagResources API operation for AWS Resource Groups Tagging API.
//
// Removes the specified tags from the specified resources. When you specify
// a tag key, the action removes both that key and its associated value. The
// operation succeeds even if you attempt to remove tags from a resource that
// were already removed. Note the following:
//
// * To remove tags from a resource, you need the necessary permissions for
// the service that the resource belongs to as well as permissions for removing
// tags. For more information, see Obtaining Permissions for Tagging (http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html)
// in the AWS Resource Groups and Tag Editor User Guide.
//
// * You can only tag resources that are located in the specified region
// for the AWS account.
//
// 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 Resource Groups Tagging API's
// API operation UntagResources for usage and error information.
//
// Returned Error Codes:
// * ErrCodeInvalidParameterException "InvalidParameterException"
// A parameter is missing or a malformed string or invalid or out-of-range value
// was supplied for the request parameter.
//
// * ErrCodeThrottledException "ThrottledException"
// The request was denied to limit the frequency of submitted requests.
//
// * ErrCodeInternalServiceException "InternalServiceException"
// The request processing failed because of an unknown error, exception, or
// failure. You can retry the request.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/UntagResources
func (c *ResourceGroupsTaggingAPI) UntagResources(input *UntagResourcesInput) (*UntagResourcesOutput, error) {
req, out := c.UntagResourcesRequest(input)
return out, req.Send()
}
// UntagResourcesWithContext is the same as UntagResources with the addition of
// the ability to pass a context and additional request options.
//
// See UntagResources for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ResourceGroupsTaggingAPI) UntagResourcesWithContext(ctx aws.Context, input *UntagResourcesInput, opts ...request.Option) (*UntagResourcesOutput, error) {
req, out := c.UntagResourcesRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// Details of the common errors that all actions return.
type FailureInfo struct {
_ struct{} `type:"structure"`
// The code of the common error. Valid values include InternalServiceException,
// InvalidParameterException, and any valid error code returned by the AWS service
// that hosts the resource that you want to tag.
ErrorCode *string `type:"string" enum:"ErrorCode"`
// The message of the common error.
ErrorMessage *string `type:"string"`
// The HTTP status code of the common error.
StatusCode *int64 `type:"integer"`
}
// String returns the string representation
func (s FailureInfo) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s FailureInfo) GoString() string {
return s.String()
}
// SetErrorCode sets the ErrorCode field's value.
func (s *FailureInfo) SetErrorCode(v string) *FailureInfo {
s.ErrorCode = &v
return s
}
// SetErrorMessage sets the ErrorMessage field's value.
func (s *FailureInfo) SetErrorMessage(v string) *FailureInfo {
s.ErrorMessage = &v
return s
}
// SetStatusCode sets the StatusCode field's value.
func (s *FailureInfo) SetStatusCode(v int64) *FailureInfo {
s.StatusCode = &v
return s
}
type GetResourcesInput struct {
_ struct{} `type:"structure"`
// A string that indicates that additional data is available. Leave this value
// empty for your initial request. If the response includes a PaginationToken,
// use that string for this value to request an additional page of data.
PaginationToken *string `type:"string"`
// The constraints on the resources that you want returned. The format of each
// resource type is service[:resourceType]. For example, specifying a resource
// type of ec2 returns all tagged Amazon EC2 resources (which includes tagged
// EC2 instances). Specifying a resource type of ec2:instance returns only EC2
// instances.
//
// The string for each service name and resource type is the same as that embedded
// in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference
// for the following:
//
// * For a list of service name strings, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).
//
// * For resource type strings, see Example ARNs (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).
//
// * For more information about ARNs, see Amazon Resource Names (ARNs) and
// AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
ResourceTypeFilters []*string `type:"list"`
// A limit that restricts the number of resources returned by GetResources in
// paginated output. You can set ResourcesPerPage to a minimum of 1 item and
// the maximum of 50 items.
ResourcesPerPage *int64 `type:"integer"`
// A list of tags (keys and values). A request can include up to 50 keys, and
// each key can include up to 20 values.
//
// If you specify multiple filters connected by an AND operator in a single
// request, the response returns only those resources that are associated with
// every specified filter.
//
// If you specify multiple filters connected by an OR operator in a single request,
// the response returns all resources that are associated with at least one
// or possibly more of the specified filters.
TagFilters []*TagFilter `type:"list"`
// A limit that restricts the number of tags (key and value pairs) returned
// by GetResources in paginated output. A resource with no tags is counted as
// having one tag (one key and value pair).
//
// GetResources does not split a resource and its associated tags across pages.
// If the specified TagsPerPage would cause such a break, a PaginationToken
// is returned in place of the affected resource and its tags. Use that token
// in another request to get the remaining data. For example, if you specify
// a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning
// that each resource has 10 key and value pairs), the output will consist of
// 3 pages, with the first page displaying the first 10 resources, each with
// its 10 tags, the second page displaying the next 10 resources each with its
// 10 tags, and the third page displaying the remaining 2 resources, each with
// its 10 tags.
//
// You can set TagsPerPage
TagsPerPage *int64 `type:"integer"`
}
// String returns the string representation
func (s GetResourcesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetResourcesInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetResourcesInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetResourcesInput"}
if s.TagFilters != nil {
for i, v := range s.TagFilters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TagFilters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPaginationToken sets the PaginationToken field's value.
func (s *GetResourcesInput) SetPaginationToken(v string) *GetResourcesInput {
s.PaginationToken = &v
return s
}
// SetResourceTypeFilters sets the ResourceTypeFilters field's value.
func (s *GetResourcesInput) SetResourceTypeFilters(v []*string) *GetResourcesInput {
s.ResourceTypeFilters = v
return s
}
// SetResourcesPerPage sets the ResourcesPerPage field's value.
func (s *GetResourcesInput) SetResourcesPerPage(v int64) *GetResourcesInput {
s.ResourcesPerPage = &v
return s
}
// SetTagFilters sets the TagFilters field's value.
func (s *GetResourcesInput) SetTagFilters(v []*TagFilter) *GetResourcesInput {
s.TagFilters = v
return s
}
// SetTagsPerPage sets the TagsPerPage field's value.
func (s *GetResourcesInput) SetTagsPerPage(v int64) *GetResourcesInput {
s.TagsPerPage = &v
return s
}
type GetResourcesOutput struct {
_ struct{} `type:"structure"`
// A string that indicates that the response contains more data than can be
// returned in a single response. To receive additional data, specify this string
// for the PaginationToken value in a subsequent request.
PaginationToken *string `type:"string"`
// A list of resource ARNs and the tags (keys and values) associated with each.
ResourceTagMappingList []*ResourceTagMapping `type:"list"`
}
// String returns the string representation
func (s GetResourcesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetResourcesOutput) GoString() string {
return s.String()
}
// SetPaginationToken sets the PaginationToken field's value.
func (s *GetResourcesOutput) SetPaginationToken(v string) *GetResourcesOutput {
s.PaginationToken = &v
return s
}
// SetResourceTagMappingList sets the ResourceTagMappingList field's value.
func (s *GetResourcesOutput) SetResourceTagMappingList(v []*ResourceTagMapping) *GetResourcesOutput {
s.ResourceTagMappingList = v
return s
}
type GetTagKeysInput struct {
_ struct{} `type:"structure"`
// A string that indicates that additional data is available. Leave this value
// empty for your initial request. If the response includes a PaginationToken,
// use that string for this value to request an additional page of data.
PaginationToken *string `type:"string"`
}
// String returns the string representation
func (s GetTagKeysInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetTagKeysInput) GoString() string {
return s.String()
}
// SetPaginationToken sets the PaginationToken field's value.
func (s *GetTagKeysInput) SetPaginationToken(v string) *GetTagKeysInput {
s.PaginationToken = &v
return s
}
type GetTagKeysOutput struct {
_ struct{} `type:"structure"`
// A string that indicates that the response contains more data than can be
// returned in a single response. To receive additional data, specify this string
// for the PaginationToken value in a subsequent request.
PaginationToken *string `type:"string"`
// A list of all tag keys in the AWS account.
TagKeys []*string `type:"list"`
}
// String returns the string representation
func (s GetTagKeysOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetTagKeysOutput) GoString() string {
return s.String()
}
// SetPaginationToken sets the PaginationToken field's value.
func (s *GetTagKeysOutput) SetPaginationToken(v string) *GetTagKeysOutput {
s.PaginationToken = &v
return s
}
// SetTagKeys sets the TagKeys field's value.
func (s *GetTagKeysOutput) SetTagKeys(v []*string) *GetTagKeysOutput {
s.TagKeys = v
return s
}
type GetTagValuesInput struct {
_ struct{} `type:"structure"`
// The key for which you want to list all existing values in the specified region
// for the AWS account.
//
// Key is a required field
Key *string `min:"1" type:"string" required:"true"`
// A string that indicates that additional data is available. Leave this value
// empty for your initial request. If the response includes a PaginationToken,
// use that string for this value to request an additional page of data.
PaginationToken *string `type:"string"`
}
// String returns the string representation
func (s GetTagValuesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetTagValuesInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetTagValuesInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetTagValuesInput"}
if s.Key == nil {
invalidParams.Add(request.NewErrParamRequired("Key"))
}
if s.Key != nil && len(*s.Key) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Key", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetKey sets the Key field's value.
func (s *GetTagValuesInput) SetKey(v string) *GetTagValuesInput {
s.Key = &v
return s
}
// SetPaginationToken sets the PaginationToken field's value.
func (s *GetTagValuesInput) SetPaginationToken(v string) *GetTagValuesInput {
s.PaginationToken = &v
return s
}
type GetTagValuesOutput struct {
_ struct{} `type:"structure"`
// A string that indicates that the response contains more data than can be
// returned in a single response. To receive additional data, specify this string
// for the PaginationToken value in a subsequent request.
PaginationToken *string `type:"string"`
// A list of all tag values for the specified key in the AWS account.
TagValues []*string `type:"list"`
}
// String returns the string representation
func (s GetTagValuesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetTagValuesOutput) GoString() string {
return s.String()
}
// SetPaginationToken sets the PaginationToken field's value.
func (s *GetTagValuesOutput) SetPaginationToken(v string) *GetTagValuesOutput {
s.PaginationToken = &v
return s
}