licensemanager.d.ts
35.1 KB
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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class LicenseManager extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: LicenseManager.Types.ClientConfiguration)
config: Config & LicenseManager.Types.ClientConfiguration;
/**
* Creates a license configuration. 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), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.
*/
createLicenseConfiguration(params: LicenseManager.Types.CreateLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.CreateLicenseConfigurationResponse, AWSError>;
/**
* Creates a license configuration. 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), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.
*/
createLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.CreateLicenseConfigurationResponse, AWSError>;
/**
* Deletes the specified license configuration. You cannot delete a license configuration that is in use.
*/
deleteLicenseConfiguration(params: LicenseManager.Types.DeleteLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseConfigurationResponse) => void): Request<LicenseManager.Types.DeleteLicenseConfigurationResponse, AWSError>;
/**
* Deletes the specified license configuration. You cannot delete a license configuration that is in use.
*/
deleteLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseConfigurationResponse) => void): Request<LicenseManager.Types.DeleteLicenseConfigurationResponse, AWSError>;
/**
* Gets detailed information about the specified license configuration.
*/
getLicenseConfiguration(params: LicenseManager.Types.GetLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConfigurationResponse) => void): Request<LicenseManager.Types.GetLicenseConfigurationResponse, AWSError>;
/**
* Gets detailed information about the specified license configuration.
*/
getLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConfigurationResponse) => void): Request<LicenseManager.Types.GetLicenseConfigurationResponse, AWSError>;
/**
* Gets the License Manager settings for the current Region.
*/
getServiceSettings(params: LicenseManager.Types.GetServiceSettingsRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetServiceSettingsResponse) => void): Request<LicenseManager.Types.GetServiceSettingsResponse, AWSError>;
/**
* Gets the License Manager settings for the current Region.
*/
getServiceSettings(callback?: (err: AWSError, data: LicenseManager.Types.GetServiceSettingsResponse) => void): Request<LicenseManager.Types.GetServiceSettingsResponse, AWSError>;
/**
* Lists the resource associations for the specified license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).
*/
listAssociationsForLicenseConfiguration(params: LicenseManager.Types.ListAssociationsForLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse, AWSError>;
/**
* Lists the resource associations for the specified license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).
*/
listAssociationsForLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse, AWSError>;
/**
* Lists the license configuration operations that failed.
*/
listFailuresForLicenseConfigurationOperations(params: LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse) => void): Request<LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse, AWSError>;
/**
* Lists the license configuration operations that failed.
*/
listFailuresForLicenseConfigurationOperations(callback?: (err: AWSError, data: LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse) => void): Request<LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse, AWSError>;
/**
* Lists the license configurations for your account.
*/
listLicenseConfigurations(params: LicenseManager.Types.ListLicenseConfigurationsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConfigurationsResponse) => void): Request<LicenseManager.Types.ListLicenseConfigurationsResponse, AWSError>;
/**
* Lists the license configurations for your account.
*/
listLicenseConfigurations(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConfigurationsResponse) => void): Request<LicenseManager.Types.ListLicenseConfigurationsResponse, AWSError>;
/**
* Describes the license configurations for the specified resource.
*/
listLicenseSpecificationsForResource(params: LicenseManager.Types.ListLicenseSpecificationsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.ListLicenseSpecificationsForResourceResponse, AWSError>;
/**
* Describes the license configurations for the specified resource.
*/
listLicenseSpecificationsForResource(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.ListLicenseSpecificationsForResourceResponse, AWSError>;
/**
* Lists resources managed using Systems Manager inventory.
*/
listResourceInventory(params: LicenseManager.Types.ListResourceInventoryRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListResourceInventoryResponse) => void): Request<LicenseManager.Types.ListResourceInventoryResponse, AWSError>;
/**
* Lists resources managed using Systems Manager inventory.
*/
listResourceInventory(callback?: (err: AWSError, data: LicenseManager.Types.ListResourceInventoryResponse) => void): Request<LicenseManager.Types.ListResourceInventoryResponse, AWSError>;
/**
* Lists the tags for the specified license configuration.
*/
listTagsForResource(params: LicenseManager.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListTagsForResourceResponse) => void): Request<LicenseManager.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags for the specified license configuration.
*/
listTagsForResource(callback?: (err: AWSError, data: LicenseManager.Types.ListTagsForResourceResponse) => void): Request<LicenseManager.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
*/
listUsageForLicenseConfiguration(params: LicenseManager.Types.ListUsageForLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListUsageForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListUsageForLicenseConfigurationResponse, AWSError>;
/**
* Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
*/
listUsageForLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.ListUsageForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListUsageForLicenseConfigurationResponse, AWSError>;
/**
* Adds the specified tags to the specified license configuration.
*/
tagResource(params: LicenseManager.Types.TagResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.TagResourceResponse) => void): Request<LicenseManager.Types.TagResourceResponse, AWSError>;
/**
* Adds the specified tags to the specified license configuration.
*/
tagResource(callback?: (err: AWSError, data: LicenseManager.Types.TagResourceResponse) => void): Request<LicenseManager.Types.TagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified license configuration.
*/
untagResource(params: LicenseManager.Types.UntagResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.UntagResourceResponse) => void): Request<LicenseManager.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified license configuration.
*/
untagResource(callback?: (err: AWSError, data: LicenseManager.Types.UntagResourceResponse) => void): Request<LicenseManager.Types.UntagResourceResponse, AWSError>;
/**
* Modifies the attributes of an existing license configuration.
*/
updateLicenseConfiguration(params: LicenseManager.Types.UpdateLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.UpdateLicenseConfigurationResponse, AWSError>;
/**
* Modifies the attributes of an existing license configuration.
*/
updateLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.UpdateLicenseConfigurationResponse, AWSError>;
/**
* Adds or removes the specified license configurations for the specified AWS resource. You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.
*/
updateLicenseSpecificationsForResource(params: LicenseManager.Types.UpdateLicenseSpecificationsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse, AWSError>;
/**
* Adds or removes the specified license configurations for the specified AWS resource. You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.
*/
updateLicenseSpecificationsForResource(callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse, AWSError>;
/**
* Updates License Manager settings for the current Region.
*/
updateServiceSettings(params: LicenseManager.Types.UpdateServiceSettingsRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateServiceSettingsResponse) => void): Request<LicenseManager.Types.UpdateServiceSettingsResponse, AWSError>;
/**
* Updates License Manager settings for the current Region.
*/
updateServiceSettings(callback?: (err: AWSError, data: LicenseManager.Types.UpdateServiceSettingsResponse) => void): Request<LicenseManager.Types.UpdateServiceSettingsResponse, AWSError>;
}
declare namespace LicenseManager {
export interface AutomatedDiscoveryInformation {
/**
* Time that automated discovery last ran.
*/
LastRunTime?: DateTime;
}
export type Boolean = boolean;
export type BoxBoolean = boolean;
export type BoxInteger = number;
export type BoxLong = number;
export interface ConsumedLicenseSummary {
/**
* Resource type of the resource consuming a license.
*/
ResourceType?: ResourceType;
/**
* Number of licenses consumed by the resource.
*/
ConsumedLicenses?: BoxLong;
}
export type ConsumedLicenseSummaryList = ConsumedLicenseSummary[];
export interface CreateLicenseConfigurationRequest {
/**
* Name of the license configuration.
*/
Name: String;
/**
* Description of the license configuration.
*/
Description?: String;
/**
* Dimension used to track the license inventory.
*/
LicenseCountingType: LicenseCountingType;
/**
* Number of licenses managed by the license configuration.
*/
LicenseCount?: BoxLong;
/**
* Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
*/
LicenseCountHardLimit?: BoxBoolean;
/**
* License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows. Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.
*/
LicenseRules?: StringList;
/**
* Tags to add to the license configuration.
*/
Tags?: TagList;
/**
* Product information.
*/
ProductInformationList?: ProductInformationList;
}
export interface CreateLicenseConfigurationResponse {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
LicenseConfigurationArn?: String;
}
export type DateTime = Date;
export interface DeleteLicenseConfigurationRequest {
/**
* ID of the license configuration.
*/
LicenseConfigurationArn: String;
}
export interface DeleteLicenseConfigurationResponse {
}
export interface Filter {
/**
* Name of the filter. Filter names are case-sensitive.
*/
Name?: FilterName;
/**
* Filter values. Filter values are case-sensitive.
*/
Values?: FilterValues;
}
export type FilterName = string;
export type FilterValue = string;
export type FilterValues = FilterValue[];
export type Filters = Filter[];
export interface GetLicenseConfigurationRequest {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
LicenseConfigurationArn: String;
}
export interface GetLicenseConfigurationResponse {
/**
* Unique ID for the license configuration.
*/
LicenseConfigurationId?: String;
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
LicenseConfigurationArn?: String;
/**
* Name of the license configuration.
*/
Name?: String;
/**
* Description of the license configuration.
*/
Description?: String;
/**
* Dimension on which the licenses are counted.
*/
LicenseCountingType?: LicenseCountingType;
/**
* License rules.
*/
LicenseRules?: StringList;
/**
* Number of available licenses.
*/
LicenseCount?: BoxLong;
/**
* Sets the number of available licenses as a hard limit.
*/
LicenseCountHardLimit?: BoxBoolean;
/**
* Number of licenses assigned to resources.
*/
ConsumedLicenses?: BoxLong;
/**
* License configuration status.
*/
Status?: String;
/**
* Account ID of the owner of the license configuration.
*/
OwnerAccountId?: String;
/**
* Summaries of the licenses consumed by resources.
*/
ConsumedLicenseSummaryList?: ConsumedLicenseSummaryList;
/**
* Summaries of the managed resources.
*/
ManagedResourceSummaryList?: ManagedResourceSummaryList;
/**
* Tags for the license configuration.
*/
Tags?: TagList;
/**
* Product information.
*/
ProductInformationList?: ProductInformationList;
/**
* Automated discovery information.
*/
AutomatedDiscoveryInformation?: AutomatedDiscoveryInformation;
}
export interface GetServiceSettingsRequest {
}
export interface GetServiceSettingsResponse {
/**
* Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
*/
S3BucketArn?: String;
/**
* SNS topic configured to receive notifications from License Manager.
*/
SnsTopicArn?: String;
/**
* Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery.
*/
OrganizationConfiguration?: OrganizationConfiguration;
/**
* Indicates whether cross-account discovery has been enabled.
*/
EnableCrossAccountsDiscovery?: BoxBoolean;
/**
* Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account will provide member accounts with access to this share.
*/
LicenseManagerResourceShareArn?: String;
}
export interface InventoryFilter {
/**
* Name of the filter.
*/
Name: String;
/**
* Condition of the filter.
*/
Condition: InventoryFilterCondition;
/**
* Value of the filter.
*/
Value?: String;
}
export type InventoryFilterCondition = "EQUALS"|"NOT_EQUALS"|"BEGINS_WITH"|"CONTAINS"|string;
export type InventoryFilterList = InventoryFilter[];
export interface LicenseConfiguration {
/**
* Unique ID of the license configuration.
*/
LicenseConfigurationId?: String;
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
LicenseConfigurationArn?: String;
/**
* Name of the license configuration.
*/
Name?: String;
/**
* Description of the license configuration.
*/
Description?: String;
/**
* Dimension to use to track the license inventory.
*/
LicenseCountingType?: LicenseCountingType;
/**
* License rules.
*/
LicenseRules?: StringList;
/**
* Number of licenses managed by the license configuration.
*/
LicenseCount?: BoxLong;
/**
* Number of available licenses as a hard limit.
*/
LicenseCountHardLimit?: BoxBoolean;
/**
* Number of licenses consumed.
*/
ConsumedLicenses?: BoxLong;
/**
* Status of the license configuration.
*/
Status?: String;
/**
* Account ID of the license configuration's owner.
*/
OwnerAccountId?: String;
/**
* Summaries for licenses consumed by various resources.
*/
ConsumedLicenseSummaryList?: ConsumedLicenseSummaryList;
/**
* Summaries for managed resources.
*/
ManagedResourceSummaryList?: ManagedResourceSummaryList;
/**
* Product information.
*/
ProductInformationList?: ProductInformationList;
/**
* Automated discovery information.
*/
AutomatedDiscoveryInformation?: AutomatedDiscoveryInformation;
}
export interface LicenseConfigurationAssociation {
/**
* Amazon Resource Name (ARN) of the resource.
*/
ResourceArn?: String;
/**
* Type of server resource.
*/
ResourceType?: ResourceType;
/**
* ID of the AWS account that owns the resource consuming licenses.
*/
ResourceOwnerId?: String;
/**
* Time when the license configuration was associated with the resource.
*/
AssociationTime?: DateTime;
}
export type LicenseConfigurationAssociations = LicenseConfigurationAssociation[];
export type LicenseConfigurationStatus = "AVAILABLE"|"DISABLED"|string;
export interface LicenseConfigurationUsage {
/**
* Amazon Resource Name (ARN) of the resource.
*/
ResourceArn?: String;
/**
* Type of resource.
*/
ResourceType?: ResourceType;
/**
* Status of the resource.
*/
ResourceStatus?: String;
/**
* ID of the account that owns the resource.
*/
ResourceOwnerId?: String;
/**
* Time when the license configuration was initially associated with the resource.
*/
AssociationTime?: DateTime;
/**
* Number of licenses consumed by the resource.
*/
ConsumedLicenses?: BoxLong;
}
export type LicenseConfigurationUsageList = LicenseConfigurationUsage[];
export type LicenseConfigurations = LicenseConfiguration[];
export type LicenseCountingType = "vCPU"|"Instance"|"Core"|"Socket"|string;
export interface LicenseOperationFailure {
/**
* Amazon Resource Name (ARN) of the resource.
*/
ResourceArn?: String;
/**
* Resource type.
*/
ResourceType?: ResourceType;
/**
* Error message.
*/
ErrorMessage?: String;
/**
* Failure time.
*/
FailureTime?: DateTime;
/**
* Name of the operation.
*/
OperationName?: String;
/**
* ID of the AWS account that owns the resource.
*/
ResourceOwnerId?: String;
/**
* The requester is "License Manager Automated Discovery".
*/
OperationRequestedBy?: String;
/**
* Reserved.
*/
MetadataList?: MetadataList;
}
export type LicenseOperationFailureList = LicenseOperationFailure[];
export interface LicenseSpecification {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
LicenseConfigurationArn: String;
}
export type LicenseSpecifications = LicenseSpecification[];
export interface ListAssociationsForLicenseConfigurationRequest {
/**
* Amazon Resource Name (ARN) of a license configuration.
*/
LicenseConfigurationArn: String;
/**
* Maximum number of results to return in a single call.
*/
MaxResults?: BoxInteger;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListAssociationsForLicenseConfigurationResponse {
/**
* Information about the associations for the license configuration.
*/
LicenseConfigurationAssociations?: LicenseConfigurationAssociations;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListFailuresForLicenseConfigurationOperationsRequest {
/**
* Amazon Resource Name of the license configuration.
*/
LicenseConfigurationArn: String;
/**
* Maximum number of results to return in a single call.
*/
MaxResults?: BoxInteger;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListFailuresForLicenseConfigurationOperationsResponse {
/**
* License configuration operations that failed.
*/
LicenseOperationFailureList?: LicenseOperationFailureList;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListLicenseConfigurationsRequest {
/**
* Amazon Resource Names (ARN) of the license configurations.
*/
LicenseConfigurationArns?: StringList;
/**
* Maximum number of results to return in a single call.
*/
MaxResults?: BoxInteger;
/**
* Token for the next set of results.
*/
NextToken?: String;
/**
* Filters to scope the results. The following filters and logical operators are supported: licenseCountingType - The dimension on which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS. enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS. usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.
*/
Filters?: Filters;
}
export interface ListLicenseConfigurationsResponse {
/**
* Information about the license configurations.
*/
LicenseConfigurations?: LicenseConfigurations;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListLicenseSpecificationsForResourceRequest {
/**
* Amazon Resource Name (ARN) of a resource that has an associated license configuration.
*/
ResourceArn: String;
/**
* Maximum number of results to return in a single call.
*/
MaxResults?: BoxInteger;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListLicenseSpecificationsForResourceResponse {
/**
* License configurations associated with a resource.
*/
LicenseSpecifications?: LicenseSpecifications;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListResourceInventoryRequest {
/**
* Maximum number of results to return in a single call.
*/
MaxResults?: BoxInteger;
/**
* Token for the next set of results.
*/
NextToken?: String;
/**
* Filters to scope the results. The following filters and logical operators are supported: account_id - The ID of the AWS account that owns the resource. Logical operators are EQUALS | NOT_EQUALS. application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH. license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter. platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH. resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.
*/
Filters?: InventoryFilterList;
}
export interface ListResourceInventoryResponse {
/**
* Information about the resources.
*/
ResourceInventoryList?: ResourceInventoryList;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ListTagsForResourceRequest {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
ResourceArn: String;
}
export interface ListTagsForResourceResponse {
/**
* Information about the tags.
*/
Tags?: TagList;
}
export interface ListUsageForLicenseConfigurationRequest {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
LicenseConfigurationArn: String;
/**
* Maximum number of results to return in a single call.
*/
MaxResults?: BoxInteger;
/**
* Token for the next set of results.
*/
NextToken?: String;
/**
* Filters to scope the results. The following filters and logical operators are supported: resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS. resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS. resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.
*/
Filters?: Filters;
}
export interface ListUsageForLicenseConfigurationResponse {
/**
* Information about the license configurations.
*/
LicenseConfigurationUsageList?: LicenseConfigurationUsageList;
/**
* Token for the next set of results.
*/
NextToken?: String;
}
export interface ManagedResourceSummary {
/**
* Type of resource associated with a license.
*/
ResourceType?: ResourceType;
/**
* Number of resources associated with licenses.
*/
AssociationCount?: BoxLong;
}
export type ManagedResourceSummaryList = ManagedResourceSummary[];
export interface Metadata {
/**
* Reserved.
*/
Name?: String;
/**
* Reserved.
*/
Value?: String;
}
export type MetadataList = Metadata[];
export interface OrganizationConfiguration {
/**
* Enables AWS Organization integration.
*/
EnableIntegration: Boolean;
}
export interface ProductInformation {
/**
* Resource type. The possible values are SSM_MANAGED | RDS.
*/
ResourceType: String;
/**
* Product information filters. The following filters and logical operators 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. 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.
*/
ProductInformationFilterList: ProductInformationFilterList;
}
export interface ProductInformationFilter {
/**
* Filter name.
*/
ProductInformationFilterName: String;
/**
* Filter value.
*/
ProductInformationFilterValue: StringList;
/**
* Logical operator.
*/
ProductInformationFilterComparator: String;
}
export type ProductInformationFilterList = ProductInformationFilter[];
export type ProductInformationList = ProductInformation[];
export interface ResourceInventory {
/**
* ID of the resource.
*/
ResourceId?: String;
/**
* Type of resource.
*/
ResourceType?: ResourceType;
/**
* Amazon Resource Name (ARN) of the resource.
*/
ResourceArn?: String;
/**
* Platform of the resource.
*/
Platform?: String;
/**
* Platform version of the resource in the inventory.
*/
PlatformVersion?: String;
/**
* ID of the account that owns the resource.
*/
ResourceOwningAccountId?: String;
}
export type ResourceInventoryList = ResourceInventory[];
export type ResourceType = "EC2_INSTANCE"|"EC2_HOST"|"EC2_AMI"|"RDS"|"SYSTEMS_MANAGER_MANAGED_INSTANCE"|string;
export type String = string;
export type StringList = String[];
export interface Tag {
/**
* Tag key.
*/
Key?: String;
/**
* Tag value.
*/
Value?: String;
}
export type TagKeyList = String[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
ResourceArn: String;
/**
* One or more tags.
*/
Tags: TagList;
}
export interface TagResourceResponse {
}
export interface UntagResourceRequest {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
ResourceArn: String;
/**
* Keys identifying the tags to remove.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateLicenseConfigurationRequest {
/**
* Amazon Resource Name (ARN) of the license configuration.
*/
LicenseConfigurationArn: String;
/**
* New status of the license configuration.
*/
LicenseConfigurationStatus?: LicenseConfigurationStatus;
/**
* New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.
*/
LicenseRules?: StringList;
/**
* New number of licenses managed by the license configuration.
*/
LicenseCount?: BoxLong;
/**
* New hard limit of the number of available licenses.
*/
LicenseCountHardLimit?: BoxBoolean;
/**
* New name of the license configuration.
*/
Name?: String;
/**
* New description of the license configuration.
*/
Description?: String;
/**
* New product information.
*/
ProductInformationList?: ProductInformationList;
}
export interface UpdateLicenseConfigurationResponse {
}
export interface UpdateLicenseSpecificationsForResourceRequest {
/**
* Amazon Resource Name (ARN) of the AWS resource.
*/
ResourceArn: String;
/**
* ARNs of the license configurations to add.
*/
AddLicenseSpecifications?: LicenseSpecifications;
/**
* ARNs of the license configurations to remove.
*/
RemoveLicenseSpecifications?: LicenseSpecifications;
}
export interface UpdateLicenseSpecificationsForResourceResponse {
}
export interface UpdateServiceSettingsRequest {
/**
* Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.
*/
S3BucketArn?: String;
/**
* Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.
*/
SnsTopicArn?: String;
/**
* Enables integration with AWS Organizations for cross-account discovery.
*/
OrganizationConfiguration?: OrganizationConfiguration;
/**
* Activates cross-account discovery.
*/
EnableCrossAccountsDiscovery?: BoxBoolean;
}
export interface UpdateServiceSettingsResponse {
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-08-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the LicenseManager client.
*/
export import Types = LicenseManager;
}
export = LicenseManager;