File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (871 lines) | stat: -rw-r--r-- 21,376 bytes parent folder | download
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
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Describes automated discovery.
type AutomatedDiscoveryInformation struct {

	// Time that automated discovery last ran.
	LastRunTime *time.Time

	noSmithyDocumentSerde
}

// Details about a borrow configuration.
type BorrowConfiguration struct {

	// Indicates whether early check-ins are allowed.
	//
	// This member is required.
	AllowEarlyCheckIn *bool

	// Maximum time for the borrow configuration, in minutes.
	//
	// This member is required.
	MaxTimeToLiveInMinutes *int32

	noSmithyDocumentSerde
}

// Details about license consumption.
type ConsumedLicenseSummary struct {

	// Number of licenses consumed by the resource.
	ConsumedLicenses *int64

	// Resource type of the resource consuming a license.
	ResourceType ResourceType

	noSmithyDocumentSerde
}

// Details about a consumption configuration.
type ConsumptionConfiguration struct {

	// Details about a borrow configuration.
	BorrowConfiguration *BorrowConfiguration

	// Details about a provisional configuration.
	ProvisionalConfiguration *ProvisionalConfiguration

	// Renewal frequency.
	RenewType RenewType

	noSmithyDocumentSerde
}

// Describes a time range, in ISO8601-UTC format.
type DatetimeRange struct {

	// Start of the time range.
	//
	// This member is required.
	Begin *string

	// End of the time range.
	End *string

	noSmithyDocumentSerde
}

// Describes a resource entitled for use with a license.
type Entitlement struct {

	// Entitlement name.
	//
	// This member is required.
	Name *string

	// Entitlement unit.
	//
	// This member is required.
	Unit EntitlementUnit

	// Indicates whether check-ins are allowed.
	AllowCheckIn *bool

	// Maximum entitlement count. Use if the unit is not None.
	MaxCount *int64

	// Indicates whether overages are allowed.
	Overage *bool

	// Entitlement resource. Use only if the unit is None.
	Value *string

	noSmithyDocumentSerde
}

// Data associated with an entitlement resource.
type EntitlementData struct {

	// Entitlement data name.
	//
	// This member is required.
	Name *string

	// Entitlement data unit.
	//
	// This member is required.
	Unit EntitlementDataUnit

	// Entitlement data value.
	Value *string

	noSmithyDocumentSerde
}

// Usage associated with an entitlement resource.
type EntitlementUsage struct {

	// Resource usage consumed.
	//
	// This member is required.
	ConsumedValue *string

	// Entitlement usage name.
	//
	// This member is required.
	Name *string

	// Entitlement usage unit.
	//
	// This member is required.
	Unit EntitlementDataUnit

	// Maximum entitlement usage count.
	MaxCount *string

	noSmithyDocumentSerde
}

// A filter name and value pair that is used to return more specific results from
// a describe operation. Filters can be used to match a set of resources by
// specific criteria, such as tags, attributes, or IDs.
type Filter struct {

	// Name of the filter. Filter names are case-sensitive.
	Name *string

	// The value of the filter, which is case-sensitive. You can only specify one
	// value for the filter.
	Values []string

	noSmithyDocumentSerde
}

// Describes a grant.
type Grant struct {

	// Amazon Resource Name (ARN) of the grant.
	//
	// This member is required.
	GrantArn *string

	// Grant name.
	//
	// This member is required.
	GrantName *string

	// Grant status.
	//
	// This member is required.
	GrantStatus GrantStatus

	// Granted operations.
	//
	// This member is required.
	GrantedOperations []AllowedOperation

	// The grantee principal ARN.
	//
	// This member is required.
	GranteePrincipalArn *string

	// Home Region of the grant.
	//
	// This member is required.
	HomeRegion *string

	// License ARN.
	//
	// This member is required.
	LicenseArn *string

	// Parent ARN.
	//
	// This member is required.
	ParentArn *string

	// Grant version.
	//
	// This member is required.
	Version *string

	// The options specified for the grant.
	Options *Options

	// Grant status reason.
	StatusReason *string

	noSmithyDocumentSerde
}

// Describes a license that is granted to a grantee.
type GrantedLicense struct {

	// Granted license beneficiary.
	Beneficiary *string

	// Configuration for consumption of the license.
	ConsumptionConfiguration *ConsumptionConfiguration

	// Creation time of the granted license.
	CreateTime *string

	// License entitlements.
	Entitlements []Entitlement

	// Home Region of the granted license.
	HomeRegion *string

	// Granted license issuer.
	Issuer *IssuerDetails

	// Amazon Resource Name (ARN) of the license.
	LicenseArn *string

	// Granted license metadata.
	LicenseMetadata []Metadata

	// License name.
	LicenseName *string

	// Product name.
	ProductName *string

	// Product SKU.
	ProductSKU *string

	// Granted license received metadata.
	ReceivedMetadata *ReceivedMetadata

	// Granted license status.
	Status LicenseStatus

	// Date and time range during which the granted license is valid, in ISO8601-UTC
	// format.
	Validity *DatetimeRange

	// Version of the granted license.
	Version *string

	noSmithyDocumentSerde
}

// An inventory filter.
type InventoryFilter struct {

	// Condition of the filter.
	//
	// This member is required.
	Condition InventoryFilterCondition

	// Name of the filter.
	//
	// This member is required.
	Name *string

	// Value of the filter.
	Value *string

	noSmithyDocumentSerde
}

// Details about the issuer of a license.
type Issuer struct {

	// Issuer name.
	//
	// This member is required.
	Name *string

	// Asymmetric KMS key from Key Management Service. The KMS key must have a key
	// usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
	SignKey *string

	noSmithyDocumentSerde
}

// Details associated with the issuer of a license.
type IssuerDetails struct {

	// Issuer key fingerprint.
	KeyFingerprint *string

	// Issuer name.
	Name *string

	// Asymmetric KMS key from Key Management Service. The KMS key must have a key
	// usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
	SignKey *string

	noSmithyDocumentSerde
}

// Software license that is managed in License Manager.
type License struct {

	// License beneficiary.
	Beneficiary *string

	// Configuration for consumption of the license.
	ConsumptionConfiguration *ConsumptionConfiguration

	// License creation time.
	CreateTime *string

	// License entitlements.
	Entitlements []Entitlement

	// Home Region of the license.
	HomeRegion *string

	// License issuer.
	Issuer *IssuerDetails

	// Amazon Resource Name (ARN) of the license.
	LicenseArn *string

	// License metadata.
	LicenseMetadata []Metadata

	// License name.
	LicenseName *string

	// Product name.
	ProductName *string

	// Product SKU.
	ProductSKU *string

	// License status.
	Status LicenseStatus

	// Date and time range during which the license is valid, in ISO8601-UTC format.
	Validity *DatetimeRange

	// License version.
	Version *string

	noSmithyDocumentSerde
}

// A license configuration is an abstraction of a customer license agreement that
// can be consumed and enforced by License Manager. Components include
// specifications for the license type (licensing by instance, socket, CPU, or
// vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or
// all of these), host affinity (how long a VM must be associated with a host), and
// the number of licenses purchased and used.
type LicenseConfiguration struct {

	// Automated discovery information.
	AutomatedDiscoveryInformation *AutomatedDiscoveryInformation

	// Summaries for licenses consumed by various resources.
	ConsumedLicenseSummaryList []ConsumedLicenseSummary

	// Number of licenses consumed.
	ConsumedLicenses *int64

	// Description of the license configuration.
	Description *string

	// When true, disassociates a resource when software is uninstalled.
	DisassociateWhenNotFound *bool

	// Amazon Resource Name (ARN) of the license configuration.
	LicenseConfigurationArn *string

	// Unique ID of the license configuration.
	LicenseConfigurationId *string

	// Number of licenses managed by the license configuration.
	LicenseCount *int64

	// Number of available licenses as a hard limit.
	LicenseCountHardLimit *bool

	// Dimension to use to track the license inventory.
	LicenseCountingType LicenseCountingType

	// License rules.
	LicenseRules []string

	// Summaries for managed resources.
	ManagedResourceSummaryList []ManagedResourceSummary

	// Name of the license configuration.
	Name *string

	// Account ID of the license configuration's owner.
	OwnerAccountId *string

	// Product information.
	ProductInformationList []ProductInformation

	// Status of the license configuration.
	Status *string

	noSmithyDocumentSerde
}

// Describes an association with a license configuration.
type LicenseConfigurationAssociation struct {

	// Scope of AMI associations. The possible value is cross-account .
	AmiAssociationScope *string

	// Time when the license configuration was associated with the resource.
	AssociationTime *time.Time

	// Amazon Resource Name (ARN) of the resource.
	ResourceArn *string

	// ID of the Amazon Web Services account that owns the resource consuming licenses.
	ResourceOwnerId *string

	// Type of server resource.
	ResourceType ResourceType

	noSmithyDocumentSerde
}

// Details about the usage of a resource associated with a license configuration.
type LicenseConfigurationUsage struct {

	// Time when the license configuration was initially associated with the resource.
	AssociationTime *time.Time

	// Number of licenses consumed by the resource.
	ConsumedLicenses *int64

	// Amazon Resource Name (ARN) of the resource.
	ResourceArn *string

	// ID of the account that owns the resource.
	ResourceOwnerId *string

	// Status of the resource.
	ResourceStatus *string

	// Type of resource.
	ResourceType ResourceType

	noSmithyDocumentSerde
}

// Information about a license type conversion task.
type LicenseConversionContext struct {

	// The Usage operation value that corresponds to the license type you are
	// converting your resource from. For more information about which platforms
	// correspond to which usage operation values see Sample data: usage operation by
	// platform  (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html#billing-info)
	UsageOperation *string

	noSmithyDocumentSerde
}

// Information about a license type conversion task.
type LicenseConversionTask struct {

	// Information about the license type this conversion task converted to.
	DestinationLicenseContext *LicenseConversionContext

	// The time the conversion task was completed.
	EndTime *time.Time

	// The ID of the license type conversion task.
	LicenseConversionTaskId *string

	// The time the usage operation value of the resource was changed.
	LicenseConversionTime *time.Time

	// The Amazon Resource Name (ARN) of the resource associated with the license type
	// conversion task.
	ResourceArn *string

	// Information about the license type this conversion task converted from.
	SourceLicenseContext *LicenseConversionContext

	// The time the conversion task was started at.
	StartTime *time.Time

	// The status of the conversion task.
	Status LicenseConversionTaskStatus

	// The status message for the conversion task.
	StatusMessage *string

	noSmithyDocumentSerde
}

// Describes the failure of a license operation.
type LicenseOperationFailure struct {

	// Error message.
	ErrorMessage *string

	// Failure time.
	FailureTime *time.Time

	// Reserved.
	MetadataList []Metadata

	// Name of the operation.
	OperationName *string

	// The requester is "License Manager Automated Discovery".
	OperationRequestedBy *string

	// Amazon Resource Name (ARN) of the resource.
	ResourceArn *string

	// ID of the Amazon Web Services account that owns the resource.
	ResourceOwnerId *string

	// Resource type.
	ResourceType ResourceType

	noSmithyDocumentSerde
}

// Details for associating a license configuration with a resource.
type LicenseSpecification struct {

	// Amazon Resource Name (ARN) of the license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string

	// Scope of AMI associations. The possible value is cross-account .
	AmiAssociationScope *string

	noSmithyDocumentSerde
}

// Describes the entitlement usage associated with a license.
type LicenseUsage struct {

	// License entitlement usages.
	EntitlementUsages []EntitlementUsage

	noSmithyDocumentSerde
}

// Summary information about a managed resource.
type ManagedResourceSummary struct {

	// Number of resources associated with licenses.
	AssociationCount *int64

	// Type of resource associated with a license.
	ResourceType ResourceType

	noSmithyDocumentSerde
}

// Describes key/value pairs.
type Metadata struct {

	// The key name.
	Name *string

	// The value.
	Value *string

	noSmithyDocumentSerde
}

// The options you can specify when you create a new version of a grant, such as
// activation override behavior. For more information, see Granted licenses in
// License Manager (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html)
// in the License Manager User Guide.
type Options struct {

	// An activation option for your grant that determines the behavior of activating
	// a grant. Activation options can only be used with granted licenses sourced from
	// the Amazon Web Services Marketplace. Additionally, the operation must specify
	// the value of ACTIVE for the Status parameter.
	//   - As a license administrator, you can optionally specify an
	//   ActivationOverrideBehavior when activating a grant.
	//   - As a grantor, you can optionally specify an ActivationOverrideBehavior when
	//   you activate a grant for a grantee account in your organization.
	//   - As a grantee, if the grantor creating the distributed grant doesn’t specify
	//   an ActivationOverrideBehavior , you can optionally specify one when you are
	//   activating the grant.
	// DISTRIBUTED_GRANTS_ONLY Use this value to activate a grant without replacing
	// any member account’s active grants for the same product.
	// ALL_GRANTS_PERMITTED_BY_ISSUER Use this value to activate a grant and disable
	// other active grants in any member accounts for the same product. This action
	// will also replace their previously activated grants with this activated grant.
	ActivationOverrideBehavior ActivationOverrideBehavior

	noSmithyDocumentSerde
}

// Configuration information for Organizations.
type OrganizationConfiguration struct {

	// Enables Organizations integration.
	//
	// This member is required.
	EnableIntegration bool

	noSmithyDocumentSerde
}

// Describes product information for a license configuration.
type ProductInformation struct {

	// A Product information filter consists of a ProductInformationFilterComparator
	// which is a logical operator, a ProductInformationFilterName which specifies the
	// type of filter being declared, and a ProductInformationFilterValue that
	// specifies the value to filter on. Accepted values for
	// ProductInformationFilterName are listed here along with descriptions and valid
	// options for ProductInformationFilterComparator . The following filters and are
	// supported when the resource type is SSM_MANAGED :
	//   - Application Name - The name of the application. Logical operator is EQUALS .
	//   - Application Publisher - The publisher of the application. Logical operator
	//   is EQUALS .
	//   - Application Version - The version of the application. Logical operator is
	//   EQUALS .
	//   - Platform Name - The name of the platform. Logical operator is EQUALS .
	//   - Platform Type - The platform type. Logical operator is EQUALS .
	//   - Tag:key - The key of a tag attached to an Amazon Web Services resource you
	//   wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The
	//   key for your tag must be appended to Tag: following the example:
	//   Tag:name-of-your-key . ProductInformationFilterValue is optional if you are
	//   not using values for the key.
	//   - AccountId - The 12-digit ID of an Amazon Web Services account you wish to
	//   exclude from automated discovery. Logical operator is NOT_EQUALS .
	//   - License Included - The type of license included. Logical operators are
	//   EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise |
	//   sql-server-standard | sql-server-web | windows-server-datacenter .
	// The following filters and logical operators are supported when the resource
	// type is RDS :
	//   - Engine Edition - The edition of the database engine. Logical operator is
	//   EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2
	//   .
	//   - License Pack - The license pack. Logical operator is EQUALS . Possible
	//   values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap
	//   .
	//
	// This member is required.
	ProductInformationFilterList []ProductInformationFilter

	// Resource type. The possible values are SSM_MANAGED | RDS .
	//
	// This member is required.
	ResourceType *string

	noSmithyDocumentSerde
}

// Describes product information filters.
type ProductInformationFilter struct {

	// Logical operator.
	//
	// This member is required.
	ProductInformationFilterComparator *string

	// Filter name.
	//
	// This member is required.
	ProductInformationFilterName *string

	// Filter value.
	ProductInformationFilterValue []string

	noSmithyDocumentSerde
}

// Details about a provisional configuration.
type ProvisionalConfiguration struct {

	// Maximum time for the provisional configuration, in minutes.
	//
	// This member is required.
	MaxTimeToLiveInMinutes *int32

	noSmithyDocumentSerde
}

// Metadata associated with received licenses and grants.
type ReceivedMetadata struct {

	// Allowed operations.
	AllowedOperations []AllowedOperation

	// Received status.
	ReceivedStatus ReceivedStatus

	// Received status reason.
	ReceivedStatusReason *string

	noSmithyDocumentSerde
}

// Details of the license configuration that this generator reports on.
type ReportContext struct {

	// Amazon Resource Name (ARN) of the license configuration that this generator
	// reports on.
	//
	// This member is required.
	LicenseConfigurationArns []string

	noSmithyDocumentSerde
}

// Details about how frequently reports are generated.
type ReportFrequency struct {

	// Time period between each report. The period can be daily, weekly, or monthly.
	Period ReportFrequencyType

	// Number of times within the frequency period that a report is generated. The
	// only supported value is 1 .
	Value *int32

	noSmithyDocumentSerde
}

// Describe the details of a report generator.
type ReportGenerator struct {

	// Time the report was created.
	CreateTime *string

	// Description of the report generator.
	Description *string

	// Time the last report was generated at.
	LastReportGenerationTime *string

	// Failure message for the last report generation attempt.
	LastRunFailureReason *string

	// Status of the last report generation attempt.
	LastRunStatus *string

	// Amazon Resource Name (ARN) of the report generator.
	LicenseManagerReportGeneratorArn *string

	// License configuration type for this generator.
	ReportContext *ReportContext

	// The Amazon Web Services account ID used to create the report generator.
	ReportCreatorAccount *string

	// Details about how frequently reports are generated.
	ReportFrequency *ReportFrequency

	// Name of the report generator.
	ReportGeneratorName *string

	// Type of reports that are generated.
	ReportType []ReportType

	// Details of the S3 bucket that report generator reports are published to.
	S3Location *S3Location

	// Tags associated with the report generator.
	Tags []Tag

	noSmithyDocumentSerde
}

// Details about a resource.
type ResourceInventory struct {

	// Platform of the resource.
	Platform *string

	// Platform version of the resource in the inventory.
	PlatformVersion *string

	// Amazon Resource Name (ARN) of the resource.
	ResourceArn *string

	// ID of the resource.
	ResourceId *string

	// ID of the account that owns the resource.
	ResourceOwningAccountId *string

	// Type of resource.
	ResourceType ResourceType

	noSmithyDocumentSerde
}

// Details of the S3 bucket that report generator reports are published to.
type S3Location struct {

	// Name of the S3 bucket reports are published to.
	Bucket *string

	// Prefix of the S3 bucket reports are published to.
	KeyPrefix *string

	noSmithyDocumentSerde
}

// Details about a tag for a license configuration.
type Tag struct {

	// Tag key.
	Key *string

	// Tag value.
	Value *string

	noSmithyDocumentSerde
}

// Describes a token.
type TokenData struct {

	// Token expiration time, in ISO8601-UTC format.
	ExpirationTime *string

	// Amazon Resource Name (ARN) of the license.
	LicenseArn *string

	// Amazon Resource Names (ARN) of the roles included in the token.
	RoleArns []string

	// Token status. The possible values are AVAILABLE and DELETED .
	Status *string

	// Token ID.
	TokenId *string

	// Data specified by the caller.
	TokenProperties []string

	// Type of token generated. The supported value is REFRESH_TOKEN .
	TokenType *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde