-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_types.go
1704 lines (1361 loc) · 56.7 KB
/
api_types.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 servicecatalog
import (
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
var _ aws.Config
var _ = awsutil.Prettify
// The access level to use to filter results.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/AccessLevelFilter
type AccessLevelFilter struct {
_ struct{} `type:"structure"`
// The access level.
//
// * Account - Filter results based on the account.
//
// * Role - Filter results based on the federated role of the specified user.
//
// * User - Filter results based on the specified user.
Key AccessLevelFilterKey `type:"string" enum:"true"`
// The user to which the access level applies. The only supported value is Self.
Value *string `type:"string"`
}
// String returns the string representation
func (s AccessLevelFilter) String() string {
return awsutil.Prettify(s)
}
// Information about a budget.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/BudgetDetail
type BudgetDetail struct {
_ struct{} `type:"structure"`
// Name of the associated budget.
BudgetName *string `min:"1" type:"string"`
}
// String returns the string representation
func (s BudgetDetail) String() string {
return awsutil.Prettify(s)
}
// Information about a CloudWatch dashboard.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/CloudWatchDashboard
type CloudWatchDashboard struct {
_ struct{} `type:"structure"`
// The name of the CloudWatch dashboard.
Name *string `type:"string"`
}
// String returns the string representation
func (s CloudWatchDashboard) String() string {
return awsutil.Prettify(s)
}
// Information about a constraint.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ConstraintDetail
type ConstraintDetail struct {
_ struct{} `type:"structure"`
// The identifier of the constraint.
ConstraintId *string `min:"1" type:"string"`
// The description of the constraint.
Description *string `type:"string"`
// The owner of the constraint.
Owner *string `type:"string"`
// The type of constraint.
//
// * LAUNCH
//
// * NOTIFICATION
//
// * STACKSET
//
// * TEMPLATE
Type *string `min:"1" type:"string"`
}
// String returns the string representation
func (s ConstraintDetail) String() string {
return awsutil.Prettify(s)
}
// Summary information about a constraint.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ConstraintSummary
type ConstraintSummary struct {
_ struct{} `type:"structure"`
// The description of the constraint.
Description *string `type:"string"`
// The type of constraint.
//
// * LAUNCH
//
// * NOTIFICATION
//
// * STACKSET
//
// * TEMPLATE
Type *string `min:"1" type:"string"`
}
// String returns the string representation
func (s ConstraintSummary) String() string {
return awsutil.Prettify(s)
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ExecutionParameter
type ExecutionParameter struct {
_ struct{} `type:"structure"`
DefaultValues []string `type:"list"`
Name *string `min:"1" type:"string"`
Type *string `min:"1" type:"string"`
}
// String returns the string representation
func (s ExecutionParameter) String() string {
return awsutil.Prettify(s)
}
// An object containing information about the error, along with identifying
// information about the self-service action and its associations.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/FailedServiceActionAssociation
type FailedServiceActionAssociation struct {
_ struct{} `type:"structure"`
// The error code. Valid values are listed below.
ErrorCode ServiceActionAssociationErrorCode `type:"string" enum:"true"`
// A text description of the error.
ErrorMessage *string `min:"1" type:"string"`
// The product identifier. For example, prod-abcdzk7xy33qa.
ProductId *string `min:"1" type:"string"`
// The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
ProvisioningArtifactId *string `min:"1" type:"string"`
// The self-service action identifier. For example, act-fs7abcd89wxyz.
ServiceActionId *string `min:"1" type:"string"`
}
// String returns the string representation
func (s FailedServiceActionAssociation) String() string {
return awsutil.Prettify(s)
}
// Summary information about a product path for a user.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/LaunchPathSummary
type LaunchPathSummary struct {
_ struct{} `type:"structure"`
// The constraints on the portfolio-product relationship.
ConstraintSummaries []ConstraintSummary `type:"list"`
// The identifier of the product path.
Id *string `min:"1" type:"string"`
// The name of the portfolio to which the user was assigned.
Name *string `type:"string"`
// The tags associated with this product path.
Tags []Tag `type:"list"`
}
// String returns the string representation
func (s LaunchPathSummary) String() string {
return awsutil.Prettify(s)
}
// The search filter to use when listing history records.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ListRecordHistorySearchFilter
type ListRecordHistorySearchFilter struct {
_ struct{} `type:"structure"`
// The filter key.
//
// * product - Filter results based on the specified product identifier.
//
// * provisionedproduct - Filter results based on the provisioned product
// identifier.
Key *string `type:"string"`
// The filter value.
Value *string `type:"string"`
}
// String returns the string representation
func (s ListRecordHistorySearchFilter) String() string {
return awsutil.Prettify(s)
}
// Filters to use when listing TagOptions.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ListTagOptionsFilters
type ListTagOptionsFilters struct {
_ struct{} `type:"structure"`
// The active state.
Active *bool `type:"boolean"`
// The TagOption key.
Key *string `min:"1" type:"string"`
// The TagOption value.
Value *string `min:"1" type:"string"`
}
// String returns the string representation
func (s ListTagOptionsFilters) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListTagOptionsFilters) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "ListTagOptionsFilters"}
if s.Key != nil && len(*s.Key) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Key", 1))
}
if s.Value != nil && len(*s.Value) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Value", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Information about the organization node.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/OrganizationNode
type OrganizationNode struct {
_ struct{} `type:"structure"`
// The organization node type.
Type OrganizationNodeType `type:"string" enum:"true"`
// The identifier of the organization node.
Value *string `type:"string"`
}
// String returns the string representation
func (s OrganizationNode) String() string {
return awsutil.Prettify(s)
}
// The constraints that the administrator has put on the parameter.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ParameterConstraints
type ParameterConstraints struct {
_ struct{} `type:"structure"`
// The values that the administrator has allowed for the parameter.
AllowedValues []string `type:"list"`
}
// String returns the string representation
func (s ParameterConstraints) String() string {
return awsutil.Prettify(s)
}
// Information about a portfolio.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/PortfolioDetail
type PortfolioDetail struct {
_ struct{} `type:"structure"`
// The ARN assigned to the portfolio.
ARN *string `min:"1" type:"string"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The description of the portfolio.
Description *string `type:"string"`
// The name to use for display purposes.
DisplayName *string `min:"1" type:"string"`
// The portfolio identifier.
Id *string `min:"1" type:"string"`
// The name of the portfolio provider.
ProviderName *string `min:"1" type:"string"`
}
// String returns the string representation
func (s PortfolioDetail) String() string {
return awsutil.Prettify(s)
}
// Information about a principal.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/Principal
type Principal struct {
_ struct{} `type:"structure"`
// The ARN of the principal (IAM user, role, or group).
PrincipalARN *string `min:"1" type:"string"`
// The principal type. The supported value is IAM.
PrincipalType PrincipalType `type:"string" enum:"true"`
}
// String returns the string representation
func (s Principal) String() string {
return awsutil.Prettify(s)
}
// A single product view aggregation value/count pair, containing metadata about
// each product to which the calling user has access.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProductViewAggregationValue
type ProductViewAggregationValue struct {
_ struct{} `type:"structure"`
// An approximate count of the products that match the value.
ApproximateCount *int64 `type:"integer"`
// The value of the product view aggregation.
Value *string `type:"string"`
}
// String returns the string representation
func (s ProductViewAggregationValue) String() string {
return awsutil.Prettify(s)
}
// Information about a product view.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProductViewDetail
type ProductViewDetail struct {
_ struct{} `type:"structure"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The ARN of the product.
ProductARN *string `min:"1" type:"string"`
// Summary information about the product view.
ProductViewSummary *ProductViewSummary `type:"structure"`
// The status of the product.
//
// * AVAILABLE - The product is ready for use.
//
// * CREATING - Product creation has started; the product is not ready for
// use.
//
// * FAILED - An action failed.
Status Status `type:"string" enum:"true"`
}
// String returns the string representation
func (s ProductViewDetail) String() string {
return awsutil.Prettify(s)
}
// Summary information about a product view.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProductViewSummary
type ProductViewSummary struct {
_ struct{} `type:"structure"`
// The distributor of the product. Contact the product administrator for the
// significance of this value.
Distributor *string `type:"string"`
// Indicates whether the product has a default path. If the product does not
// have a default path, call ListLaunchPaths to disambiguate between paths.
// Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary
// can be used directly with DescribeProvisioningParameters.
HasDefaultPath *bool `type:"boolean"`
// The product view identifier.
Id *string `min:"1" type:"string"`
// The name of the product.
Name *string `type:"string"`
// The owner of the product. Contact the product administrator for the significance
// of this value.
Owner *string `type:"string"`
// The product identifier.
ProductId *string `min:"1" type:"string"`
// Short description of the product.
ShortDescription *string `type:"string"`
// The description of the support for this Product.
SupportDescription *string `type:"string"`
// The email contact information to obtain support for this Product.
SupportEmail *string `type:"string"`
// The URL information to obtain support for this Product.
SupportUrl *string `type:"string"`
// The product type. Contact the product administrator for the significance
// of this value. If this value is MARKETPLACE, the product was created by AWS
// Marketplace.
Type ProductType `type:"string" enum:"true"`
}
// String returns the string representation
func (s ProductViewSummary) String() string {
return awsutil.Prettify(s)
}
// Information about a provisioned product.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisionedProductAttribute
type ProvisionedProductAttribute struct {
_ struct{} `type:"structure"`
// The ARN of the provisioned product.
Arn *string `min:"1" type:"string"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The identifier of the provisioned product.
Id *string `min:"1" type:"string"`
// A unique identifier that you provide to ensure idempotency. If multiple requests
// differ only by the idempotency token, the same response is returned for each
// repeated request.
IdempotencyToken *string `min:"1" type:"string"`
// The record identifier of the last request performed on this provisioned product.
LastRecordId *string `min:"1" type:"string"`
// The user-friendly name of the provisioned product.
Name *string `min:"1" type:"string"`
// The assigned identifier for the resource, such as an EC2 instance ID or an
// S3 bucket name.
PhysicalId *string `type:"string"`
// The product identifier.
ProductId *string `min:"1" type:"string"`
// The identifier of the provisioning artifact.
ProvisioningArtifactId *string `min:"1" type:"string"`
// The current status of the provisioned product.
//
// * AVAILABLE - Stable state, ready to perform any operation. The most recent
// operation succeeded and completed.
//
// * UNDER_CHANGE - Transitive state. Operations performed might not have
// valid results. Wait for an AVAILABLE status before performing operations.
//
// * TAINTED - Stable state, ready to perform any operation. The stack has
// completed the requested operation but is not exactly what was requested.
// For example, a request to update to a new version failed and the stack
// rolled back to the current version.
//
// * ERROR - An unexpected error occurred. The provisioned product exists
// but the stack is not running. For example, CloudFormation received a parameter
// value that was not valid and could not launch the stack.
//
// * PLAN_IN_PROGRESS - Transitive state. The plan operations were performed
// to provision a new product, but resources have not yet been created. After
// reviewing the list of resources to be created, execute the plan. Wait
// for an AVAILABLE status before performing operations.
Status ProvisionedProductStatus `type:"string" enum:"true"`
// The current status message of the provisioned product.
StatusMessage *string `type:"string"`
// One or more tags.
Tags []Tag `type:"list"`
// The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.
Type *string `type:"string"`
// The Amazon Resource Name (ARN) of the IAM user.
UserArn *string `type:"string"`
// The ARN of the IAM user in the session. This ARN might contain a session
// ID.
UserArnSession *string `type:"string"`
}
// String returns the string representation
func (s ProvisionedProductAttribute) String() string {
return awsutil.Prettify(s)
}
// Information about a provisioned product.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisionedProductDetail
type ProvisionedProductDetail struct {
_ struct{} `type:"structure"`
// The ARN of the provisioned product.
Arn *string `min:"1" type:"string"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The identifier of the provisioned product.
Id *string `type:"string"`
// A unique identifier that you provide to ensure idempotency. If multiple requests
// differ only by the idempotency token, the same response is returned for each
// repeated request.
IdempotencyToken *string `min:"1" type:"string"`
// The record identifier of the last request performed on this provisioned product.
LastRecordId *string `type:"string"`
// The user-friendly name of the provisioned product.
Name *string `min:"1" type:"string"`
// The product identifier. For example, prod-abcdzk7xy33qa.
ProductId *string `min:"1" type:"string"`
// The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
ProvisioningArtifactId *string `min:"1" type:"string"`
// The current status of the provisioned product.
//
// * AVAILABLE - Stable state, ready to perform any operation. The most recent
// operation succeeded and completed.
//
// * UNDER_CHANGE - Transitive state. Operations performed might not have
// valid results. Wait for an AVAILABLE status before performing operations.
//
// * TAINTED - Stable state, ready to perform any operation. The stack has
// completed the requested operation but is not exactly what was requested.
// For example, a request to update to a new version failed and the stack
// rolled back to the current version.
//
// * ERROR - An unexpected error occurred. The provisioned product exists
// but the stack is not running. For example, CloudFormation received a parameter
// value that was not valid and could not launch the stack.
//
// * PLAN_IN_PROGRESS - Transitive state. The plan operations were performed
// to provision a new product, but resources have not yet been created. After
// reviewing the list of resources to be created, execute the plan. Wait
// for an AVAILABLE status before performing operations.
Status ProvisionedProductStatus `type:"string" enum:"true"`
// The current status message of the provisioned product.
StatusMessage *string `type:"string"`
// The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.
Type *string `type:"string"`
}
// String returns the string representation
func (s ProvisionedProductDetail) String() string {
return awsutil.Prettify(s)
}
// Information about a plan.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisionedProductPlanDetails
type ProvisionedProductPlanDetails struct {
_ struct{} `type:"structure"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related
// events.
NotificationArns []string `type:"list"`
// The path identifier of the product. This value is optional if the product
// has a default path, and required if the product has more than one path. To
// list the paths for a product, use ListLaunchPaths.
PathId *string `min:"1" type:"string"`
// The plan identifier.
PlanId *string `min:"1" type:"string"`
// The name of the plan.
PlanName *string `type:"string"`
// The plan type.
PlanType ProvisionedProductPlanType `type:"string" enum:"true"`
// The product identifier.
ProductId *string `min:"1" type:"string"`
// The product identifier.
ProvisionProductId *string `min:"1" type:"string"`
// The user-friendly name of the provisioned product.
ProvisionProductName *string `min:"1" type:"string"`
// The identifier of the provisioning artifact.
ProvisioningArtifactId *string `min:"1" type:"string"`
// Parameters specified by the administrator that are required for provisioning
// the product.
ProvisioningParameters []UpdateProvisioningParameter `type:"list"`
// The status.
Status ProvisionedProductPlanStatus `type:"string" enum:"true"`
// The status message.
StatusMessage *string `type:"string"`
// One or more tags.
Tags []Tag `type:"list"`
// The time when the plan was last updated.
UpdatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
}
// String returns the string representation
func (s ProvisionedProductPlanDetails) String() string {
return awsutil.Prettify(s)
}
// Summary information about a plan.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisionedProductPlanSummary
type ProvisionedProductPlanSummary struct {
_ struct{} `type:"structure"`
// The plan identifier.
PlanId *string `min:"1" type:"string"`
// The name of the plan.
PlanName *string `type:"string"`
// The plan type.
PlanType ProvisionedProductPlanType `type:"string" enum:"true"`
// The product identifier.
ProvisionProductId *string `min:"1" type:"string"`
// The user-friendly name of the provisioned product.
ProvisionProductName *string `min:"1" type:"string"`
// The identifier of the provisioning artifact.
ProvisioningArtifactId *string `min:"1" type:"string"`
}
// String returns the string representation
func (s ProvisionedProductPlanSummary) String() string {
return awsutil.Prettify(s)
}
// Information about a provisioning artifact. A provisioning artifact is also
// known as a product version.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningArtifact
type ProvisioningArtifact struct {
_ struct{} `type:"structure"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The description of the provisioning artifact.
Description *string `type:"string"`
// Information set by the administrator to provide guidance to end users about
// which provisioning artifacts to use.
Guidance ProvisioningArtifactGuidance `type:"string" enum:"true"`
// The identifier of the provisioning artifact.
Id *string `min:"1" type:"string"`
// The name of the provisioning artifact.
Name *string `type:"string"`
}
// String returns the string representation
func (s ProvisioningArtifact) String() string {
return awsutil.Prettify(s)
}
// Information about a provisioning artifact (also known as a version) for a
// product.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningArtifactDetail
type ProvisioningArtifactDetail struct {
_ struct{} `type:"structure"`
// Indicates whether the product version is active.
Active *bool `type:"boolean"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The description of the provisioning artifact.
Description *string `type:"string"`
// Information set by the administrator to provide guidance to end users about
// which provisioning artifacts to use.
Guidance ProvisioningArtifactGuidance `type:"string" enum:"true"`
// The identifier of the provisioning artifact.
Id *string `min:"1" type:"string"`
// The name of the provisioning artifact.
Name *string `type:"string"`
// The type of provisioning artifact.
//
// * CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template
//
// * MARKETPLACE_AMI - AWS Marketplace AMI
//
// * MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources
Type ProvisioningArtifactType `type:"string" enum:"true"`
}
// String returns the string representation
func (s ProvisioningArtifactDetail) String() string {
return awsutil.Prettify(s)
}
// Information about a parameter used to provision a product.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningArtifactParameter
type ProvisioningArtifactParameter struct {
_ struct{} `type:"structure"`
// The default value.
DefaultValue *string `type:"string"`
// The description of the parameter.
Description *string `type:"string"`
// If this value is true, the value for this parameter is obfuscated from view
// when the parameter is retrieved. This parameter is used to hide sensitive
// information.
IsNoEcho *bool `type:"boolean"`
// Constraints that the administrator has put on a parameter.
ParameterConstraints *ParameterConstraints `type:"structure"`
// The parameter key.
ParameterKey *string `min:"1" type:"string"`
// The parameter type.
ParameterType *string `type:"string"`
}
// String returns the string representation
func (s ProvisioningArtifactParameter) String() string {
return awsutil.Prettify(s)
}
// The user-defined preferences that will be applied during product provisioning,
// unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences.
//
// For more information on maximum concurrent accounts and failure tolerance,
// see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options)
// in the AWS CloudFormation User Guide.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningArtifactPreferences
type ProvisioningArtifactPreferences struct {
_ struct{} `type:"structure"`
// One or more AWS accounts where stack instances are deployed from the stack
// set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts
// and UpdateProvisioningPreferences$StackSetAccounts.
//
// Applicable only to a CFN_STACKSET provisioned product type.
StackSetAccounts []string `type:"list"`
// One or more AWS Regions where stack instances are deployed from the stack
// set. These regions can be scoped in ProvisioningPreferences$StackSetRegions
// and UpdateProvisioningPreferences$StackSetRegions.
//
// Applicable only to a CFN_STACKSET provisioned product type.
StackSetRegions []string `type:"list"`
}
// String returns the string representation
func (s ProvisioningArtifactPreferences) String() string {
return awsutil.Prettify(s)
}
// Information about a provisioning artifact (also known as a version) for a
// product.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningArtifactProperties
type ProvisioningArtifactProperties struct {
_ struct{} `type:"structure"`
// The description of the provisioning artifact, including how it differs from
// the previous provisioning artifact.
Description *string `type:"string"`
// If set to true, AWS Service Catalog stops validating the specified provisioning
// artifact even if it is invalid.
DisableTemplateValidation *bool `type:"boolean"`
// The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON
// format as follows:
//
// "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
//
// Info is a required field
Info map[string]string `min:"1" type:"map" required:"true"`
// The name of the provisioning artifact (for example, v1 v2beta). No spaces
// are allowed.
Name *string `type:"string"`
// The type of provisioning artifact.
//
// * CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template
//
// * MARKETPLACE_AMI - AWS Marketplace AMI
//
// * MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources
Type ProvisioningArtifactType `type:"string" enum:"true"`
}
// String returns the string representation
func (s ProvisioningArtifactProperties) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ProvisioningArtifactProperties) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "ProvisioningArtifactProperties"}
if s.Info == nil {
invalidParams.Add(aws.NewErrParamRequired("Info"))
}
if s.Info != nil && len(s.Info) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Info", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Summary information about a provisioning artifact (also known as a version)
// for a product.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningArtifactSummary
type ProvisioningArtifactSummary struct {
_ struct{} `type:"structure"`
// The UTC time stamp of the creation time.
CreatedTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The description of the provisioning artifact.
Description *string `type:"string"`
// The identifier of the provisioning artifact.
Id *string `min:"1" type:"string"`
// The name of the provisioning artifact.
Name *string `type:"string"`
// The metadata for the provisioning artifact. This is used with AWS Marketplace
// products.
ProvisioningArtifactMetadata map[string]string `min:"1" type:"map"`
}
// String returns the string representation
func (s ProvisioningArtifactSummary) String() string {
return awsutil.Prettify(s)
}
// An object that contains summary information about a product view and a provisioning
// artifact.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningArtifactView
type ProvisioningArtifactView struct {
_ struct{} `type:"structure"`
// Summary information about a product view.
ProductViewSummary *ProductViewSummary `type:"structure"`
// Information about a provisioning artifact. A provisioning artifact is also
// known as a product version.
ProvisioningArtifact *ProvisioningArtifact `type:"structure"`
}
// String returns the string representation
func (s ProvisioningArtifactView) String() string {
return awsutil.Prettify(s)
}
// Information about a parameter used to provision a product.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningParameter
type ProvisioningParameter struct {
_ struct{} `type:"structure"`
// The parameter key.
Key *string `min:"1" type:"string"`
// The parameter value.
Value *string `type:"string"`
}
// String returns the string representation
func (s ProvisioningParameter) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ProvisioningParameter) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "ProvisioningParameter"}
if s.Key != nil && len(*s.Key) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Key", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// The user-defined preferences that will be applied when updating a provisioned
// product. Not all preferences are applicable to all provisioned product types.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ProvisioningPreferences
type ProvisioningPreferences struct {
_ struct{} `type:"structure"`
// One or more AWS accounts that will have access to the provisioned product.
//
// Applicable only to a CFN_STACKSET provisioned product type.
//
// The AWS accounts specified should be within the list of accounts in the STACKSET
// constraint. To get the list of accounts in the STACKSET constraint, use the
// DescribeProvisioningParameters operation.
//
// If no values are specified, the default value is all accounts from the STACKSET
// constraint.
StackSetAccounts []string `type:"list"`
// The number of accounts, per region, for which this operation can fail before
// AWS Service Catalog stops the operation in that region. If the operation
// is stopped in a region, AWS Service Catalog doesn't attempt the operation
// in any subsequent regions.
//
// Applicable only to a CFN_STACKSET provisioned product type.
//
// Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage,
// but not both.
//
// The default value is 0 if no value is specified.
StackSetFailureToleranceCount *int64 `type:"integer"`
// The percentage of accounts, per region, for which this stack operation can
// fail before AWS Service Catalog stops the operation in that region. If the
// operation is stopped in a region, AWS Service Catalog doesn't attempt the
// operation in any subsequent regions.
//
// When calculating the number of accounts based on the specified percentage,
// AWS Service Catalog rounds down to the next whole number.
//
// Applicable only to a CFN_STACKSET provisioned product type.
//
// Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage,
// but not both.
StackSetFailureTolerancePercentage *int64 `type:"integer"`
// The maximum number of accounts in which to perform this operation at one
// time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount
// is at most one more than the StackSetFailureToleranceCount.
//
// Note that this setting lets you specify the maximum for operations. For large
// deployments, under certain circumstances the actual number of accounts acted
// upon concurrently may be lower due to service throttling.
//
// Applicable only to a CFN_STACKSET provisioned product type.
//
// Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage,
// but not both.
StackSetMaxConcurrencyCount *int64 `min:"1" type:"integer"`
// The maximum percentage of accounts in which to perform this operation at
// one time.
//
// When calculating the number of accounts based on the specified percentage,
// AWS Service Catalog rounds down to the next whole number. This is true except
// in cases where rounding down would result is zero. In this case, AWS Service
// Catalog sets the number as 1 instead.
//
// Note that this setting lets you specify the maximum for operations. For large
// deployments, under certain circumstances the actual number of accounts acted
// upon concurrently may be lower due to service throttling.
//
// Applicable only to a CFN_STACKSET provisioned product type.
//
// Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage,
// but not both.
StackSetMaxConcurrencyPercentage *int64 `min:"1" type:"integer"`
// One or more AWS Regions where the provisioned product will be available.
//
// Applicable only to a CFN_STACKSET provisioned product type.