/
models_6.ts
9769 lines (8451 loc) · 301 KB
/
models_6.ts
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
// smithy-typescript generated code
import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
import {
_InstanceType,
AddedPrincipal,
AddIpamOperatingRegion,
AddPrefixListEntry,
AddressAttribute,
AddressAttributeName,
Affinity,
ApplianceModeSupportValue,
AutoPlacement,
ByoipCidr,
ClientConnectOptions,
ClientLoginBannerOptions,
ClientVpnAuthorizationRuleStatus,
ConnectionLogOptions,
CurrencyCodeValues,
DnsSupportValue,
EnaSrdSpecification,
EndDateType,
HostMaintenance,
HostRecovery,
IamInstanceProfileAssociation,
IamInstanceProfileSpecification,
InstanceEventWindow,
IpPermission,
Ipv6SupportValue,
PortRange,
RouteTableAssociationState,
TagSpecification,
TransitGatewayAttachmentResourceType,
TransitGatewayMulticastDomainAssociations,
TransitGatewayPeeringAttachment,
TransitGatewayVpcAttachment,
UnsuccessfulItem,
VerifiedAccessInstance,
VerifiedAccessTrustProvider,
} from "./models_0";
import {
AttributeValue,
BlockDeviceMapping,
CapacityReservationPreference,
CapacityReservationTarget,
CreditSpecificationRequest,
ElasticGpuSpecification,
FleetExcessCapacityTerminationPolicy,
FleetLaunchTemplateConfigRequest,
HostnameType,
IcmpTypeCode,
InstanceEventWindowTimeRangeRequest,
InstanceInterruptionBehavior,
InstanceIpv6Address,
Ipam,
IpamPool,
IpamResourceDiscovery,
IpamScope,
LaunchTemplate,
LocalGatewayRoute,
ManagedPrefixList,
MarketType,
Placement,
RequestIpamResourceTag,
RuleAction,
SelfServicePortal,
ShutdownBehavior,
SpotInstanceType,
TargetCapacitySpecificationRequest,
VolumeType,
} from "./models_1";
import {
AutoAcceptSharedAttachmentsValue,
DefaultRouteTableAssociationValue,
DefaultRouteTablePropagationValue,
DnsOptionsSpecification,
IKEVersionsRequestListValue,
IpAddressType,
PayerResponsibility,
Phase1DHGroupNumbersRequestListValue,
Phase1EncryptionAlgorithmsRequestListValue,
Phase1IntegrityAlgorithmsRequestListValue,
Phase2DHGroupNumbersRequestListValue,
Phase2EncryptionAlgorithmsRequestListValue,
Phase2IntegrityAlgorithmsRequestListValue,
SnapshotState,
TrafficDirection,
TrafficMirrorFilter,
TrafficMirrorFilterRule,
TrafficMirrorNetworkService,
TrafficMirrorPortRangeRequest,
TrafficMirrorRuleAction,
TrafficMirrorSession,
TransitGateway,
TransitGatewayPrefixListReference,
TransitGatewayRoute,
VerifiedAccessEndpoint,
VerifiedAccessEndpointProtocol,
VerifiedAccessGroup,
VpnConnection,
VpnEcmpSupportValue,
VpnTunnelLogOptionsSpecification,
} from "./models_2";
import {
ArchitectureValues,
AttributeBooleanValue,
BootModeValues,
ClientVpnConnectionStatus,
Filter,
FpgaImageAttribute,
FpgaImageAttributeName,
HttpTokensState,
ImdsSupportValues,
InstanceAttributeName,
InstanceAutoRecoveryState,
InstanceMetadataEndpointState,
InstanceMetadataOptionsResponse,
InstanceMetadataProtocolState,
InstanceMetadataTagsState,
InstanceTagNotificationAttribute,
IpamPoolCidr,
LaunchPermission,
Monitoring,
PermissionGroup,
TpmSupportValues,
} from "./models_3";
import {
CreateVolumePermission,
ExcessCapacityTerminationPolicy,
InstanceNetworkInterfaceSpecification,
InstanceState,
InstanceStatusEvent,
LaunchTemplateConfig,
NetworkInsightsAccessScopeAnalysis,
NetworkInsightsAnalysis,
PublicIpv4PoolRange,
ReservedInstancesConfiguration,
RunInstancesMonitoringEnabled,
ScheduledInstance,
SnapshotAttributeName,
SpotFleetRequestConfigData,
SpotFleetRequestConfigDataFilterSensitiveLog,
SpotInstanceRequest,
SpotInstanceRequestFilterSensitiveLog,
SpotPlacement,
VerifiedAccessInstanceLoggingConfiguration,
VolumeModification,
} from "./models_4";
import {
InstanceFamilyCreditSpecification,
IpamResourceCidr,
Purchase,
UnlimitedSupportedInstanceFamily,
} from "./models_5";
export interface ModifyAddressAttributeResult {
/**
* <p>Information about the Elastic IP address.</p>
*/
Address?: AddressAttribute;
}
export enum ModifyAvailabilityZoneOptInStatus {
not_opted_in = "not-opted-in",
opted_in = "opted-in",
}
export interface ModifyAvailabilityZoneGroupRequest {
/**
* <p>The name of the Availability Zone group, Local Zone group, or Wavelength Zone
* group.</p>
*/
GroupName: string | undefined;
/**
* <p>Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The
* only valid value is <code>opted-in</code>. You must contact <a href="https://console.aws.amazon.com/support/home#/case/create%3FissueType=customer-service%26serviceCode=general-info%26getting-started%26categoryCode=using-aws%26services">Amazon Web Services Support</a> to opt out of a Local Zone or Wavelength Zone group.</p>
*/
OptInStatus: ModifyAvailabilityZoneOptInStatus | string | undefined;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
}
export interface ModifyAvailabilityZoneGroupResult {
/**
* <p>Is <code>true</code> if the request succeeds, and an error otherwise.</p>
*/
Return?: boolean;
}
export interface ModifyCapacityReservationRequest {
/**
* <p>The ID of the Capacity Reservation.</p>
*/
CapacityReservationId: string | undefined;
/**
* <p>The number of instances for which to reserve capacity. The number of instances can't be increased or
* decreased by more than <code>1000</code> in a single request.</p>
*/
InstanceCount?: number;
/**
* <p>The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity
* is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
* <code>expired</code> when it reaches its end date and time.</p>
* <p>The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify
* 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.</p>
* <p>You must provide an <code>EndDate</code> value if <code>EndDateType</code> is
* <code>limited</code>. Omit <code>EndDate</code> if <code>EndDateType</code> is
* <code>unlimited</code>.</p>
*/
EndDate?: Date;
/**
* <p>Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end
* types:</p>
* <ul>
* <li>
* <p>
* <code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it. Do not
* provide an <code>EndDate</code> value if <code>EndDateType</code> is
* <code>unlimited</code>.</p>
* </li>
* <li>
* <p>
* <code>limited</code> - The Capacity Reservation expires automatically at a specified date and time. You must
* provide an <code>EndDate</code> value if <code>EndDateType</code> is
* <code>limited</code>.</p>
* </li>
* </ul>
*/
EndDateType?: EndDateType | string;
/**
* <p>Reserved. Capacity Reservations you have created are accepted by default.</p>
*/
Accept?: boolean;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>Reserved for future use.</p>
*/
AdditionalInfo?: string;
}
export interface ModifyCapacityReservationResult {
/**
* <p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>
*/
Return?: boolean;
}
export interface ModifyCapacityReservationFleetRequest {
/**
* <p>The ID of the Capacity Reservation Fleet to modify.</p>
*/
CapacityReservationFleetId: string | undefined;
/**
* <p>The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value,
* together with the instance type weights that you assign to each instance type used by the Fleet
* determine the number of instances for which the Fleet reserves capacity. Both values are based on
* units that make sense for your workload. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity">Total target capacity</a>
* in the Amazon EC2 User Guide.</p>
*/
TotalTargetCapacity?: number;
/**
* <p>The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation
* Fleet expires, its state changes to <code>expired</code> and all of the Capacity Reservations in the
* Fleet expire.</p>
* <p>The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you
* specify <code>5/31/2019</code>, <code>13:30:55</code>, the Capacity Reservation Fleet is guaranteed
* to expire between <code>13:30:55</code> and <code>14:30:55</code> on <code>5/31/2019</code>.</p>
* <p>You can't specify <b>EndDate</b> and <b>
* RemoveEndDate</b> in the same request.</p>
*/
EndDate?: Date;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the
* end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly
* cancel it using the <b>CancelCapacityReservationFleet</b> action.</p>
* <p>You can't specify <b>RemoveEndDate</b> and <b>
* EndDate</b> in the same request.</p>
*/
RemoveEndDate?: boolean;
}
export interface ModifyCapacityReservationFleetResult {
/**
* <p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>
*/
Return?: boolean;
}
/**
* <p>Information about the DNS server to be used.</p>
*/
export interface DnsServersOptionsModifyStructure {
/**
* <p>The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to
* two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values
* overwrite the existing values.</p>
*/
CustomDnsServers?: string[];
/**
* <p>Indicates whether DNS servers should be used. Specify <code>False</code> to delete the existing DNS
* servers.</p>
*/
Enabled?: boolean;
}
export interface ModifyClientVpnEndpointRequest {
/**
* <p>The ID of the Client VPN endpoint to modify.</p>
*/
ClientVpnEndpointId: string | undefined;
/**
* <p>The ARN of the server certificate to be used. The server certificate must be provisioned in
* Certificate Manager (ACM).</p>
*/
ServerCertificateArn?: string;
/**
* <p>Information about the client connection logging options.</p>
* <p>If you enable client connection logging, data about client connections is sent to a
* Cloudwatch Logs log stream. The following information is logged:</p>
* <ul>
* <li>
* <p>Client connection requests</p>
* </li>
* <li>
* <p>Client connection results (successful and unsuccessful)</p>
* </li>
* <li>
* <p>Reasons for unsuccessful client connection requests</p>
* </li>
* <li>
* <p>Client connection termination time</p>
* </li>
* </ul>
*/
ConnectionLogOptions?: ConnectionLogOptions;
/**
* <p>Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have
* up to two DNS servers.</p>
*/
DnsServers?: DnsServersOptionsModifyStructure;
/**
* <p>The port number to assign to the Client VPN endpoint for TCP and UDP traffic.</p>
* <p>Valid Values: <code>443</code> | <code>1194</code>
* </p>
* <p>Default Value: <code>443</code>
* </p>
*/
VpnPort?: number;
/**
* <p>A brief description of the Client VPN endpoint.</p>
*/
Description?: string;
/**
* <p>Indicates whether the VPN is split-tunnel.</p>
* <p>For information about split-tunnel VPN endpoints, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html">Split-tunnel Client VPN endpoint</a> in the
* <i>Client VPN Administrator Guide</i>.</p>
*/
SplitTunnel?: boolean;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>The IDs of one or more security groups to apply to the target network.</p>
*/
SecurityGroupIds?: string[];
/**
* <p>The ID of the VPC to associate with the Client VPN endpoint.</p>
*/
VpcId?: string;
/**
* <p>Specify whether to enable the self-service portal for the Client VPN endpoint.</p>
*/
SelfServicePortal?: SelfServicePortal | string;
/**
* <p>The options for managing connection authorization for new client connections.</p>
*/
ClientConnectOptions?: ClientConnectOptions;
/**
* <p>The maximum VPN session duration time in hours.</p>
* <p>Valid values: <code>8 | 10 | 12 | 24</code>
* </p>
* <p>Default value: <code>24</code>
* </p>
*/
SessionTimeoutHours?: number;
/**
* <p>Options for enabling a customizable text banner that will be displayed on
* Amazon Web Services provided clients when a VPN session is established.</p>
*/
ClientLoginBannerOptions?: ClientLoginBannerOptions;
}
export interface ModifyClientVpnEndpointResult {
/**
* <p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>
*/
Return?: boolean;
}
export interface ModifyDefaultCreditSpecificationRequest {
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>The instance family.</p>
*/
InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined;
/**
* <p>The credit option for CPU usage of the instance family.</p>
* <p>Valid Values: <code>standard</code> | <code>unlimited</code>
* </p>
*/
CpuCredits: string | undefined;
}
export interface ModifyDefaultCreditSpecificationResult {
/**
* <p>The default credit option for CPU usage of the instance family.</p>
*/
InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification;
}
export interface ModifyEbsDefaultKmsKeyIdRequest {
/**
* <p>The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
* If this parameter is not specified, your KMS key for Amazon EBS is used. If <code>KmsKeyId</code> is
* specified, the encrypted state must be <code>true</code>.</p>
* <p>You can specify the KMS key using any of the following:</p>
* <ul>
* <li>
* <p>Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.</p>
* </li>
* <li>
* <p>Key alias. For example, alias/ExampleAlias.</p>
* </li>
* <li>
* <p>Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.</p>
* </li>
* <li>
* <p>Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.</p>
* </li>
* </ul>
* <p>Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid,
* the action can appear to complete, but eventually fails.</p>
* <p>Amazon EBS does not support asymmetric KMS keys.</p>
*/
KmsKeyId: string | undefined;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
}
export interface ModifyEbsDefaultKmsKeyIdResult {
/**
* <p>The Amazon Resource Name (ARN) of the default KMS key for encryption by default.</p>
*/
KmsKeyId?: string;
}
export interface ModifyFleetRequest {
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>Indicates whether running instances should be terminated if the total target capacity of
* the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p>
* <p>Supported only for fleets of type <code>maintain</code>.</p>
*/
ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string;
/**
* <p>The launch template and overrides.</p>
*/
LaunchTemplateConfigs?: FleetLaunchTemplateConfigRequest[];
/**
* <p>The ID of the EC2 Fleet.</p>
*/
FleetId: string | undefined;
/**
* <p>The size of the EC2 Fleet.</p>
*/
TargetCapacitySpecification?: TargetCapacitySpecificationRequest;
/**
* <p>Reserved.</p>
*/
Context?: string;
}
export interface ModifyFleetResult {
/**
* <p>If the request succeeds, the response returns <code>true</code>. If the request fails,
* no response is returned, and instead an error message is returned.</p>
*/
Return?: boolean;
}
/**
* <p>Describes a load permission.</p>
*/
export interface LoadPermissionRequest {
/**
* <p>The name of the group.</p>
*/
Group?: PermissionGroup | string;
/**
* <p>The Amazon Web Services account ID.</p>
*/
UserId?: string;
}
/**
* <p>Describes modifications to the load permissions of an Amazon FPGA image (AFI).</p>
*/
export interface LoadPermissionModifications {
/**
* <p>The load permissions to add.</p>
*/
Add?: LoadPermissionRequest[];
/**
* <p>The load permissions to remove.</p>
*/
Remove?: LoadPermissionRequest[];
}
export enum OperationType {
add = "add",
remove = "remove",
}
export interface ModifyFpgaImageAttributeRequest {
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>The ID of the AFI.</p>
*/
FpgaImageId: string | undefined;
/**
* <p>The name of the attribute.</p>
*/
Attribute?: FpgaImageAttributeName | string;
/**
* <p>The operation type.</p>
*/
OperationType?: OperationType | string;
/**
* <p>The Amazon Web Services account IDs. This parameter is valid only when modifying the <code>loadPermission</code> attribute.</p>
*/
UserIds?: string[];
/**
* <p>The user groups. This parameter is valid only when modifying the <code>loadPermission</code> attribute.</p>
*/
UserGroups?: string[];
/**
* <p>The product codes. After you add a product code to an AFI, it can't be removed.
* This parameter is valid only when modifying the <code>productCodes</code> attribute.</p>
*/
ProductCodes?: string[];
/**
* <p>The load permission for the AFI.</p>
*/
LoadPermission?: LoadPermissionModifications;
/**
* <p>A description for the AFI.</p>
*/
Description?: string;
/**
* <p>A name for the AFI.</p>
*/
Name?: string;
}
export interface ModifyFpgaImageAttributeResult {
/**
* <p>Information about the attribute.</p>
*/
FpgaImageAttribute?: FpgaImageAttribute;
}
export interface ModifyHostsRequest {
/**
* <p>Specify whether to enable or disable auto-placement.</p>
*/
AutoPlacement?: AutoPlacement | string;
/**
* <p>The IDs of the Dedicated Hosts to modify.</p>
*/
HostIds: string[] | undefined;
/**
* <p>Indicates whether to enable or disable host recovery for the Dedicated Host. For more
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html"> Host recovery</a>
* in the <i>Amazon EC2 User Guide</i>.</p>
*/
HostRecovery?: HostRecovery | string;
/**
* <p>Specifies the instance type to be supported by the Dedicated Host. Specify this
* parameter to modify a Dedicated Host to support only a specific instance type.</p>
* <p>If you want to modify a Dedicated Host to support multiple instance types in its
* current instance family, omit this parameter and specify <b>InstanceFamily</b> instead. You cannot specify <b>InstanceType</b> and <b>InstanceFamily</b> in the
* same request.</p>
*/
InstanceType?: string;
/**
* <p>Specifies the instance family to be supported by the Dedicated Host. Specify this
* parameter to modify a Dedicated Host to support multiple instance types within its
* current instance family.</p>
* <p>If you want to modify a Dedicated Host to support a specific instance type only, omit
* this parameter and specify <b>InstanceType</b> instead. You
* cannot specify <b>InstanceFamily</b> and <b>InstanceType</b> in the same request.</p>
*/
InstanceFamily?: string;
/**
* <p>Indicates whether to enable or disable host maintenance for the Dedicated Host. For
* more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html"> Host
* maintenance</a> in the <i>Amazon EC2 User Guide</i>.</p>
*/
HostMaintenance?: HostMaintenance | string;
}
export interface ModifyHostsResult {
/**
* <p>The IDs of the Dedicated Hosts that were successfully modified.</p>
*/
Successful?: string[];
/**
* <p>The IDs of the Dedicated Hosts that could not be modified. Check whether the setting
* you requested can be used.</p>
*/
Unsuccessful?: UnsuccessfulItem[];
}
export interface ModifyIdentityIdFormatRequest {
/**
* <p>The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify
* <code>all</code> to modify the ID format for all IAM users, IAM roles, and the root user of
* the account.</p>
*/
PrincipalArn: string | undefined;
/**
* <p>The type of resource: <code>bundle</code> | <code>conversion-task</code> | <code>customer-gateway</code> | <code>dhcp-options</code> |
* <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> |
* <code>export-task</code> | <code>flow-log</code> | <code>image</code> |
* <code>import-task</code> | <code>internet-gateway</code> | <code>network-acl</code>
* | <code>network-acl-association</code> | <code>network-interface</code> |
* <code>network-interface-attachment</code> | <code>prefix-list</code> |
* <code>route-table</code> | <code>route-table-association</code> |
* <code>security-group</code> | <code>subnet</code> |
* <code>subnet-cidr-block-association</code> | <code>vpc</code> |
* <code>vpc-cidr-block-association</code> | <code>vpc-endpoint</code> | <code>vpc-peering-connection</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>.</p>
* <p>Alternatively, use the <code>all-current</code> option to include all resource types that are
* currently within their opt-in period for longer IDs.</p>
*/
Resource: string | undefined;
/**
* <p>Indicates whether the resource should use longer IDs (17-character IDs)</p>
*/
UseLongIds: boolean | undefined;
}
export interface ModifyIdFormatRequest {
/**
* <p>The type of resource: <code>bundle</code> | <code>conversion-task</code> | <code>customer-gateway</code> | <code>dhcp-options</code> |
* <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> |
* <code>export-task</code> | <code>flow-log</code> | <code>image</code> |
* <code>import-task</code> | <code>internet-gateway</code> | <code>network-acl</code>
* | <code>network-acl-association</code> | <code>network-interface</code> |
* <code>network-interface-attachment</code> | <code>prefix-list</code> |
* <code>route-table</code> | <code>route-table-association</code> |
* <code>security-group</code> | <code>subnet</code> |
* <code>subnet-cidr-block-association</code> | <code>vpc</code> |
* <code>vpc-cidr-block-association</code> | <code>vpc-endpoint</code> | <code>vpc-peering-connection</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>.</p>
* <p>Alternatively, use the <code>all-current</code> option to include all resource types that are
* currently within their opt-in period for longer IDs.</p>
*/
Resource: string | undefined;
/**
* <p>Indicate whether the resource should use longer IDs (17-character IDs).</p>
*/
UseLongIds: boolean | undefined;
}
/**
* <p>Describes a launch permission modification.</p>
*/
export interface LaunchPermissionModifications {
/**
* <p>The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.</p>
*/
Add?: LaunchPermission[];
/**
* <p>The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.</p>
*/
Remove?: LaunchPermission[];
}
/**
* <p>Contains the parameters for ModifyImageAttribute.</p>
*/
export interface ModifyImageAttributeRequest {
/**
* <p>The name of the attribute to modify.</p>
* <p>Valid values: <code>description</code> | <code>imdsSupport</code> | <code>launchPermission</code>
* </p>
*/
Attribute?: string;
/**
* <p>A new description for the AMI.</p>
*/
Description?: AttributeValue;
/**
* <p>The ID of the AMI.</p>
*/
ImageId: string | undefined;
/**
* <p>A new launch permission for the AMI.</p>
*/
LaunchPermission?: LaunchPermissionModifications;
/**
* <p>The operation type.
* This parameter can be used only when the <code>Attribute</code> parameter is <code>launchPermission</code>.</p>
*/
OperationType?: OperationType | string;
/**
* <p>Not supported.</p>
*/
ProductCodes?: string[];
/**
* <p>The user groups.
* This parameter can be used only when the <code>Attribute</code> parameter is <code>launchPermission</code>.</p>
*/
UserGroups?: string[];
/**
* <p>The Amazon Web Services account IDs.
* This parameter can be used only when the <code>Attribute</code> parameter is <code>launchPermission</code>.</p>
*/
UserIds?: string[];
/**
* <p>The value of the attribute being modified.
* This parameter can be used only when the <code>Attribute</code> parameter is <code>description</code> or <code>imdsSupport</code>.</p>
*/
Value?: string;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is
* <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the <code>Attribute</code> parameter is <code>launchPermission</code>.</p>
*/
OrganizationArns?: string[];
/**
* <p>The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the <code>Attribute</code> parameter is <code>launchPermission</code>.</p>
*/
OrganizationalUnitArns?: string[];
/**
* <p>Set to <code>v2.0</code> to indicate that IMDSv2 is specified in the AMI. Instances
* launched from this AMI will have <code>HttpTokens</code> automatically set to
* <code>required</code> so that, by default, the instance requires that IMDSv2 is used when
* requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to
* <code>2</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration">Configure
* the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p>
* <important>
* <p>Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to <code>v2.0</code>,
* you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.</p>
* </important>
*/
ImdsSupport?: AttributeValue;
}
/**
* <p>Describes information used to set up an EBS volume specified in a block device
* mapping.</p>
*/
export interface EbsInstanceBlockDeviceSpecification {
/**
* <p>Indicates whether the volume is deleted on instance termination.</p>
*/
DeleteOnTermination?: boolean;
/**
* <p>The ID of the EBS volume.</p>
*/
VolumeId?: string;
}
/**
* <p>Describes a block device mapping entry.</p>
*/
export interface InstanceBlockDeviceMappingSpecification {
/**
* <p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p>
*/
DeviceName?: string;
/**
* <p>Parameters used to automatically set up EBS volumes when the instance is
* launched.</p>
*/
Ebs?: EbsInstanceBlockDeviceSpecification;
/**
* <p>suppress the specified device included in the block device mapping.</p>
*/
NoDevice?: string;
/**
* <p>The virtual device name.</p>
*/
VirtualName?: string;
}
export interface BlobAttributeValue {
Value?: Uint8Array;
}
export interface ModifyInstanceAttributeRequest {
/**
* <p>Enable or disable source/destination checks, which ensure that the instance is either
* the source or the destination of any traffic that it receives. If the value is
* <code>true</code>, source/destination checks are enabled; otherwise, they are
* disabled. The default value is <code>true</code>. You must disable source/destination
* checks if the instance runs services such as network address translation, routing, or
* firewalls.</p>
*/
SourceDestCheck?: AttributeBooleanValue;
/**
* <p>The name of the attribute to modify.</p>
* <important>
* <p>You can modify the following attributes only: <code>disableApiTermination</code> |
* <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> |
* <code>instanceInitiatedShutdownBehavior</code> | <code>blockDeviceMapping</code>
* | <code>userData</code> | <code>sourceDestCheck</code> | <code>groupSet</code> |
* <code>ebsOptimized</code> | <code>sriovNetSupport</code> |
* <code>enaSupport</code> | <code>nvmeSupport</code> | <code>disableApiStop</code>
* | <code>enclaveOptions</code>
* </p>
* </important>
*/
Attribute?: InstanceAttributeName | string;
/**
* <p>Modifies the <code>DeleteOnTermination</code> attribute for volumes that are currently
* attached. The volume must be owned by the caller. If no value is specified for
* <code>DeleteOnTermination</code>, the default is <code>true</code> and the volume is
* deleted when the instance is terminated.</p>
* <p>To add instance store volumes to an Amazon EBS-backed instance, you must add them when
* you launch the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM">Update the block device mapping when launching an instance</a> in the
* <i>Amazon EC2 User Guide</i>.</p>
*/
BlockDeviceMappings?: InstanceBlockDeviceMappingSpecification[];
/**
* <p>If the value is <code>true</code>, you can't terminate the instance using the Amazon
* EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
* Instances.</p>
*/
DisableApiTermination?: AttributeBooleanValue;
/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
DryRun?: boolean;
/**
* <p>Specifies whether the instance is optimized for Amazon EBS I/O. This optimization
* provides dedicated throughput to Amazon EBS and an optimized configuration stack to
* provide optimal EBS I/O performance. This optimization isn't available with all instance
* types. Additional usage charges apply when using an EBS Optimized instance.</p>
*/
EbsOptimized?: AttributeBooleanValue;
/**
* <p>Set to <code>true</code> to enable enhanced networking with ENA for the
* instance.</p>
* <p>This option is supported only for HVM instances. Specifying this option with a PV
* instance can make it unreachable.</p>
*/
EnaSupport?: AttributeBooleanValue;
/**
* <p>[EC2-VPC] Replaces the security groups of the instance with the specified security
* groups. You must specify at least one security group, even if it's just the default
* security group for the VPC. You must specify the security group ID, not the security
* group name.</p>
*/
Groups?: string[];
/**
* <p>The ID of the instance.</p>
*/
InstanceId: string | undefined;
/**
* <p>Specifies whether an instance stops or terminates when you initiate shutdown from the
* instance (using the operating system command for system shutdown).</p>
*/
InstanceInitiatedShutdownBehavior?: AttributeValue;
/**
* <p>Changes the instance type to the specified value. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance
* types</a> in the <i>Amazon EC2 User Guide</i>. If the instance type is
* not valid, the error returned is <code>InvalidInstanceAttributeValue</code>.</p>
*/
InstanceType?: AttributeValue;
/**