@aws-sdk/client-organizations 3.379.1 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +250 -0
- package/package.json +5 -5
|
@@ -5,6 +5,7 @@ import { OrganizationsServiceException as __BaseException } from "./Organization
|
|
|
5
5
|
*/
|
|
6
6
|
export interface AcceptHandshakeRequest {
|
|
7
7
|
/**
|
|
8
|
+
* @public
|
|
8
9
|
* <p>The unique identifier (ID) of the handshake that you want to accept.</p>
|
|
9
10
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-"
|
|
10
11
|
* followed by from 8 to 32 lowercase letters or digits.</p>
|
|
@@ -44,12 +45,14 @@ export type HandshakePartyType = (typeof HandshakePartyType)[keyof typeof Handsh
|
|
|
44
45
|
*/
|
|
45
46
|
export interface HandshakeParty {
|
|
46
47
|
/**
|
|
48
|
+
* @public
|
|
47
49
|
* <p>The unique identifier (ID) for the party.</p>
|
|
48
50
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-"
|
|
49
51
|
* followed by from 8 to 32 lowercase letters or digits.</p>
|
|
50
52
|
*/
|
|
51
53
|
Id: string | undefined;
|
|
52
54
|
/**
|
|
55
|
+
* @public
|
|
53
56
|
* <p>The type of party.</p>
|
|
54
57
|
*/
|
|
55
58
|
Type: HandshakePartyType | string | undefined;
|
|
@@ -510,24 +513,28 @@ export type AccountStatus = (typeof AccountStatus)[keyof typeof AccountStatus];
|
|
|
510
513
|
*/
|
|
511
514
|
export interface Account {
|
|
512
515
|
/**
|
|
516
|
+
* @public
|
|
513
517
|
* <p>The unique identifier (ID) of the account.</p>
|
|
514
518
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12
|
|
515
519
|
* digits.</p>
|
|
516
520
|
*/
|
|
517
521
|
Id?: string;
|
|
518
522
|
/**
|
|
523
|
+
* @public
|
|
519
524
|
* <p>The Amazon Resource Name (ARN) of the account.</p>
|
|
520
525
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
521
526
|
* Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>
|
|
522
527
|
*/
|
|
523
528
|
Arn?: string;
|
|
524
529
|
/**
|
|
530
|
+
* @public
|
|
525
531
|
* <p>The email address associated with the Amazon Web Services account.</p>
|
|
526
532
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for this parameter is a string of characters that represents a
|
|
527
533
|
* standard internet email address.</p>
|
|
528
534
|
*/
|
|
529
535
|
Email?: string;
|
|
530
536
|
/**
|
|
537
|
+
* @public
|
|
531
538
|
* <p>The friendly name of the account.</p>
|
|
532
539
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
533
540
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -535,14 +542,17 @@ export interface Account {
|
|
|
535
542
|
*/
|
|
536
543
|
Name?: string;
|
|
537
544
|
/**
|
|
545
|
+
* @public
|
|
538
546
|
* <p>The status of the account in the organization.</p>
|
|
539
547
|
*/
|
|
540
548
|
Status?: AccountStatus | string;
|
|
541
549
|
/**
|
|
550
|
+
* @public
|
|
542
551
|
* <p>The method by which the account joined the organization.</p>
|
|
543
552
|
*/
|
|
544
553
|
JoinedMethod?: AccountJoinedMethod | string;
|
|
545
554
|
/**
|
|
555
|
+
* @public
|
|
546
556
|
* <p>The date the account became a part of the organization.</p>
|
|
547
557
|
*/
|
|
548
558
|
JoinedTimestamp?: Date;
|
|
@@ -638,6 +648,7 @@ export declare class AlreadyInOrganizationException extends __BaseException {
|
|
|
638
648
|
*/
|
|
639
649
|
export interface AttachPolicyRequest {
|
|
640
650
|
/**
|
|
651
|
+
* @public
|
|
641
652
|
* <p>The unique identifier (ID) of the policy that you want to attach to the target. You
|
|
642
653
|
* can get the ID for the policy by calling the <a>ListPolicies</a>
|
|
643
654
|
* operation.</p>
|
|
@@ -646,6 +657,7 @@ export interface AttachPolicyRequest {
|
|
|
646
657
|
*/
|
|
647
658
|
PolicyId: string | undefined;
|
|
648
659
|
/**
|
|
660
|
+
* @public
|
|
649
661
|
* <p>The unique identifier (ID) of the root, OU, or account that you want to attach the
|
|
650
662
|
* policy to. You can get the ID by calling the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a>
|
|
651
663
|
* operations.</p>
|
|
@@ -1012,6 +1024,7 @@ export declare class UnsupportedAPIEndpointException extends __BaseException {
|
|
|
1012
1024
|
*/
|
|
1013
1025
|
export interface CancelHandshakeRequest {
|
|
1014
1026
|
/**
|
|
1027
|
+
* @public
|
|
1015
1028
|
* <p>The unique identifier (ID) of the handshake that you want to cancel. You can get the
|
|
1016
1029
|
* ID from the <a>ListHandshakesForOrganization</a> operation.</p>
|
|
1017
1030
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-"
|
|
@@ -1024,6 +1037,7 @@ export interface CancelHandshakeRequest {
|
|
|
1024
1037
|
*/
|
|
1025
1038
|
export interface CloseAccountRequest {
|
|
1026
1039
|
/**
|
|
1040
|
+
* @public
|
|
1027
1041
|
* <p>Retrieves the Amazon Web Services account Id for the current <code>CloseAccount</code> API request.
|
|
1028
1042
|
* </p>
|
|
1029
1043
|
*/
|
|
@@ -1076,10 +1090,12 @@ export type IAMUserAccessToBilling = (typeof IAMUserAccessToBilling)[keyof typeo
|
|
|
1076
1090
|
*/
|
|
1077
1091
|
export interface Tag {
|
|
1078
1092
|
/**
|
|
1093
|
+
* @public
|
|
1079
1094
|
* <p>The key identifier, or name, of the tag.</p>
|
|
1080
1095
|
*/
|
|
1081
1096
|
Key: string | undefined;
|
|
1082
1097
|
/**
|
|
1098
|
+
* @public
|
|
1083
1099
|
* <p>The string value that's associated with the key of the tag. You can set the value of a
|
|
1084
1100
|
* tag to an empty string, but you can't set the value of a tag to null.</p>
|
|
1085
1101
|
*/
|
|
@@ -1090,6 +1106,7 @@ export interface Tag {
|
|
|
1090
1106
|
*/
|
|
1091
1107
|
export interface CreateAccountRequest {
|
|
1092
1108
|
/**
|
|
1109
|
+
* @public
|
|
1093
1110
|
* <p>The email address of the owner to assign to the new member account. This email address
|
|
1094
1111
|
* must not already be associated with another Amazon Web Services account. You must use a valid email
|
|
1095
1112
|
* address to complete account creation.</p>
|
|
@@ -1128,10 +1145,12 @@ export interface CreateAccountRequest {
|
|
|
1128
1145
|
*/
|
|
1129
1146
|
Email: string | undefined;
|
|
1130
1147
|
/**
|
|
1148
|
+
* @public
|
|
1131
1149
|
* <p>The friendly name of the member account.</p>
|
|
1132
1150
|
*/
|
|
1133
1151
|
AccountName: string | undefined;
|
|
1134
1152
|
/**
|
|
1153
|
+
* @public
|
|
1135
1154
|
* <p>The name of an IAM role that Organizations automatically preconfigures in the new member
|
|
1136
1155
|
* account. This role trusts the management account, allowing users in the management
|
|
1137
1156
|
* account to assume the role, as permitted by the management account administrator. The
|
|
@@ -1160,6 +1179,7 @@ export interface CreateAccountRequest {
|
|
|
1160
1179
|
*/
|
|
1161
1180
|
RoleName?: string;
|
|
1162
1181
|
/**
|
|
1182
|
+
* @public
|
|
1163
1183
|
* <p>If set to <code>ALLOW</code>, the new account enables IAM users to access account
|
|
1164
1184
|
* billing information <i>if</i> they have the required permissions. If set
|
|
1165
1185
|
* to <code>DENY</code>, only the root user of the new account can access account billing
|
|
@@ -1172,6 +1192,7 @@ export interface CreateAccountRequest {
|
|
|
1172
1192
|
*/
|
|
1173
1193
|
IamUserAccessToBilling?: IAMUserAccessToBilling | string;
|
|
1174
1194
|
/**
|
|
1195
|
+
* @public
|
|
1175
1196
|
* <p>A list of tags that you want to attach to the newly created account. For each tag in
|
|
1176
1197
|
* the list, you must specify both a tag key and a value. You can set the value to an empty
|
|
1177
1198
|
* string, but you can't set it to <code>null</code>. For more information about tagging,
|
|
@@ -1230,6 +1251,7 @@ export type CreateAccountState = (typeof CreateAccountState)[keyof typeof Create
|
|
|
1230
1251
|
*/
|
|
1231
1252
|
export interface CreateAccountStatus {
|
|
1232
1253
|
/**
|
|
1254
|
+
* @public
|
|
1233
1255
|
* <p>The unique identifier (ID) that references this request. You get this value from the
|
|
1234
1256
|
* response of the initial <a>CreateAccount</a> request to create the
|
|
1235
1257
|
* account.</p>
|
|
@@ -1238,22 +1260,27 @@ export interface CreateAccountStatus {
|
|
|
1238
1260
|
*/
|
|
1239
1261
|
Id?: string;
|
|
1240
1262
|
/**
|
|
1263
|
+
* @public
|
|
1241
1264
|
* <p>The account name given to the account when it was created.</p>
|
|
1242
1265
|
*/
|
|
1243
1266
|
AccountName?: string;
|
|
1244
1267
|
/**
|
|
1268
|
+
* @public
|
|
1245
1269
|
* <p>The status of the asynchronous request to create an Amazon Web Services account.</p>
|
|
1246
1270
|
*/
|
|
1247
1271
|
State?: CreateAccountState | string;
|
|
1248
1272
|
/**
|
|
1273
|
+
* @public
|
|
1249
1274
|
* <p>The date and time that the request was made for the account creation.</p>
|
|
1250
1275
|
*/
|
|
1251
1276
|
RequestedTimestamp?: Date;
|
|
1252
1277
|
/**
|
|
1278
|
+
* @public
|
|
1253
1279
|
* <p>The date and time that the account was created and the request completed.</p>
|
|
1254
1280
|
*/
|
|
1255
1281
|
CompletedTimestamp?: Date;
|
|
1256
1282
|
/**
|
|
1283
|
+
* @public
|
|
1257
1284
|
* <p>If the account was created successfully, the unique identifier (ID) of the new
|
|
1258
1285
|
* account.</p>
|
|
1259
1286
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12
|
|
@@ -1261,11 +1288,13 @@ export interface CreateAccountStatus {
|
|
|
1261
1288
|
*/
|
|
1262
1289
|
AccountId?: string;
|
|
1263
1290
|
/**
|
|
1291
|
+
* @public
|
|
1264
1292
|
* <p>If the account was created successfully, the unique identifier (ID) of the new account
|
|
1265
1293
|
* in the Amazon Web Services GovCloud (US) Region.</p>
|
|
1266
1294
|
*/
|
|
1267
1295
|
GovCloudAccountId?: string;
|
|
1268
1296
|
/**
|
|
1297
|
+
* @public
|
|
1269
1298
|
* <p>If the request failed, a description of the reason for the failure.</p>
|
|
1270
1299
|
* <ul>
|
|
1271
1300
|
* <li>
|
|
@@ -1339,6 +1368,7 @@ export interface CreateAccountStatus {
|
|
|
1339
1368
|
*/
|
|
1340
1369
|
export interface CreateAccountResponse {
|
|
1341
1370
|
/**
|
|
1371
|
+
* @public
|
|
1342
1372
|
* <p>A structure that contains details about the request to create an account. This
|
|
1343
1373
|
* response structure might not be fully populated when you first receive it because
|
|
1344
1374
|
* account creation is an asynchronous process. You can pass the returned
|
|
@@ -1370,6 +1400,7 @@ export declare class FinalizingOrganizationException extends __BaseException {
|
|
|
1370
1400
|
*/
|
|
1371
1401
|
export interface CreateGovCloudAccountRequest {
|
|
1372
1402
|
/**
|
|
1403
|
+
* @public
|
|
1373
1404
|
* <p>Specifies the email address of the owner to assign to the new member account in the
|
|
1374
1405
|
* commercial Region. This email address must not already be associated with another
|
|
1375
1406
|
* Amazon Web Services account. You must use a valid email address to complete account creation.</p>
|
|
@@ -1411,12 +1442,14 @@ export interface CreateGovCloudAccountRequest {
|
|
|
1411
1442
|
*/
|
|
1412
1443
|
Email: string | undefined;
|
|
1413
1444
|
/**
|
|
1445
|
+
* @public
|
|
1414
1446
|
* <p>The friendly name of the member account. </p>
|
|
1415
1447
|
* <p>The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or
|
|
1416
1448
|
* dot (.) You can't separate characters with a dash (–).</p>
|
|
1417
1449
|
*/
|
|
1418
1450
|
AccountName: string | undefined;
|
|
1419
1451
|
/**
|
|
1452
|
+
* @public
|
|
1420
1453
|
* <p>(Optional)</p>
|
|
1421
1454
|
* <p>The name of an IAM role that Organizations automatically preconfigures in the new member
|
|
1422
1455
|
* accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role
|
|
@@ -1436,6 +1469,7 @@ export interface CreateGovCloudAccountRequest {
|
|
|
1436
1469
|
*/
|
|
1437
1470
|
RoleName?: string;
|
|
1438
1471
|
/**
|
|
1472
|
+
* @public
|
|
1439
1473
|
* <p>If set to <code>ALLOW</code>, the new linked account in the commercial Region enables
|
|
1440
1474
|
* IAM users to access account billing information <i>if</i> they have the
|
|
1441
1475
|
* required permissions. If set to <code>DENY</code>, only the root user of the new account
|
|
@@ -1449,6 +1483,7 @@ export interface CreateGovCloudAccountRequest {
|
|
|
1449
1483
|
*/
|
|
1450
1484
|
IamUserAccessToBilling?: IAMUserAccessToBilling | string;
|
|
1451
1485
|
/**
|
|
1486
|
+
* @public
|
|
1452
1487
|
* <p>A list of tags that you want to attach to the newly created account. These tags are
|
|
1453
1488
|
* attached to the commercial account associated with the GovCloud account, and not to the
|
|
1454
1489
|
* GovCloud account itself. To add tags to the actual GovCloud account, call the <a>TagResource</a> operation in the GovCloud region after the new GovCloud
|
|
@@ -1470,6 +1505,7 @@ export interface CreateGovCloudAccountRequest {
|
|
|
1470
1505
|
*/
|
|
1471
1506
|
export interface CreateGovCloudAccountResponse {
|
|
1472
1507
|
/**
|
|
1508
|
+
* @public
|
|
1473
1509
|
* <p>Contains the status about a <a>CreateAccount</a> or <a>CreateGovCloudAccount</a> request to create an Amazon Web Services account or an Amazon Web Services
|
|
1474
1510
|
* GovCloud (US) account in an organization.</p>
|
|
1475
1511
|
*/
|
|
@@ -1492,6 +1528,7 @@ export type OrganizationFeatureSet = (typeof OrganizationFeatureSet)[keyof typeo
|
|
|
1492
1528
|
*/
|
|
1493
1529
|
export interface CreateOrganizationRequest {
|
|
1494
1530
|
/**
|
|
1531
|
+
* @public
|
|
1495
1532
|
* <p>Specifies the feature set supported by the new organization. Each feature set supports
|
|
1496
1533
|
* different levels of functionality.</p>
|
|
1497
1534
|
* <ul>
|
|
@@ -1551,10 +1588,12 @@ export type PolicyType = (typeof PolicyType)[keyof typeof PolicyType];
|
|
|
1551
1588
|
*/
|
|
1552
1589
|
export interface PolicyTypeSummary {
|
|
1553
1590
|
/**
|
|
1591
|
+
* @public
|
|
1554
1592
|
* <p>The name of the policy type.</p>
|
|
1555
1593
|
*/
|
|
1556
1594
|
Type?: PolicyType | string;
|
|
1557
1595
|
/**
|
|
1596
|
+
* @public
|
|
1558
1597
|
* <p>The status of the policy type as it relates to the associated root. To attach a policy
|
|
1559
1598
|
* of the specified type to a root or to an OU or account in that root, it must be
|
|
1560
1599
|
* available in the organization and enabled for that root.</p>
|
|
@@ -1569,18 +1608,21 @@ export interface PolicyTypeSummary {
|
|
|
1569
1608
|
*/
|
|
1570
1609
|
export interface Organization {
|
|
1571
1610
|
/**
|
|
1611
|
+
* @public
|
|
1572
1612
|
* <p>The unique identifier (ID) of an organization.</p>
|
|
1573
1613
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organization ID string requires "o-"
|
|
1574
1614
|
* followed by from 10 to 32 lowercase letters or digits.</p>
|
|
1575
1615
|
*/
|
|
1576
1616
|
Id?: string;
|
|
1577
1617
|
/**
|
|
1618
|
+
* @public
|
|
1578
1619
|
* <p>The Amazon Resource Name (ARN) of an organization.</p>
|
|
1579
1620
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
1580
1621
|
* Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>
|
|
1581
1622
|
*/
|
|
1582
1623
|
Arn?: string;
|
|
1583
1624
|
/**
|
|
1625
|
+
* @public
|
|
1584
1626
|
* <p>Specifies the functionality that currently is available to the organization. If set to
|
|
1585
1627
|
* "ALL", then all features are enabled and policies can be applied to accounts in the
|
|
1586
1628
|
* organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing
|
|
@@ -1589,6 +1631,7 @@ export interface Organization {
|
|
|
1589
1631
|
*/
|
|
1590
1632
|
FeatureSet?: OrganizationFeatureSet | string;
|
|
1591
1633
|
/**
|
|
1634
|
+
* @public
|
|
1592
1635
|
* <p>The Amazon Resource Name (ARN) of the account that is designated as the management
|
|
1593
1636
|
* account for the organization.</p>
|
|
1594
1637
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
@@ -1596,17 +1639,20 @@ export interface Organization {
|
|
|
1596
1639
|
*/
|
|
1597
1640
|
MasterAccountArn?: string;
|
|
1598
1641
|
/**
|
|
1642
|
+
* @public
|
|
1599
1643
|
* <p>The unique identifier (ID) of the management account of an organization.</p>
|
|
1600
1644
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12
|
|
1601
1645
|
* digits.</p>
|
|
1602
1646
|
*/
|
|
1603
1647
|
MasterAccountId?: string;
|
|
1604
1648
|
/**
|
|
1649
|
+
* @public
|
|
1605
1650
|
* <p>The email address that is associated with the Amazon Web Services account that is designated as the
|
|
1606
1651
|
* management account for the organization.</p>
|
|
1607
1652
|
*/
|
|
1608
1653
|
MasterAccountEmail?: string;
|
|
1609
1654
|
/**
|
|
1655
|
+
* @public
|
|
1610
1656
|
* <important>
|
|
1611
1657
|
* <p>Do not use. This field is deprecated and doesn't provide complete information
|
|
1612
1658
|
* about the policies in your organization.</p>
|
|
@@ -1621,6 +1667,7 @@ export interface Organization {
|
|
|
1621
1667
|
*/
|
|
1622
1668
|
export interface CreateOrganizationResponse {
|
|
1623
1669
|
/**
|
|
1670
|
+
* @public
|
|
1624
1671
|
* <p>A structure that contains details about the newly created organization.</p>
|
|
1625
1672
|
*/
|
|
1626
1673
|
Organization?: Organization;
|
|
@@ -1630,6 +1677,7 @@ export interface CreateOrganizationResponse {
|
|
|
1630
1677
|
*/
|
|
1631
1678
|
export interface CreateOrganizationalUnitRequest {
|
|
1632
1679
|
/**
|
|
1680
|
+
* @public
|
|
1633
1681
|
* <p>The unique identifier (ID) of the parent root or OU that you want to create the new OU
|
|
1634
1682
|
* in.</p>
|
|
1635
1683
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the
|
|
@@ -1650,10 +1698,12 @@ export interface CreateOrganizationalUnitRequest {
|
|
|
1650
1698
|
*/
|
|
1651
1699
|
ParentId: string | undefined;
|
|
1652
1700
|
/**
|
|
1701
|
+
* @public
|
|
1653
1702
|
* <p>The friendly name to assign to the new OU.</p>
|
|
1654
1703
|
*/
|
|
1655
1704
|
Name: string | undefined;
|
|
1656
1705
|
/**
|
|
1706
|
+
* @public
|
|
1657
1707
|
* <p>A list of tags that you want to attach to the newly created OU. For each tag in the
|
|
1658
1708
|
* list, you must specify both a tag key and a value. You can set the value to an empty
|
|
1659
1709
|
* string, but you can't set it to <code>null</code>. For more information about tagging,
|
|
@@ -1674,6 +1724,7 @@ export interface CreateOrganizationalUnitRequest {
|
|
|
1674
1724
|
*/
|
|
1675
1725
|
export interface OrganizationalUnit {
|
|
1676
1726
|
/**
|
|
1727
|
+
* @public
|
|
1677
1728
|
* <p>The unique identifier (ID) associated with this OU.</p>
|
|
1678
1729
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires
|
|
1679
1730
|
* "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the
|
|
@@ -1682,12 +1733,14 @@ export interface OrganizationalUnit {
|
|
|
1682
1733
|
*/
|
|
1683
1734
|
Id?: string;
|
|
1684
1735
|
/**
|
|
1736
|
+
* @public
|
|
1685
1737
|
* <p>The Amazon Resource Name (ARN) of this OU.</p>
|
|
1686
1738
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
1687
1739
|
* Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>
|
|
1688
1740
|
*/
|
|
1689
1741
|
Arn?: string;
|
|
1690
1742
|
/**
|
|
1743
|
+
* @public
|
|
1691
1744
|
* <p>The friendly name of this OU.</p>
|
|
1692
1745
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
1693
1746
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -1700,6 +1753,7 @@ export interface OrganizationalUnit {
|
|
|
1700
1753
|
*/
|
|
1701
1754
|
export interface CreateOrganizationalUnitResponse {
|
|
1702
1755
|
/**
|
|
1756
|
+
* @public
|
|
1703
1757
|
* <p>A structure that contains details about the newly created OU.</p>
|
|
1704
1758
|
*/
|
|
1705
1759
|
OrganizationalUnit?: OrganizationalUnit;
|
|
@@ -1735,15 +1789,18 @@ export declare class ParentNotFoundException extends __BaseException {
|
|
|
1735
1789
|
*/
|
|
1736
1790
|
export interface CreatePolicyRequest {
|
|
1737
1791
|
/**
|
|
1792
|
+
* @public
|
|
1738
1793
|
* <p>The policy text content to add to the new policy. The text that you supply must adhere
|
|
1739
1794
|
* to the rules of the policy type you specify in the <code>Type</code> parameter.</p>
|
|
1740
1795
|
*/
|
|
1741
1796
|
Content: string | undefined;
|
|
1742
1797
|
/**
|
|
1798
|
+
* @public
|
|
1743
1799
|
* <p>An optional description to assign to the policy.</p>
|
|
1744
1800
|
*/
|
|
1745
1801
|
Description: string | undefined;
|
|
1746
1802
|
/**
|
|
1803
|
+
* @public
|
|
1747
1804
|
* <p>The friendly name to assign to the policy.</p>
|
|
1748
1805
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
1749
1806
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -1751,6 +1808,7 @@ export interface CreatePolicyRequest {
|
|
|
1751
1808
|
*/
|
|
1752
1809
|
Name: string | undefined;
|
|
1753
1810
|
/**
|
|
1811
|
+
* @public
|
|
1754
1812
|
* <p>The type of policy to create. You can specify one of the following values:</p>
|
|
1755
1813
|
* <ul>
|
|
1756
1814
|
* <li>
|
|
@@ -1777,6 +1835,7 @@ export interface CreatePolicyRequest {
|
|
|
1777
1835
|
*/
|
|
1778
1836
|
Type: PolicyType | string | undefined;
|
|
1779
1837
|
/**
|
|
1838
|
+
* @public
|
|
1780
1839
|
* <p>A list of tags that you want to attach to the newly created policy. For each tag in
|
|
1781
1840
|
* the list, you must specify both a tag key and a value. You can set the value to an empty
|
|
1782
1841
|
* string, but you can't set it to <code>null</code>. For more information about tagging,
|
|
@@ -1796,18 +1855,21 @@ export interface CreatePolicyRequest {
|
|
|
1796
1855
|
*/
|
|
1797
1856
|
export interface PolicySummary {
|
|
1798
1857
|
/**
|
|
1858
|
+
* @public
|
|
1799
1859
|
* <p>The unique identifier (ID) of the policy.</p>
|
|
1800
1860
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed
|
|
1801
1861
|
* by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).</p>
|
|
1802
1862
|
*/
|
|
1803
1863
|
Id?: string;
|
|
1804
1864
|
/**
|
|
1865
|
+
* @public
|
|
1805
1866
|
* <p>The Amazon Resource Name (ARN) of the policy.</p>
|
|
1806
1867
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
1807
1868
|
* Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>
|
|
1808
1869
|
*/
|
|
1809
1870
|
Arn?: string;
|
|
1810
1871
|
/**
|
|
1872
|
+
* @public
|
|
1811
1873
|
* <p>The friendly name of the policy.</p>
|
|
1812
1874
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
1813
1875
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -1815,14 +1877,17 @@ export interface PolicySummary {
|
|
|
1815
1877
|
*/
|
|
1816
1878
|
Name?: string;
|
|
1817
1879
|
/**
|
|
1880
|
+
* @public
|
|
1818
1881
|
* <p>The description of the policy.</p>
|
|
1819
1882
|
*/
|
|
1820
1883
|
Description?: string;
|
|
1821
1884
|
/**
|
|
1885
|
+
* @public
|
|
1822
1886
|
* <p>The type of policy.</p>
|
|
1823
1887
|
*/
|
|
1824
1888
|
Type?: PolicyType | string;
|
|
1825
1889
|
/**
|
|
1890
|
+
* @public
|
|
1826
1891
|
* <p>A boolean value that indicates whether the specified policy is an Amazon Web Services managed
|
|
1827
1892
|
* policy. If true, then you can attach the policy to roots, OUs, or accounts, but you
|
|
1828
1893
|
* cannot edit it.</p>
|
|
@@ -1837,10 +1902,12 @@ export interface PolicySummary {
|
|
|
1837
1902
|
*/
|
|
1838
1903
|
export interface Policy {
|
|
1839
1904
|
/**
|
|
1905
|
+
* @public
|
|
1840
1906
|
* <p>A structure that contains additional details about the policy.</p>
|
|
1841
1907
|
*/
|
|
1842
1908
|
PolicySummary?: PolicySummary;
|
|
1843
1909
|
/**
|
|
1910
|
+
* @public
|
|
1844
1911
|
* <p>The text content of the policy.</p>
|
|
1845
1912
|
*/
|
|
1846
1913
|
Content?: string;
|
|
@@ -1850,6 +1917,7 @@ export interface Policy {
|
|
|
1850
1917
|
*/
|
|
1851
1918
|
export interface CreatePolicyResponse {
|
|
1852
1919
|
/**
|
|
1920
|
+
* @public
|
|
1853
1921
|
* <p>A structure that contains details about the newly created policy.</p>
|
|
1854
1922
|
*/
|
|
1855
1923
|
Policy?: Policy;
|
|
@@ -1906,6 +1974,7 @@ export declare class PolicyTypeNotAvailableForOrganizationException extends __Ba
|
|
|
1906
1974
|
*/
|
|
1907
1975
|
export interface DeclineHandshakeRequest {
|
|
1908
1976
|
/**
|
|
1977
|
+
* @public
|
|
1909
1978
|
* <p>The unique identifier (ID) of the handshake that you want to decline. You can get the
|
|
1910
1979
|
* ID from the <a>ListHandshakesForAccount</a> operation.</p>
|
|
1911
1980
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-"
|
|
@@ -1932,6 +2001,7 @@ export declare class OrganizationNotEmptyException extends __BaseException {
|
|
|
1932
2001
|
*/
|
|
1933
2002
|
export interface DeleteOrganizationalUnitRequest {
|
|
1934
2003
|
/**
|
|
2004
|
+
* @public
|
|
1935
2005
|
* <p>The unique identifier (ID) of the organizational unit that you want to delete. You can
|
|
1936
2006
|
* get the ID from the <a>ListOrganizationalUnitsForParent</a> operation.</p>
|
|
1937
2007
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires
|
|
@@ -1974,6 +2044,7 @@ export declare class OrganizationalUnitNotFoundException extends __BaseException
|
|
|
1974
2044
|
*/
|
|
1975
2045
|
export interface DeletePolicyRequest {
|
|
1976
2046
|
/**
|
|
2047
|
+
* @public
|
|
1977
2048
|
* <p>The unique identifier (ID) of the policy that you want to delete. You can get the ID
|
|
1978
2049
|
* from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a>
|
|
1979
2050
|
* operations.</p>
|
|
@@ -2014,11 +2085,13 @@ export declare class ResourcePolicyNotFoundException extends __BaseException {
|
|
|
2014
2085
|
*/
|
|
2015
2086
|
export interface DeregisterDelegatedAdministratorRequest {
|
|
2016
2087
|
/**
|
|
2088
|
+
* @public
|
|
2017
2089
|
* <p>The account ID number of the member account in the organization that you want to
|
|
2018
2090
|
* deregister as a delegated administrator.</p>
|
|
2019
2091
|
*/
|
|
2020
2092
|
AccountId: string | undefined;
|
|
2021
2093
|
/**
|
|
2094
|
+
* @public
|
|
2022
2095
|
* <p>The service principal name of an Amazon Web Services service for which the account is a delegated
|
|
2023
2096
|
* administrator.</p>
|
|
2024
2097
|
* <p>Delegated administrator privileges are revoked for only the specified Amazon Web Services service
|
|
@@ -2033,6 +2106,7 @@ export interface DeregisterDelegatedAdministratorRequest {
|
|
|
2033
2106
|
*/
|
|
2034
2107
|
export interface DescribeAccountRequest {
|
|
2035
2108
|
/**
|
|
2109
|
+
* @public
|
|
2036
2110
|
* <p>The unique identifier (ID) of the Amazon Web Services account that you want information about. You
|
|
2037
2111
|
* can get the ID from the <a>ListAccounts</a> or <a>ListAccountsForParent</a> operations.</p>
|
|
2038
2112
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12
|
|
@@ -2045,6 +2119,7 @@ export interface DescribeAccountRequest {
|
|
|
2045
2119
|
*/
|
|
2046
2120
|
export interface DescribeAccountResponse {
|
|
2047
2121
|
/**
|
|
2122
|
+
* @public
|
|
2048
2123
|
* <p>A structure that contains information about the requested account.</p>
|
|
2049
2124
|
*/
|
|
2050
2125
|
Account?: Account;
|
|
@@ -2068,6 +2143,7 @@ export declare class CreateAccountStatusNotFoundException extends __BaseExceptio
|
|
|
2068
2143
|
*/
|
|
2069
2144
|
export interface DescribeCreateAccountStatusRequest {
|
|
2070
2145
|
/**
|
|
2146
|
+
* @public
|
|
2071
2147
|
* <p>Specifies the <code>Id</code> value that uniquely identifies the
|
|
2072
2148
|
* <code>CreateAccount</code> request. You can get the value from the
|
|
2073
2149
|
* <code>CreateAccountStatus.Id</code> response in an earlier <a>CreateAccount</a> request, or from the <a>ListCreateAccountStatus</a> operation.</p>
|
|
@@ -2081,6 +2157,7 @@ export interface DescribeCreateAccountStatusRequest {
|
|
|
2081
2157
|
*/
|
|
2082
2158
|
export interface DescribeCreateAccountStatusResponse {
|
|
2083
2159
|
/**
|
|
2160
|
+
* @public
|
|
2084
2161
|
* <p>A structure that contains the current status of an account creation request.</p>
|
|
2085
2162
|
*/
|
|
2086
2163
|
CreateAccountStatus?: CreateAccountStatus;
|
|
@@ -2103,6 +2180,7 @@ export type EffectivePolicyType = (typeof EffectivePolicyType)[keyof typeof Effe
|
|
|
2103
2180
|
*/
|
|
2104
2181
|
export interface DescribeEffectivePolicyRequest {
|
|
2105
2182
|
/**
|
|
2183
|
+
* @public
|
|
2106
2184
|
* <p>The type of policy that you want information about. You can specify one of the
|
|
2107
2185
|
* following values:</p>
|
|
2108
2186
|
* <ul>
|
|
@@ -2125,6 +2203,7 @@ export interface DescribeEffectivePolicyRequest {
|
|
|
2125
2203
|
*/
|
|
2126
2204
|
PolicyType: EffectivePolicyType | string | undefined;
|
|
2127
2205
|
/**
|
|
2206
|
+
* @public
|
|
2128
2207
|
* <p>When you're signed in as the management account, specify the ID of the account that
|
|
2129
2208
|
* you want details about. Specifying an organization root or organizational unit (OU) as
|
|
2130
2209
|
* the target is not supported.</p>
|
|
@@ -2139,18 +2218,22 @@ export interface DescribeEffectivePolicyRequest {
|
|
|
2139
2218
|
*/
|
|
2140
2219
|
export interface EffectivePolicy {
|
|
2141
2220
|
/**
|
|
2221
|
+
* @public
|
|
2142
2222
|
* <p>The text content of the policy.</p>
|
|
2143
2223
|
*/
|
|
2144
2224
|
PolicyContent?: string;
|
|
2145
2225
|
/**
|
|
2226
|
+
* @public
|
|
2146
2227
|
* <p>The time of the last update to this policy.</p>
|
|
2147
2228
|
*/
|
|
2148
2229
|
LastUpdatedTimestamp?: Date;
|
|
2149
2230
|
/**
|
|
2231
|
+
* @public
|
|
2150
2232
|
* <p>The account ID of the policy target. </p>
|
|
2151
2233
|
*/
|
|
2152
2234
|
TargetId?: string;
|
|
2153
2235
|
/**
|
|
2236
|
+
* @public
|
|
2154
2237
|
* <p>The policy type.</p>
|
|
2155
2238
|
*/
|
|
2156
2239
|
PolicyType?: EffectivePolicyType | string;
|
|
@@ -2160,6 +2243,7 @@ export interface EffectivePolicy {
|
|
|
2160
2243
|
*/
|
|
2161
2244
|
export interface DescribeEffectivePolicyResponse {
|
|
2162
2245
|
/**
|
|
2246
|
+
* @public
|
|
2163
2247
|
* <p>The contents of the effective policy.</p>
|
|
2164
2248
|
*/
|
|
2165
2249
|
EffectivePolicy?: EffectivePolicy;
|
|
@@ -2185,6 +2269,7 @@ export declare class EffectivePolicyNotFoundException extends __BaseException {
|
|
|
2185
2269
|
*/
|
|
2186
2270
|
export interface DescribeHandshakeRequest {
|
|
2187
2271
|
/**
|
|
2272
|
+
* @public
|
|
2188
2273
|
* <p>The unique identifier (ID) of the handshake that you want information about. You can
|
|
2189
2274
|
* get the ID from the original call to <a>InviteAccountToOrganization</a>, or
|
|
2190
2275
|
* from a call to <a>ListHandshakesForAccount</a> or <a>ListHandshakesForOrganization</a>.</p>
|
|
@@ -2198,6 +2283,7 @@ export interface DescribeHandshakeRequest {
|
|
|
2198
2283
|
*/
|
|
2199
2284
|
export interface DescribeOrganizationResponse {
|
|
2200
2285
|
/**
|
|
2286
|
+
* @public
|
|
2201
2287
|
* <p>A structure that contains information about the organization.</p>
|
|
2202
2288
|
* <important>
|
|
2203
2289
|
* <p>The <code>AvailablePolicyTypes</code> part of the response is deprecated, and you
|
|
@@ -2215,6 +2301,7 @@ export interface DescribeOrganizationResponse {
|
|
|
2215
2301
|
*/
|
|
2216
2302
|
export interface DescribeOrganizationalUnitRequest {
|
|
2217
2303
|
/**
|
|
2304
|
+
* @public
|
|
2218
2305
|
* <p>The unique identifier (ID) of the organizational unit that you want details about. You
|
|
2219
2306
|
* can get the ID from the <a>ListOrganizationalUnitsForParent</a>
|
|
2220
2307
|
* operation.</p>
|
|
@@ -2230,6 +2317,7 @@ export interface DescribeOrganizationalUnitRequest {
|
|
|
2230
2317
|
*/
|
|
2231
2318
|
export interface DescribeOrganizationalUnitResponse {
|
|
2232
2319
|
/**
|
|
2320
|
+
* @public
|
|
2233
2321
|
* <p>A structure that contains details about the specified OU.</p>
|
|
2234
2322
|
*/
|
|
2235
2323
|
OrganizationalUnit?: OrganizationalUnit;
|
|
@@ -2239,6 +2327,7 @@ export interface DescribeOrganizationalUnitResponse {
|
|
|
2239
2327
|
*/
|
|
2240
2328
|
export interface DescribePolicyRequest {
|
|
2241
2329
|
/**
|
|
2330
|
+
* @public
|
|
2242
2331
|
* <p>The unique identifier (ID) of the policy that you want details about. You can get the
|
|
2243
2332
|
* ID from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a>
|
|
2244
2333
|
* operations.</p>
|
|
@@ -2252,6 +2341,7 @@ export interface DescribePolicyRequest {
|
|
|
2252
2341
|
*/
|
|
2253
2342
|
export interface DescribePolicyResponse {
|
|
2254
2343
|
/**
|
|
2344
|
+
* @public
|
|
2255
2345
|
* <p>A structure that contains details about the specified policy.</p>
|
|
2256
2346
|
*/
|
|
2257
2347
|
Policy?: Policy;
|
|
@@ -2262,10 +2352,12 @@ export interface DescribePolicyResponse {
|
|
|
2262
2352
|
*/
|
|
2263
2353
|
export interface ResourcePolicySummary {
|
|
2264
2354
|
/**
|
|
2355
|
+
* @public
|
|
2265
2356
|
* <p>The unique identifier (ID) of the resource policy.</p>
|
|
2266
2357
|
*/
|
|
2267
2358
|
Id?: string;
|
|
2268
2359
|
/**
|
|
2360
|
+
* @public
|
|
2269
2361
|
* <p>The Amazon Resource Name (ARN) of the resource policy.</p>
|
|
2270
2362
|
*/
|
|
2271
2363
|
Arn?: string;
|
|
@@ -2276,10 +2368,12 @@ export interface ResourcePolicySummary {
|
|
|
2276
2368
|
*/
|
|
2277
2369
|
export interface ResourcePolicy {
|
|
2278
2370
|
/**
|
|
2371
|
+
* @public
|
|
2279
2372
|
* <p>A structure that contains resource policy ID and Amazon Resource Name (ARN).</p>
|
|
2280
2373
|
*/
|
|
2281
2374
|
ResourcePolicySummary?: ResourcePolicySummary;
|
|
2282
2375
|
/**
|
|
2376
|
+
* @public
|
|
2283
2377
|
* <p>The policy text of the resource policy.</p>
|
|
2284
2378
|
*/
|
|
2285
2379
|
Content?: string;
|
|
@@ -2289,6 +2383,7 @@ export interface ResourcePolicy {
|
|
|
2289
2383
|
*/
|
|
2290
2384
|
export interface DescribeResourcePolicyResponse {
|
|
2291
2385
|
/**
|
|
2386
|
+
* @public
|
|
2292
2387
|
* <p>A structure that contains details about the resource policy.</p>
|
|
2293
2388
|
*/
|
|
2294
2389
|
ResourcePolicy?: ResourcePolicy;
|
|
@@ -2298,6 +2393,7 @@ export interface DescribeResourcePolicyResponse {
|
|
|
2298
2393
|
*/
|
|
2299
2394
|
export interface DetachPolicyRequest {
|
|
2300
2395
|
/**
|
|
2396
|
+
* @public
|
|
2301
2397
|
* <p>The unique identifier (ID) of the policy you want to detach. You can get the ID from
|
|
2302
2398
|
* the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a>
|
|
2303
2399
|
* operations.</p>
|
|
@@ -2306,6 +2402,7 @@ export interface DetachPolicyRequest {
|
|
|
2306
2402
|
*/
|
|
2307
2403
|
PolicyId: string | undefined;
|
|
2308
2404
|
/**
|
|
2405
|
+
* @public
|
|
2309
2406
|
* <p>The unique identifier (ID) of the root, OU, or account that you want to detach the
|
|
2310
2407
|
* policy from. You can get the ID from the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a>
|
|
2311
2408
|
* operations.</p>
|
|
@@ -2349,6 +2446,7 @@ export declare class PolicyNotAttachedException extends __BaseException {
|
|
|
2349
2446
|
*/
|
|
2350
2447
|
export interface DisableAWSServiceAccessRequest {
|
|
2351
2448
|
/**
|
|
2449
|
+
* @public
|
|
2352
2450
|
* <p>The service principal name of the Amazon Web Services service for which you want to disable
|
|
2353
2451
|
* integration with your organization. This is typically in the form of a URL, such as
|
|
2354
2452
|
* <code>
|
|
@@ -2361,6 +2459,7 @@ export interface DisableAWSServiceAccessRequest {
|
|
|
2361
2459
|
*/
|
|
2362
2460
|
export interface DisablePolicyTypeRequest {
|
|
2363
2461
|
/**
|
|
2462
|
+
* @public
|
|
2364
2463
|
* <p>The unique identifier (ID) of the root in which you want to disable a policy type. You
|
|
2365
2464
|
* can get the ID from the <a>ListRoots</a> operation.</p>
|
|
2366
2465
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by
|
|
@@ -2368,6 +2467,7 @@ export interface DisablePolicyTypeRequest {
|
|
|
2368
2467
|
*/
|
|
2369
2468
|
RootId: string | undefined;
|
|
2370
2469
|
/**
|
|
2470
|
+
* @public
|
|
2371
2471
|
* <p>The policy type that you want to disable in this root. You can specify one of the
|
|
2372
2472
|
* following values:</p>
|
|
2373
2473
|
* <ul>
|
|
@@ -2404,18 +2504,21 @@ export interface DisablePolicyTypeRequest {
|
|
|
2404
2504
|
*/
|
|
2405
2505
|
export interface Root {
|
|
2406
2506
|
/**
|
|
2507
|
+
* @public
|
|
2407
2508
|
* <p>The unique identifier (ID) for the root.</p>
|
|
2408
2509
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by
|
|
2409
2510
|
* from 4 to 32 lowercase letters or digits.</p>
|
|
2410
2511
|
*/
|
|
2411
2512
|
Id?: string;
|
|
2412
2513
|
/**
|
|
2514
|
+
* @public
|
|
2413
2515
|
* <p>The Amazon Resource Name (ARN) of the root.</p>
|
|
2414
2516
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
2415
2517
|
* Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>
|
|
2416
2518
|
*/
|
|
2417
2519
|
Arn?: string;
|
|
2418
2520
|
/**
|
|
2521
|
+
* @public
|
|
2419
2522
|
* <p>The friendly name of the root.</p>
|
|
2420
2523
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
2421
2524
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -2423,6 +2526,7 @@ export interface Root {
|
|
|
2423
2526
|
*/
|
|
2424
2527
|
Name?: string;
|
|
2425
2528
|
/**
|
|
2529
|
+
* @public
|
|
2426
2530
|
* <p>The types of policies that are currently enabled for the root and therefore can be
|
|
2427
2531
|
* attached to the root or to its OUs or accounts.</p>
|
|
2428
2532
|
* <note>
|
|
@@ -2438,6 +2542,7 @@ export interface Root {
|
|
|
2438
2542
|
*/
|
|
2439
2543
|
export interface DisablePolicyTypeResponse {
|
|
2440
2544
|
/**
|
|
2545
|
+
* @public
|
|
2441
2546
|
* <p>A structure that shows the root with the updated list of enabled policy types.</p>
|
|
2442
2547
|
*/
|
|
2443
2548
|
Root?: Root;
|
|
@@ -2465,6 +2570,7 @@ export interface EnableAllFeaturesRequest {
|
|
|
2465
2570
|
*/
|
|
2466
2571
|
export interface EnableAWSServiceAccessRequest {
|
|
2467
2572
|
/**
|
|
2573
|
+
* @public
|
|
2468
2574
|
* <p>The service principal name of the Amazon Web Services service for which you want to enable
|
|
2469
2575
|
* integration with your organization. This is typically in the form of a URL, such as
|
|
2470
2576
|
* <code>
|
|
@@ -2477,6 +2583,7 @@ export interface EnableAWSServiceAccessRequest {
|
|
|
2477
2583
|
*/
|
|
2478
2584
|
export interface EnablePolicyTypeRequest {
|
|
2479
2585
|
/**
|
|
2586
|
+
* @public
|
|
2480
2587
|
* <p>The unique identifier (ID) of the root in which you want to enable a policy type. You
|
|
2481
2588
|
* can get the ID from the <a>ListRoots</a> operation.</p>
|
|
2482
2589
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by
|
|
@@ -2484,6 +2591,7 @@ export interface EnablePolicyTypeRequest {
|
|
|
2484
2591
|
*/
|
|
2485
2592
|
RootId: string | undefined;
|
|
2486
2593
|
/**
|
|
2594
|
+
* @public
|
|
2487
2595
|
* <p>The policy type that you want to enable. You can specify one of the following
|
|
2488
2596
|
* values:</p>
|
|
2489
2597
|
* <ul>
|
|
@@ -2516,6 +2624,7 @@ export interface EnablePolicyTypeRequest {
|
|
|
2516
2624
|
*/
|
|
2517
2625
|
export interface EnablePolicyTypeResponse {
|
|
2518
2626
|
/**
|
|
2627
|
+
* @public
|
|
2519
2628
|
* <p>A structure that shows the root with the updated list of enabled policy types.</p>
|
|
2520
2629
|
*/
|
|
2521
2630
|
Root?: Root;
|
|
@@ -2555,6 +2664,7 @@ export declare class DuplicateHandshakeException extends __BaseException {
|
|
|
2555
2664
|
*/
|
|
2556
2665
|
export interface InviteAccountToOrganizationRequest {
|
|
2557
2666
|
/**
|
|
2667
|
+
* @public
|
|
2558
2668
|
* <p>The identifier (ID) of the Amazon Web Services account that you want to invite to join your
|
|
2559
2669
|
* organization. This is a JSON object that contains the following elements:</p>
|
|
2560
2670
|
* <p>
|
|
@@ -2577,11 +2687,13 @@ export interface InviteAccountToOrganizationRequest {
|
|
|
2577
2687
|
*/
|
|
2578
2688
|
Target: HandshakeParty | undefined;
|
|
2579
2689
|
/**
|
|
2690
|
+
* @public
|
|
2580
2691
|
* <p>Additional information that you want to include in the generated email to the
|
|
2581
2692
|
* recipient account owner.</p>
|
|
2582
2693
|
*/
|
|
2583
2694
|
Notes?: string;
|
|
2584
2695
|
/**
|
|
2696
|
+
* @public
|
|
2585
2697
|
* <p>A list of tags that you want to attach to the account when it becomes a member of the
|
|
2586
2698
|
* organization. For each tag in the list, you must specify both a tag key and a value. You
|
|
2587
2699
|
* can set the value to an empty string, but you can't set it to <code>null</code>. For
|
|
@@ -2625,6 +2737,7 @@ export declare class MasterCannotLeaveOrganizationException extends __BaseExcept
|
|
|
2625
2737
|
*/
|
|
2626
2738
|
export interface ListAccountsRequest {
|
|
2627
2739
|
/**
|
|
2740
|
+
* @public
|
|
2628
2741
|
* <p>The parameter for receiving additional results if you receive a
|
|
2629
2742
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
2630
2743
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -2633,6 +2746,7 @@ export interface ListAccountsRequest {
|
|
|
2633
2746
|
*/
|
|
2634
2747
|
NextToken?: string;
|
|
2635
2748
|
/**
|
|
2749
|
+
* @public
|
|
2636
2750
|
* <p>The total number of results that you want included on each page of the
|
|
2637
2751
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
2638
2752
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -2649,10 +2763,12 @@ export interface ListAccountsRequest {
|
|
|
2649
2763
|
*/
|
|
2650
2764
|
export interface ListAccountsResponse {
|
|
2651
2765
|
/**
|
|
2766
|
+
* @public
|
|
2652
2767
|
* <p>A list of objects in the organization.</p>
|
|
2653
2768
|
*/
|
|
2654
2769
|
Accounts?: Account[];
|
|
2655
2770
|
/**
|
|
2771
|
+
* @public
|
|
2656
2772
|
* <p>If present, indicates that more output is available than is
|
|
2657
2773
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
2658
2774
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -2665,11 +2781,13 @@ export interface ListAccountsResponse {
|
|
|
2665
2781
|
*/
|
|
2666
2782
|
export interface ListAccountsForParentRequest {
|
|
2667
2783
|
/**
|
|
2784
|
+
* @public
|
|
2668
2785
|
* <p>The unique identifier (ID) for the parent root or organization unit (OU) whose
|
|
2669
2786
|
* accounts you want to list.</p>
|
|
2670
2787
|
*/
|
|
2671
2788
|
ParentId: string | undefined;
|
|
2672
2789
|
/**
|
|
2790
|
+
* @public
|
|
2673
2791
|
* <p>The parameter for receiving additional results if you receive a
|
|
2674
2792
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
2675
2793
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -2678,6 +2796,7 @@ export interface ListAccountsForParentRequest {
|
|
|
2678
2796
|
*/
|
|
2679
2797
|
NextToken?: string;
|
|
2680
2798
|
/**
|
|
2799
|
+
* @public
|
|
2681
2800
|
* <p>The total number of results that you want included on each page of the
|
|
2682
2801
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
2683
2802
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -2694,10 +2813,12 @@ export interface ListAccountsForParentRequest {
|
|
|
2694
2813
|
*/
|
|
2695
2814
|
export interface ListAccountsForParentResponse {
|
|
2696
2815
|
/**
|
|
2816
|
+
* @public
|
|
2697
2817
|
* <p>A list of the accounts in the specified root or OU.</p>
|
|
2698
2818
|
*/
|
|
2699
2819
|
Accounts?: Account[];
|
|
2700
2820
|
/**
|
|
2821
|
+
* @public
|
|
2701
2822
|
* <p>If present, indicates that more output is available than is
|
|
2702
2823
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
2703
2824
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -2710,6 +2831,7 @@ export interface ListAccountsForParentResponse {
|
|
|
2710
2831
|
*/
|
|
2711
2832
|
export interface ListAWSServiceAccessForOrganizationRequest {
|
|
2712
2833
|
/**
|
|
2834
|
+
* @public
|
|
2713
2835
|
* <p>The parameter for receiving additional results if you receive a
|
|
2714
2836
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
2715
2837
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -2718,6 +2840,7 @@ export interface ListAWSServiceAccessForOrganizationRequest {
|
|
|
2718
2840
|
*/
|
|
2719
2841
|
NextToken?: string;
|
|
2720
2842
|
/**
|
|
2843
|
+
* @public
|
|
2721
2844
|
* <p>The total number of results that you want included on each page of the
|
|
2722
2845
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
2723
2846
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -2736,12 +2859,14 @@ export interface ListAWSServiceAccessForOrganizationRequest {
|
|
|
2736
2859
|
*/
|
|
2737
2860
|
export interface EnabledServicePrincipal {
|
|
2738
2861
|
/**
|
|
2862
|
+
* @public
|
|
2739
2863
|
* <p>The name of the service principal. This is typically in the form of a URL, such as:
|
|
2740
2864
|
* <code>
|
|
2741
2865
|
* <i>servicename</i>.amazonaws.com</code>.</p>
|
|
2742
2866
|
*/
|
|
2743
2867
|
ServicePrincipal?: string;
|
|
2744
2868
|
/**
|
|
2869
|
+
* @public
|
|
2745
2870
|
* <p>The date that the service principal was enabled for integration with Organizations.</p>
|
|
2746
2871
|
*/
|
|
2747
2872
|
DateEnabled?: Date;
|
|
@@ -2751,12 +2876,14 @@ export interface EnabledServicePrincipal {
|
|
|
2751
2876
|
*/
|
|
2752
2877
|
export interface ListAWSServiceAccessForOrganizationResponse {
|
|
2753
2878
|
/**
|
|
2879
|
+
* @public
|
|
2754
2880
|
* <p>A list of the service principals for the services that are enabled to integrate with
|
|
2755
2881
|
* your organization. Each principal is a structure that includes the name and the date
|
|
2756
2882
|
* that it was enabled for integration with Organizations.</p>
|
|
2757
2883
|
*/
|
|
2758
2884
|
EnabledServicePrincipals?: EnabledServicePrincipal[];
|
|
2759
2885
|
/**
|
|
2886
|
+
* @public
|
|
2760
2887
|
* <p>If present, indicates that more output is available than is
|
|
2761
2888
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
2762
2889
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -2781,6 +2908,7 @@ export type ChildType = (typeof ChildType)[keyof typeof ChildType];
|
|
|
2781
2908
|
*/
|
|
2782
2909
|
export interface ListChildrenRequest {
|
|
2783
2910
|
/**
|
|
2911
|
+
* @public
|
|
2784
2912
|
* <p>The unique identifier (ID) for the parent root or OU whose children you want to
|
|
2785
2913
|
* list.</p>
|
|
2786
2914
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the
|
|
@@ -2801,10 +2929,12 @@ export interface ListChildrenRequest {
|
|
|
2801
2929
|
*/
|
|
2802
2930
|
ParentId: string | undefined;
|
|
2803
2931
|
/**
|
|
2932
|
+
* @public
|
|
2804
2933
|
* <p>Filters the output to include only the specified child type.</p>
|
|
2805
2934
|
*/
|
|
2806
2935
|
ChildType: ChildType | string | undefined;
|
|
2807
2936
|
/**
|
|
2937
|
+
* @public
|
|
2808
2938
|
* <p>The parameter for receiving additional results if you receive a
|
|
2809
2939
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
2810
2940
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -2813,6 +2943,7 @@ export interface ListChildrenRequest {
|
|
|
2813
2943
|
*/
|
|
2814
2944
|
NextToken?: string;
|
|
2815
2945
|
/**
|
|
2946
|
+
* @public
|
|
2816
2947
|
* <p>The total number of results that you want included on each page of the
|
|
2817
2948
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
2818
2949
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -2830,6 +2961,7 @@ export interface ListChildrenRequest {
|
|
|
2830
2961
|
*/
|
|
2831
2962
|
export interface Child {
|
|
2832
2963
|
/**
|
|
2964
|
+
* @public
|
|
2833
2965
|
* <p>The unique identifier (ID) of this child entity.</p>
|
|
2834
2966
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a child ID string requires one of the
|
|
2835
2967
|
* following:</p>
|
|
@@ -2849,6 +2981,7 @@ export interface Child {
|
|
|
2849
2981
|
*/
|
|
2850
2982
|
Id?: string;
|
|
2851
2983
|
/**
|
|
2984
|
+
* @public
|
|
2852
2985
|
* <p>The type of this child entity.</p>
|
|
2853
2986
|
*/
|
|
2854
2987
|
Type?: ChildType | string;
|
|
@@ -2858,10 +2991,12 @@ export interface Child {
|
|
|
2858
2991
|
*/
|
|
2859
2992
|
export interface ListChildrenResponse {
|
|
2860
2993
|
/**
|
|
2994
|
+
* @public
|
|
2861
2995
|
* <p>The list of children of the specified parent container.</p>
|
|
2862
2996
|
*/
|
|
2863
2997
|
Children?: Child[];
|
|
2864
2998
|
/**
|
|
2999
|
+
* @public
|
|
2865
3000
|
* <p>If present, indicates that more output is available than is
|
|
2866
3001
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
2867
3002
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -2874,11 +3009,13 @@ export interface ListChildrenResponse {
|
|
|
2874
3009
|
*/
|
|
2875
3010
|
export interface ListCreateAccountStatusRequest {
|
|
2876
3011
|
/**
|
|
3012
|
+
* @public
|
|
2877
3013
|
* <p>A list of one or more states that you want included in the response. If this parameter
|
|
2878
3014
|
* isn't present, all requests are included in the response.</p>
|
|
2879
3015
|
*/
|
|
2880
3016
|
States?: (CreateAccountState | string)[];
|
|
2881
3017
|
/**
|
|
3018
|
+
* @public
|
|
2882
3019
|
* <p>The parameter for receiving additional results if you receive a
|
|
2883
3020
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
2884
3021
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -2887,6 +3024,7 @@ export interface ListCreateAccountStatusRequest {
|
|
|
2887
3024
|
*/
|
|
2888
3025
|
NextToken?: string;
|
|
2889
3026
|
/**
|
|
3027
|
+
* @public
|
|
2890
3028
|
* <p>The total number of results that you want included on each page of the
|
|
2891
3029
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
2892
3030
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -2903,12 +3041,14 @@ export interface ListCreateAccountStatusRequest {
|
|
|
2903
3041
|
*/
|
|
2904
3042
|
export interface ListCreateAccountStatusResponse {
|
|
2905
3043
|
/**
|
|
3044
|
+
* @public
|
|
2906
3045
|
* <p>A list of objects with details about the requests. Certain elements, such as the
|
|
2907
3046
|
* accountId number, are present in the output only after the account has been successfully
|
|
2908
3047
|
* created.</p>
|
|
2909
3048
|
*/
|
|
2910
3049
|
CreateAccountStatuses?: CreateAccountStatus[];
|
|
2911
3050
|
/**
|
|
3051
|
+
* @public
|
|
2912
3052
|
* <p>If present, indicates that more output is available than is
|
|
2913
3053
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
2914
3054
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -2921,6 +3061,7 @@ export interface ListCreateAccountStatusResponse {
|
|
|
2921
3061
|
*/
|
|
2922
3062
|
export interface ListDelegatedAdministratorsRequest {
|
|
2923
3063
|
/**
|
|
3064
|
+
* @public
|
|
2924
3065
|
* <p>Specifies a service principal name. If specified, then the operation lists the
|
|
2925
3066
|
* delegated administrators only for the specified service.</p>
|
|
2926
3067
|
* <p>If you don't specify a service principal, the operation lists all delegated
|
|
@@ -2928,6 +3069,7 @@ export interface ListDelegatedAdministratorsRequest {
|
|
|
2928
3069
|
*/
|
|
2929
3070
|
ServicePrincipal?: string;
|
|
2930
3071
|
/**
|
|
3072
|
+
* @public
|
|
2931
3073
|
* <p>The parameter for receiving additional results if you receive a
|
|
2932
3074
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
2933
3075
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -2936,6 +3078,7 @@ export interface ListDelegatedAdministratorsRequest {
|
|
|
2936
3078
|
*/
|
|
2937
3079
|
NextToken?: string;
|
|
2938
3080
|
/**
|
|
3081
|
+
* @public
|
|
2939
3082
|
* <p>The total number of results that you want included on each page of the
|
|
2940
3083
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
2941
3084
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -2953,37 +3096,45 @@ export interface ListDelegatedAdministratorsRequest {
|
|
|
2953
3096
|
*/
|
|
2954
3097
|
export interface DelegatedAdministrator {
|
|
2955
3098
|
/**
|
|
3099
|
+
* @public
|
|
2956
3100
|
* <p>The unique identifier (ID) of the delegated administrator's account.</p>
|
|
2957
3101
|
*/
|
|
2958
3102
|
Id?: string;
|
|
2959
3103
|
/**
|
|
3104
|
+
* @public
|
|
2960
3105
|
* <p>The Amazon Resource Name (ARN) of the delegated administrator's account.</p>
|
|
2961
3106
|
*/
|
|
2962
3107
|
Arn?: string;
|
|
2963
3108
|
/**
|
|
3109
|
+
* @public
|
|
2964
3110
|
* <p>The email address that is associated with the delegated administrator's Amazon Web Services
|
|
2965
3111
|
* account.</p>
|
|
2966
3112
|
*/
|
|
2967
3113
|
Email?: string;
|
|
2968
3114
|
/**
|
|
3115
|
+
* @public
|
|
2969
3116
|
* <p>The friendly name of the delegated administrator's account.</p>
|
|
2970
3117
|
*/
|
|
2971
3118
|
Name?: string;
|
|
2972
3119
|
/**
|
|
3120
|
+
* @public
|
|
2973
3121
|
* <p>The status of the delegated administrator's account in the organization.</p>
|
|
2974
3122
|
*/
|
|
2975
3123
|
Status?: AccountStatus | string;
|
|
2976
3124
|
/**
|
|
3125
|
+
* @public
|
|
2977
3126
|
* <p>The method by which the delegated administrator's account joined the
|
|
2978
3127
|
* organization.</p>
|
|
2979
3128
|
*/
|
|
2980
3129
|
JoinedMethod?: AccountJoinedMethod | string;
|
|
2981
3130
|
/**
|
|
3131
|
+
* @public
|
|
2982
3132
|
* <p>The date when the delegated administrator's account became a part of the
|
|
2983
3133
|
* organization.</p>
|
|
2984
3134
|
*/
|
|
2985
3135
|
JoinedTimestamp?: Date;
|
|
2986
3136
|
/**
|
|
3137
|
+
* @public
|
|
2987
3138
|
* <p>The date when the account was made a delegated administrator.</p>
|
|
2988
3139
|
*/
|
|
2989
3140
|
DelegationEnabledDate?: Date;
|
|
@@ -2993,10 +3144,12 @@ export interface DelegatedAdministrator {
|
|
|
2993
3144
|
*/
|
|
2994
3145
|
export interface ListDelegatedAdministratorsResponse {
|
|
2995
3146
|
/**
|
|
3147
|
+
* @public
|
|
2996
3148
|
* <p>The list of delegated administrators in your organization.</p>
|
|
2997
3149
|
*/
|
|
2998
3150
|
DelegatedAdministrators?: DelegatedAdministrator[];
|
|
2999
3151
|
/**
|
|
3152
|
+
* @public
|
|
3000
3153
|
* <p>If present, indicates that more output is available than is
|
|
3001
3154
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3002
3155
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3009,10 +3162,12 @@ export interface ListDelegatedAdministratorsResponse {
|
|
|
3009
3162
|
*/
|
|
3010
3163
|
export interface ListDelegatedServicesForAccountRequest {
|
|
3011
3164
|
/**
|
|
3165
|
+
* @public
|
|
3012
3166
|
* <p>The account ID number of a delegated administrator account in the organization.</p>
|
|
3013
3167
|
*/
|
|
3014
3168
|
AccountId: string | undefined;
|
|
3015
3169
|
/**
|
|
3170
|
+
* @public
|
|
3016
3171
|
* <p>The parameter for receiving additional results if you receive a
|
|
3017
3172
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3018
3173
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3021,6 +3176,7 @@ export interface ListDelegatedServicesForAccountRequest {
|
|
|
3021
3176
|
*/
|
|
3022
3177
|
NextToken?: string;
|
|
3023
3178
|
/**
|
|
3179
|
+
* @public
|
|
3024
3180
|
* <p>The total number of results that you want included on each page of the
|
|
3025
3181
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3026
3182
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3039,6 +3195,7 @@ export interface ListDelegatedServicesForAccountRequest {
|
|
|
3039
3195
|
*/
|
|
3040
3196
|
export interface DelegatedService {
|
|
3041
3197
|
/**
|
|
3198
|
+
* @public
|
|
3042
3199
|
* <p>The name of an Amazon Web Services service that can request an operation for the specified service.
|
|
3043
3200
|
* This is typically in the form of a URL, such as:
|
|
3044
3201
|
* <code>
|
|
@@ -3046,6 +3203,7 @@ export interface DelegatedService {
|
|
|
3046
3203
|
*/
|
|
3047
3204
|
ServicePrincipal?: string;
|
|
3048
3205
|
/**
|
|
3206
|
+
* @public
|
|
3049
3207
|
* <p>The date that the account became a delegated administrator for this service. </p>
|
|
3050
3208
|
*/
|
|
3051
3209
|
DelegationEnabledDate?: Date;
|
|
@@ -3055,10 +3213,12 @@ export interface DelegatedService {
|
|
|
3055
3213
|
*/
|
|
3056
3214
|
export interface ListDelegatedServicesForAccountResponse {
|
|
3057
3215
|
/**
|
|
3216
|
+
* @public
|
|
3058
3217
|
* <p>The services for which the account is a delegated administrator.</p>
|
|
3059
3218
|
*/
|
|
3060
3219
|
DelegatedServices?: DelegatedService[];
|
|
3061
3220
|
/**
|
|
3221
|
+
* @public
|
|
3062
3222
|
* <p>If present, indicates that more output is available than is
|
|
3063
3223
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3064
3224
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3073,12 +3233,14 @@ export interface ListDelegatedServicesForAccountResponse {
|
|
|
3073
3233
|
*/
|
|
3074
3234
|
export interface HandshakeFilter {
|
|
3075
3235
|
/**
|
|
3236
|
+
* @public
|
|
3076
3237
|
* <p>Specifies the type of handshake action.</p>
|
|
3077
3238
|
* <p>If you specify <code>ActionType</code>, you cannot also specify
|
|
3078
3239
|
* <code>ParentHandshakeId</code>.</p>
|
|
3079
3240
|
*/
|
|
3080
3241
|
ActionType?: ActionType | string;
|
|
3081
3242
|
/**
|
|
3243
|
+
* @public
|
|
3082
3244
|
* <p>Specifies the parent handshake. Only used for handshake types that are a child of
|
|
3083
3245
|
* another type.</p>
|
|
3084
3246
|
* <p>If you specify <code>ParentHandshakeId</code>, you cannot also specify
|
|
@@ -3093,6 +3255,7 @@ export interface HandshakeFilter {
|
|
|
3093
3255
|
*/
|
|
3094
3256
|
export interface ListHandshakesForAccountRequest {
|
|
3095
3257
|
/**
|
|
3258
|
+
* @public
|
|
3096
3259
|
* <p>Filters the handshakes that you want included in the response. The default is all
|
|
3097
3260
|
* types. Use the <code>ActionType</code> element to limit the output to only a specified
|
|
3098
3261
|
* type, such as <code>INVITE</code>, <code>ENABLE_ALL_FEATURES</code>, or
|
|
@@ -3103,6 +3266,7 @@ export interface ListHandshakesForAccountRequest {
|
|
|
3103
3266
|
*/
|
|
3104
3267
|
Filter?: HandshakeFilter;
|
|
3105
3268
|
/**
|
|
3269
|
+
* @public
|
|
3106
3270
|
* <p>The parameter for receiving additional results if you receive a
|
|
3107
3271
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3108
3272
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3111,6 +3275,7 @@ export interface ListHandshakesForAccountRequest {
|
|
|
3111
3275
|
*/
|
|
3112
3276
|
NextToken?: string;
|
|
3113
3277
|
/**
|
|
3278
|
+
* @public
|
|
3114
3279
|
* <p>The total number of results that you want included on each page of the
|
|
3115
3280
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3116
3281
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3127,6 +3292,7 @@ export interface ListHandshakesForAccountRequest {
|
|
|
3127
3292
|
*/
|
|
3128
3293
|
export interface ListHandshakesForOrganizationRequest {
|
|
3129
3294
|
/**
|
|
3295
|
+
* @public
|
|
3130
3296
|
* <p>A filter of the handshakes that you want included in the response. The default is all
|
|
3131
3297
|
* types. Use the <code>ActionType</code> element to limit the output to only a specified
|
|
3132
3298
|
* type, such as <code>INVITE</code>, <code>ENABLE-ALL-FEATURES</code>, or
|
|
@@ -3137,6 +3303,7 @@ export interface ListHandshakesForOrganizationRequest {
|
|
|
3137
3303
|
*/
|
|
3138
3304
|
Filter?: HandshakeFilter;
|
|
3139
3305
|
/**
|
|
3306
|
+
* @public
|
|
3140
3307
|
* <p>The parameter for receiving additional results if you receive a
|
|
3141
3308
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3142
3309
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3145,6 +3312,7 @@ export interface ListHandshakesForOrganizationRequest {
|
|
|
3145
3312
|
*/
|
|
3146
3313
|
NextToken?: string;
|
|
3147
3314
|
/**
|
|
3315
|
+
* @public
|
|
3148
3316
|
* <p>The total number of results that you want included on each page of the
|
|
3149
3317
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3150
3318
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3161,6 +3329,7 @@ export interface ListHandshakesForOrganizationRequest {
|
|
|
3161
3329
|
*/
|
|
3162
3330
|
export interface ListOrganizationalUnitsForParentRequest {
|
|
3163
3331
|
/**
|
|
3332
|
+
* @public
|
|
3164
3333
|
* <p>The unique identifier (ID) of the root or OU whose child OUs you want to list.</p>
|
|
3165
3334
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the
|
|
3166
3335
|
* following:</p>
|
|
@@ -3180,6 +3349,7 @@ export interface ListOrganizationalUnitsForParentRequest {
|
|
|
3180
3349
|
*/
|
|
3181
3350
|
ParentId: string | undefined;
|
|
3182
3351
|
/**
|
|
3352
|
+
* @public
|
|
3183
3353
|
* <p>The parameter for receiving additional results if you receive a
|
|
3184
3354
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3185
3355
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3188,6 +3358,7 @@ export interface ListOrganizationalUnitsForParentRequest {
|
|
|
3188
3358
|
*/
|
|
3189
3359
|
NextToken?: string;
|
|
3190
3360
|
/**
|
|
3361
|
+
* @public
|
|
3191
3362
|
* <p>The total number of results that you want included on each page of the
|
|
3192
3363
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3193
3364
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3204,10 +3375,12 @@ export interface ListOrganizationalUnitsForParentRequest {
|
|
|
3204
3375
|
*/
|
|
3205
3376
|
export interface ListOrganizationalUnitsForParentResponse {
|
|
3206
3377
|
/**
|
|
3378
|
+
* @public
|
|
3207
3379
|
* <p>A list of the OUs in the specified root or parent OU.</p>
|
|
3208
3380
|
*/
|
|
3209
3381
|
OrganizationalUnits?: OrganizationalUnit[];
|
|
3210
3382
|
/**
|
|
3383
|
+
* @public
|
|
3211
3384
|
* <p>If present, indicates that more output is available than is
|
|
3212
3385
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3213
3386
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3234,6 +3407,7 @@ export declare class ChildNotFoundException extends __BaseException {
|
|
|
3234
3407
|
*/
|
|
3235
3408
|
export interface ListParentsRequest {
|
|
3236
3409
|
/**
|
|
3410
|
+
* @public
|
|
3237
3411
|
* <p>The unique identifier (ID) of the OU or account whose parent containers you want to
|
|
3238
3412
|
* list. Don't specify a root.</p>
|
|
3239
3413
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a child ID string requires one of the
|
|
@@ -3254,6 +3428,7 @@ export interface ListParentsRequest {
|
|
|
3254
3428
|
*/
|
|
3255
3429
|
ChildId: string | undefined;
|
|
3256
3430
|
/**
|
|
3431
|
+
* @public
|
|
3257
3432
|
* <p>The parameter for receiving additional results if you receive a
|
|
3258
3433
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3259
3434
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3262,6 +3437,7 @@ export interface ListParentsRequest {
|
|
|
3262
3437
|
*/
|
|
3263
3438
|
NextToken?: string;
|
|
3264
3439
|
/**
|
|
3440
|
+
* @public
|
|
3265
3441
|
* <p>The total number of results that you want included on each page of the
|
|
3266
3442
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3267
3443
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3292,6 +3468,7 @@ export type ParentType = (typeof ParentType)[keyof typeof ParentType];
|
|
|
3292
3468
|
*/
|
|
3293
3469
|
export interface Parent {
|
|
3294
3470
|
/**
|
|
3471
|
+
* @public
|
|
3295
3472
|
* <p>The unique identifier (ID) of the parent entity.</p>
|
|
3296
3473
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the
|
|
3297
3474
|
* following:</p>
|
|
@@ -3311,6 +3488,7 @@ export interface Parent {
|
|
|
3311
3488
|
*/
|
|
3312
3489
|
Id?: string;
|
|
3313
3490
|
/**
|
|
3491
|
+
* @public
|
|
3314
3492
|
* <p>The type of the parent entity.</p>
|
|
3315
3493
|
*/
|
|
3316
3494
|
Type?: ParentType | string;
|
|
@@ -3320,10 +3498,12 @@ export interface Parent {
|
|
|
3320
3498
|
*/
|
|
3321
3499
|
export interface ListParentsResponse {
|
|
3322
3500
|
/**
|
|
3501
|
+
* @public
|
|
3323
3502
|
* <p>A list of parents for the specified child account or OU.</p>
|
|
3324
3503
|
*/
|
|
3325
3504
|
Parents?: Parent[];
|
|
3326
3505
|
/**
|
|
3506
|
+
* @public
|
|
3327
3507
|
* <p>If present, indicates that more output is available than is
|
|
3328
3508
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3329
3509
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3336,6 +3516,7 @@ export interface ListParentsResponse {
|
|
|
3336
3516
|
*/
|
|
3337
3517
|
export interface ListPoliciesRequest {
|
|
3338
3518
|
/**
|
|
3519
|
+
* @public
|
|
3339
3520
|
* <p>Specifies the type of policy that you want to include in the response. You must
|
|
3340
3521
|
* specify one of the following values:</p>
|
|
3341
3522
|
* <ul>
|
|
@@ -3363,6 +3544,7 @@ export interface ListPoliciesRequest {
|
|
|
3363
3544
|
*/
|
|
3364
3545
|
Filter: PolicyType | string | undefined;
|
|
3365
3546
|
/**
|
|
3547
|
+
* @public
|
|
3366
3548
|
* <p>The parameter for receiving additional results if you receive a
|
|
3367
3549
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3368
3550
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3371,6 +3553,7 @@ export interface ListPoliciesRequest {
|
|
|
3371
3553
|
*/
|
|
3372
3554
|
NextToken?: string;
|
|
3373
3555
|
/**
|
|
3556
|
+
* @public
|
|
3374
3557
|
* <p>The total number of results that you want included on each page of the
|
|
3375
3558
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3376
3559
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3387,11 +3570,13 @@ export interface ListPoliciesRequest {
|
|
|
3387
3570
|
*/
|
|
3388
3571
|
export interface ListPoliciesResponse {
|
|
3389
3572
|
/**
|
|
3573
|
+
* @public
|
|
3390
3574
|
* <p>A list of policies that match the filter criteria in the request. The output list
|
|
3391
3575
|
* doesn't include the policy contents. To see the content for a policy, see <a>DescribePolicy</a>.</p>
|
|
3392
3576
|
*/
|
|
3393
3577
|
Policies?: PolicySummary[];
|
|
3394
3578
|
/**
|
|
3579
|
+
* @public
|
|
3395
3580
|
* <p>If present, indicates that more output is available than is
|
|
3396
3581
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3397
3582
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3404,6 +3589,7 @@ export interface ListPoliciesResponse {
|
|
|
3404
3589
|
*/
|
|
3405
3590
|
export interface ListPoliciesForTargetRequest {
|
|
3406
3591
|
/**
|
|
3592
|
+
* @public
|
|
3407
3593
|
* <p>The unique identifier (ID) of the root, organizational unit, or account whose policies
|
|
3408
3594
|
* you want to list.</p>
|
|
3409
3595
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the
|
|
@@ -3428,6 +3614,7 @@ export interface ListPoliciesForTargetRequest {
|
|
|
3428
3614
|
*/
|
|
3429
3615
|
TargetId: string | undefined;
|
|
3430
3616
|
/**
|
|
3617
|
+
* @public
|
|
3431
3618
|
* <p>The type of policy that you want to include in the returned list. You must specify one
|
|
3432
3619
|
* of the following values:</p>
|
|
3433
3620
|
* <ul>
|
|
@@ -3455,6 +3642,7 @@ export interface ListPoliciesForTargetRequest {
|
|
|
3455
3642
|
*/
|
|
3456
3643
|
Filter: PolicyType | string | undefined;
|
|
3457
3644
|
/**
|
|
3645
|
+
* @public
|
|
3458
3646
|
* <p>The parameter for receiving additional results if you receive a
|
|
3459
3647
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3460
3648
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3463,6 +3651,7 @@ export interface ListPoliciesForTargetRequest {
|
|
|
3463
3651
|
*/
|
|
3464
3652
|
NextToken?: string;
|
|
3465
3653
|
/**
|
|
3654
|
+
* @public
|
|
3466
3655
|
* <p>The total number of results that you want included on each page of the
|
|
3467
3656
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3468
3657
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3479,10 +3668,12 @@ export interface ListPoliciesForTargetRequest {
|
|
|
3479
3668
|
*/
|
|
3480
3669
|
export interface ListPoliciesForTargetResponse {
|
|
3481
3670
|
/**
|
|
3671
|
+
* @public
|
|
3482
3672
|
* <p>The list of policies that match the criteria in the request.</p>
|
|
3483
3673
|
*/
|
|
3484
3674
|
Policies?: PolicySummary[];
|
|
3485
3675
|
/**
|
|
3676
|
+
* @public
|
|
3486
3677
|
* <p>If present, indicates that more output is available than is
|
|
3487
3678
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3488
3679
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3495,6 +3686,7 @@ export interface ListPoliciesForTargetResponse {
|
|
|
3495
3686
|
*/
|
|
3496
3687
|
export interface ListRootsRequest {
|
|
3497
3688
|
/**
|
|
3689
|
+
* @public
|
|
3498
3690
|
* <p>The parameter for receiving additional results if you receive a
|
|
3499
3691
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3500
3692
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3503,6 +3695,7 @@ export interface ListRootsRequest {
|
|
|
3503
3695
|
*/
|
|
3504
3696
|
NextToken?: string;
|
|
3505
3697
|
/**
|
|
3698
|
+
* @public
|
|
3506
3699
|
* <p>The total number of results that you want included on each page of the
|
|
3507
3700
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3508
3701
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3519,10 +3712,12 @@ export interface ListRootsRequest {
|
|
|
3519
3712
|
*/
|
|
3520
3713
|
export interface ListRootsResponse {
|
|
3521
3714
|
/**
|
|
3715
|
+
* @public
|
|
3522
3716
|
* <p>A list of roots that are defined in an organization.</p>
|
|
3523
3717
|
*/
|
|
3524
3718
|
Roots?: Root[];
|
|
3525
3719
|
/**
|
|
3720
|
+
* @public
|
|
3526
3721
|
* <p>If present, indicates that more output is available than is
|
|
3527
3722
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3528
3723
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3535,6 +3730,7 @@ export interface ListRootsResponse {
|
|
|
3535
3730
|
*/
|
|
3536
3731
|
export interface ListTagsForResourceRequest {
|
|
3537
3732
|
/**
|
|
3733
|
+
* @public
|
|
3538
3734
|
* <p>The ID of the resource with the tags to list.</p>
|
|
3539
3735
|
* <p>You can specify any of the following taggable resources.</p>
|
|
3540
3736
|
* <ul>
|
|
@@ -3563,6 +3759,7 @@ export interface ListTagsForResourceRequest {
|
|
|
3563
3759
|
*/
|
|
3564
3760
|
ResourceId: string | undefined;
|
|
3565
3761
|
/**
|
|
3762
|
+
* @public
|
|
3566
3763
|
* <p>The parameter for receiving additional results if you receive a
|
|
3567
3764
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3568
3765
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3576,10 +3773,12 @@ export interface ListTagsForResourceRequest {
|
|
|
3576
3773
|
*/
|
|
3577
3774
|
export interface ListTagsForResourceResponse {
|
|
3578
3775
|
/**
|
|
3776
|
+
* @public
|
|
3579
3777
|
* <p>The tags that are assigned to the resource.</p>
|
|
3580
3778
|
*/
|
|
3581
3779
|
Tags?: Tag[];
|
|
3582
3780
|
/**
|
|
3781
|
+
* @public
|
|
3583
3782
|
* <p>If present, indicates that more output is available than is
|
|
3584
3783
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3585
3784
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3592,12 +3791,14 @@ export interface ListTagsForResourceResponse {
|
|
|
3592
3791
|
*/
|
|
3593
3792
|
export interface ListTargetsForPolicyRequest {
|
|
3594
3793
|
/**
|
|
3794
|
+
* @public
|
|
3595
3795
|
* <p>The unique identifier (ID) of the policy whose attachments you want to know.</p>
|
|
3596
3796
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed
|
|
3597
3797
|
* by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).</p>
|
|
3598
3798
|
*/
|
|
3599
3799
|
PolicyId: string | undefined;
|
|
3600
3800
|
/**
|
|
3801
|
+
* @public
|
|
3601
3802
|
* <p>The parameter for receiving additional results if you receive a
|
|
3602
3803
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
3603
3804
|
* indicates that more output is available. Set this parameter to the value of the previous
|
|
@@ -3606,6 +3807,7 @@ export interface ListTargetsForPolicyRequest {
|
|
|
3606
3807
|
*/
|
|
3607
3808
|
NextToken?: string;
|
|
3608
3809
|
/**
|
|
3810
|
+
* @public
|
|
3609
3811
|
* <p>The total number of results that you want included on each page of the
|
|
3610
3812
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
3611
3813
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -3636,6 +3838,7 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
|
|
|
3636
3838
|
*/
|
|
3637
3839
|
export interface PolicyTargetSummary {
|
|
3638
3840
|
/**
|
|
3841
|
+
* @public
|
|
3639
3842
|
* <p>The unique identifier (ID) of the policy target.</p>
|
|
3640
3843
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the
|
|
3641
3844
|
* following:</p>
|
|
@@ -3659,12 +3862,14 @@ export interface PolicyTargetSummary {
|
|
|
3659
3862
|
*/
|
|
3660
3863
|
TargetId?: string;
|
|
3661
3864
|
/**
|
|
3865
|
+
* @public
|
|
3662
3866
|
* <p>The Amazon Resource Name (ARN) of the policy target.</p>
|
|
3663
3867
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
3664
3868
|
* Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>
|
|
3665
3869
|
*/
|
|
3666
3870
|
Arn?: string;
|
|
3667
3871
|
/**
|
|
3872
|
+
* @public
|
|
3668
3873
|
* <p>The friendly name of the policy target.</p>
|
|
3669
3874
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
3670
3875
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -3672,6 +3877,7 @@ export interface PolicyTargetSummary {
|
|
|
3672
3877
|
*/
|
|
3673
3878
|
Name?: string;
|
|
3674
3879
|
/**
|
|
3880
|
+
* @public
|
|
3675
3881
|
* <p>The type of the policy target.</p>
|
|
3676
3882
|
*/
|
|
3677
3883
|
Type?: TargetType | string;
|
|
@@ -3681,11 +3887,13 @@ export interface PolicyTargetSummary {
|
|
|
3681
3887
|
*/
|
|
3682
3888
|
export interface ListTargetsForPolicyResponse {
|
|
3683
3889
|
/**
|
|
3890
|
+
* @public
|
|
3684
3891
|
* <p>A list of structures, each of which contains details about one of the entities to
|
|
3685
3892
|
* which the specified policy is attached.</p>
|
|
3686
3893
|
*/
|
|
3687
3894
|
Targets?: PolicyTargetSummary[];
|
|
3688
3895
|
/**
|
|
3896
|
+
* @public
|
|
3689
3897
|
* <p>If present, indicates that more output is available than is
|
|
3690
3898
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
3691
3899
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -3725,12 +3933,14 @@ export declare class DuplicateAccountException extends __BaseException {
|
|
|
3725
3933
|
*/
|
|
3726
3934
|
export interface MoveAccountRequest {
|
|
3727
3935
|
/**
|
|
3936
|
+
* @public
|
|
3728
3937
|
* <p>The unique identifier (ID) of the account that you want to move.</p>
|
|
3729
3938
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12
|
|
3730
3939
|
* digits.</p>
|
|
3731
3940
|
*/
|
|
3732
3941
|
AccountId: string | undefined;
|
|
3733
3942
|
/**
|
|
3943
|
+
* @public
|
|
3734
3944
|
* <p>The unique identifier (ID) of the root or organizational unit that you want to move
|
|
3735
3945
|
* the account from.</p>
|
|
3736
3946
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the
|
|
@@ -3751,6 +3961,7 @@ export interface MoveAccountRequest {
|
|
|
3751
3961
|
*/
|
|
3752
3962
|
SourceParentId: string | undefined;
|
|
3753
3963
|
/**
|
|
3964
|
+
* @public
|
|
3754
3965
|
* <p>The unique identifier (ID) of the root or organizational unit that you want to move
|
|
3755
3966
|
* the account to.</p>
|
|
3756
3967
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the
|
|
@@ -3790,6 +4001,7 @@ export declare class SourceParentNotFoundException extends __BaseException {
|
|
|
3790
4001
|
*/
|
|
3791
4002
|
export interface PutResourcePolicyRequest {
|
|
3792
4003
|
/**
|
|
4004
|
+
* @public
|
|
3793
4005
|
* <p>If provided, the new content for the resource policy. The text must be correctly
|
|
3794
4006
|
* formatted JSON that complies with the syntax for the resource policy's type. For more
|
|
3795
4007
|
* information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html">Service Control Policy Syntax</a> in the
|
|
@@ -3798,6 +4010,7 @@ export interface PutResourcePolicyRequest {
|
|
|
3798
4010
|
*/
|
|
3799
4011
|
Content: string | undefined;
|
|
3800
4012
|
/**
|
|
4013
|
+
* @public
|
|
3801
4014
|
* <p>A list of tags that you want to attach to the newly created resource policy. For each
|
|
3802
4015
|
* tag in the list, you must specify both a tag key and a value. You can set the value to
|
|
3803
4016
|
* an empty string, but you can't set it to <code>null</code>. For more information about
|
|
@@ -3817,6 +4030,7 @@ export interface PutResourcePolicyRequest {
|
|
|
3817
4030
|
*/
|
|
3818
4031
|
export interface PutResourcePolicyResponse {
|
|
3819
4032
|
/**
|
|
4033
|
+
* @public
|
|
3820
4034
|
* <p>A structure that contains details about the resource policy.</p>
|
|
3821
4035
|
*/
|
|
3822
4036
|
ResourcePolicy?: ResourcePolicy;
|
|
@@ -3826,11 +4040,13 @@ export interface PutResourcePolicyResponse {
|
|
|
3826
4040
|
*/
|
|
3827
4041
|
export interface RegisterDelegatedAdministratorRequest {
|
|
3828
4042
|
/**
|
|
4043
|
+
* @public
|
|
3829
4044
|
* <p>The account ID number of the member account in the organization to register as a
|
|
3830
4045
|
* delegated administrator.</p>
|
|
3831
4046
|
*/
|
|
3832
4047
|
AccountId: string | undefined;
|
|
3833
4048
|
/**
|
|
4049
|
+
* @public
|
|
3834
4050
|
* <p>The service principal of the Amazon Web Services service for which you want to make the member
|
|
3835
4051
|
* account a delegated administrator.</p>
|
|
3836
4052
|
*/
|
|
@@ -3841,6 +4057,7 @@ export interface RegisterDelegatedAdministratorRequest {
|
|
|
3841
4057
|
*/
|
|
3842
4058
|
export interface RemoveAccountFromOrganizationRequest {
|
|
3843
4059
|
/**
|
|
4060
|
+
* @public
|
|
3844
4061
|
* <p>The unique identifier (ID) of the member account that you want to remove from the
|
|
3845
4062
|
* organization.</p>
|
|
3846
4063
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12
|
|
@@ -3853,6 +4070,7 @@ export interface RemoveAccountFromOrganizationRequest {
|
|
|
3853
4070
|
*/
|
|
3854
4071
|
export interface TagResourceRequest {
|
|
3855
4072
|
/**
|
|
4073
|
+
* @public
|
|
3856
4074
|
* <p>The ID of the resource to add a tag to.</p>
|
|
3857
4075
|
* <p>You can specify any of the following taggable resources.</p>
|
|
3858
4076
|
* <ul>
|
|
@@ -3881,6 +4099,7 @@ export interface TagResourceRequest {
|
|
|
3881
4099
|
*/
|
|
3882
4100
|
ResourceId: string | undefined;
|
|
3883
4101
|
/**
|
|
4102
|
+
* @public
|
|
3884
4103
|
* <p>A list of tags to add to the specified resource.</p>
|
|
3885
4104
|
* <p>For each tag in the list, you must specify both a tag key and a value. The value can
|
|
3886
4105
|
* be an empty string, but you can't set it to <code>null</code>.</p>
|
|
@@ -3896,6 +4115,7 @@ export interface TagResourceRequest {
|
|
|
3896
4115
|
*/
|
|
3897
4116
|
export interface UntagResourceRequest {
|
|
3898
4117
|
/**
|
|
4118
|
+
* @public
|
|
3899
4119
|
* <p>The ID of the resource to remove a tag from.</p>
|
|
3900
4120
|
* <p>You can specify any of the following taggable resources.</p>
|
|
3901
4121
|
* <ul>
|
|
@@ -3924,6 +4144,7 @@ export interface UntagResourceRequest {
|
|
|
3924
4144
|
*/
|
|
3925
4145
|
ResourceId: string | undefined;
|
|
3926
4146
|
/**
|
|
4147
|
+
* @public
|
|
3927
4148
|
* <p>The list of keys for tags to remove from the specified resource.</p>
|
|
3928
4149
|
*/
|
|
3929
4150
|
TagKeys: string[] | undefined;
|
|
@@ -3933,6 +4154,7 @@ export interface UntagResourceRequest {
|
|
|
3933
4154
|
*/
|
|
3934
4155
|
export interface UpdateOrganizationalUnitRequest {
|
|
3935
4156
|
/**
|
|
4157
|
+
* @public
|
|
3936
4158
|
* <p>The unique identifier (ID) of the OU that you want to rename. You can get the ID from
|
|
3937
4159
|
* the <a>ListOrganizationalUnitsForParent</a> operation.</p>
|
|
3938
4160
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires
|
|
@@ -3942,6 +4164,7 @@ export interface UpdateOrganizationalUnitRequest {
|
|
|
3942
4164
|
*/
|
|
3943
4165
|
OrganizationalUnitId: string | undefined;
|
|
3944
4166
|
/**
|
|
4167
|
+
* @public
|
|
3945
4168
|
* <p>The new name that you want to assign to the OU.</p>
|
|
3946
4169
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
3947
4170
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -3954,6 +4177,7 @@ export interface UpdateOrganizationalUnitRequest {
|
|
|
3954
4177
|
*/
|
|
3955
4178
|
export interface UpdateOrganizationalUnitResponse {
|
|
3956
4179
|
/**
|
|
4180
|
+
* @public
|
|
3957
4181
|
* <p>A structure that contains the details about the specified OU, including its new
|
|
3958
4182
|
* name.</p>
|
|
3959
4183
|
*/
|
|
@@ -3964,12 +4188,14 @@ export interface UpdateOrganizationalUnitResponse {
|
|
|
3964
4188
|
*/
|
|
3965
4189
|
export interface UpdatePolicyRequest {
|
|
3966
4190
|
/**
|
|
4191
|
+
* @public
|
|
3967
4192
|
* <p>The unique identifier (ID) of the policy that you want to update.</p>
|
|
3968
4193
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed
|
|
3969
4194
|
* by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).</p>
|
|
3970
4195
|
*/
|
|
3971
4196
|
PolicyId: string | undefined;
|
|
3972
4197
|
/**
|
|
4198
|
+
* @public
|
|
3973
4199
|
* <p>If provided, the new name for the policy.</p>
|
|
3974
4200
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a>
|
|
3975
4201
|
* that is used to validate this parameter is a string of any of the characters in the ASCII
|
|
@@ -3977,10 +4203,12 @@ export interface UpdatePolicyRequest {
|
|
|
3977
4203
|
*/
|
|
3978
4204
|
Name?: string;
|
|
3979
4205
|
/**
|
|
4206
|
+
* @public
|
|
3980
4207
|
* <p>If provided, the new description for the policy.</p>
|
|
3981
4208
|
*/
|
|
3982
4209
|
Description?: string;
|
|
3983
4210
|
/**
|
|
4211
|
+
* @public
|
|
3984
4212
|
* <p>If provided, the new content for the policy. The text must be correctly formatted JSON
|
|
3985
4213
|
* that complies with the syntax for the policy's type. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html">Service
|
|
3986
4214
|
* Control Policy Syntax</a> in the <i>Organizations User Guide.</i>
|
|
@@ -3993,6 +4221,7 @@ export interface UpdatePolicyRequest {
|
|
|
3993
4221
|
*/
|
|
3994
4222
|
export interface UpdatePolicyResponse {
|
|
3995
4223
|
/**
|
|
4224
|
+
* @public
|
|
3996
4225
|
* <p>A structure that contains details about the updated policy, showing the requested
|
|
3997
4226
|
* changes.</p>
|
|
3998
4227
|
*/
|
|
@@ -4004,11 +4233,13 @@ export interface UpdatePolicyResponse {
|
|
|
4004
4233
|
*/
|
|
4005
4234
|
export interface HandshakeResource {
|
|
4006
4235
|
/**
|
|
4236
|
+
* @public
|
|
4007
4237
|
* <p>The information that is passed to the other party in the handshake. The format of the
|
|
4008
4238
|
* value string must match the requirements of the specified type.</p>
|
|
4009
4239
|
*/
|
|
4010
4240
|
Value?: string;
|
|
4011
4241
|
/**
|
|
4242
|
+
* @public
|
|
4012
4243
|
* <p>The type of information being passed, specifying how the value is to be interpreted by
|
|
4013
4244
|
* the other party:</p>
|
|
4014
4245
|
* <ul>
|
|
@@ -4044,6 +4275,7 @@ export interface HandshakeResource {
|
|
|
4044
4275
|
*/
|
|
4045
4276
|
Type?: HandshakeResourceType | string;
|
|
4046
4277
|
/**
|
|
4278
|
+
* @public
|
|
4047
4279
|
* <p>When needed, contains an additional array of <code>HandshakeResource</code>
|
|
4048
4280
|
* objects.</p>
|
|
4049
4281
|
*/
|
|
@@ -4063,6 +4295,7 @@ export interface HandshakeResource {
|
|
|
4063
4295
|
*/
|
|
4064
4296
|
export interface Handshake {
|
|
4065
4297
|
/**
|
|
4298
|
+
* @public
|
|
4066
4299
|
* <p>The unique identifier (ID) of a handshake. The originating account creates the ID when
|
|
4067
4300
|
* it initiates the handshake.</p>
|
|
4068
4301
|
* <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-"
|
|
@@ -4070,16 +4303,19 @@ export interface Handshake {
|
|
|
4070
4303
|
*/
|
|
4071
4304
|
Id?: string;
|
|
4072
4305
|
/**
|
|
4306
|
+
* @public
|
|
4073
4307
|
* <p>The Amazon Resource Name (ARN) of a handshake.</p>
|
|
4074
4308
|
* <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN
|
|
4075
4309
|
* Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>
|
|
4076
4310
|
*/
|
|
4077
4311
|
Arn?: string;
|
|
4078
4312
|
/**
|
|
4313
|
+
* @public
|
|
4079
4314
|
* <p>Information about the two accounts that are participating in the handshake.</p>
|
|
4080
4315
|
*/
|
|
4081
4316
|
Parties?: HandshakeParty[];
|
|
4082
4317
|
/**
|
|
4318
|
+
* @public
|
|
4083
4319
|
* <p>The current state of the handshake. Use the state to trace the flow of the handshake
|
|
4084
4320
|
* through the process from its creation to its acceptance. The meaning of each of the
|
|
4085
4321
|
* valid values is as follows:</p>
|
|
@@ -4122,16 +4358,19 @@ export interface Handshake {
|
|
|
4122
4358
|
*/
|
|
4123
4359
|
State?: HandshakeState | string;
|
|
4124
4360
|
/**
|
|
4361
|
+
* @public
|
|
4125
4362
|
* <p>The date and time that the handshake request was made.</p>
|
|
4126
4363
|
*/
|
|
4127
4364
|
RequestedTimestamp?: Date;
|
|
4128
4365
|
/**
|
|
4366
|
+
* @public
|
|
4129
4367
|
* <p>The date and time that the handshake expires. If the recipient of the handshake
|
|
4130
4368
|
* request fails to respond before the specified date and time, the handshake becomes
|
|
4131
4369
|
* inactive and is no longer valid.</p>
|
|
4132
4370
|
*/
|
|
4133
4371
|
ExpirationTimestamp?: Date;
|
|
4134
4372
|
/**
|
|
4373
|
+
* @public
|
|
4135
4374
|
* <p>The type of handshake, indicating what action occurs when the recipient accepts the
|
|
4136
4375
|
* handshake. The following handshake types are supported:</p>
|
|
4137
4376
|
* <ul>
|
|
@@ -4162,6 +4401,7 @@ export interface Handshake {
|
|
|
4162
4401
|
*/
|
|
4163
4402
|
Action?: ActionType | string;
|
|
4164
4403
|
/**
|
|
4404
|
+
* @public
|
|
4165
4405
|
* <p>Additional information that is needed to process the handshake.</p>
|
|
4166
4406
|
*/
|
|
4167
4407
|
Resources?: HandshakeResource[];
|
|
@@ -4171,6 +4411,7 @@ export interface Handshake {
|
|
|
4171
4411
|
*/
|
|
4172
4412
|
export interface AcceptHandshakeResponse {
|
|
4173
4413
|
/**
|
|
4414
|
+
* @public
|
|
4174
4415
|
* <p>A structure that contains details about the accepted handshake.</p>
|
|
4175
4416
|
*/
|
|
4176
4417
|
Handshake?: Handshake;
|
|
@@ -4180,6 +4421,7 @@ export interface AcceptHandshakeResponse {
|
|
|
4180
4421
|
*/
|
|
4181
4422
|
export interface CancelHandshakeResponse {
|
|
4182
4423
|
/**
|
|
4424
|
+
* @public
|
|
4183
4425
|
* <p>A structure that contains details about the handshake that you canceled.</p>
|
|
4184
4426
|
*/
|
|
4185
4427
|
Handshake?: Handshake;
|
|
@@ -4189,6 +4431,7 @@ export interface CancelHandshakeResponse {
|
|
|
4189
4431
|
*/
|
|
4190
4432
|
export interface DeclineHandshakeResponse {
|
|
4191
4433
|
/**
|
|
4434
|
+
* @public
|
|
4192
4435
|
* <p>A structure that contains details about the declined handshake. The state is updated
|
|
4193
4436
|
* to show the value <code>DECLINED</code>.</p>
|
|
4194
4437
|
*/
|
|
@@ -4199,6 +4442,7 @@ export interface DeclineHandshakeResponse {
|
|
|
4199
4442
|
*/
|
|
4200
4443
|
export interface DescribeHandshakeResponse {
|
|
4201
4444
|
/**
|
|
4445
|
+
* @public
|
|
4202
4446
|
* <p>A structure that contains information about the specified handshake.</p>
|
|
4203
4447
|
*/
|
|
4204
4448
|
Handshake?: Handshake;
|
|
@@ -4208,6 +4452,7 @@ export interface DescribeHandshakeResponse {
|
|
|
4208
4452
|
*/
|
|
4209
4453
|
export interface EnableAllFeaturesResponse {
|
|
4210
4454
|
/**
|
|
4455
|
+
* @public
|
|
4211
4456
|
* <p>A structure that contains details about the handshake created to support this request
|
|
4212
4457
|
* to enable all features in the organization.</p>
|
|
4213
4458
|
*/
|
|
@@ -4218,6 +4463,7 @@ export interface EnableAllFeaturesResponse {
|
|
|
4218
4463
|
*/
|
|
4219
4464
|
export interface InviteAccountToOrganizationResponse {
|
|
4220
4465
|
/**
|
|
4466
|
+
* @public
|
|
4221
4467
|
* <p>A structure that contains details about the handshake that is created to support this
|
|
4222
4468
|
* invitation request.</p>
|
|
4223
4469
|
*/
|
|
@@ -4228,11 +4474,13 @@ export interface InviteAccountToOrganizationResponse {
|
|
|
4228
4474
|
*/
|
|
4229
4475
|
export interface ListHandshakesForAccountResponse {
|
|
4230
4476
|
/**
|
|
4477
|
+
* @public
|
|
4231
4478
|
* <p>A list of <a>Handshake</a> objects with details about each of the
|
|
4232
4479
|
* handshakes that is associated with the specified account.</p>
|
|
4233
4480
|
*/
|
|
4234
4481
|
Handshakes?: Handshake[];
|
|
4235
4482
|
/**
|
|
4483
|
+
* @public
|
|
4236
4484
|
* <p>If present, indicates that more output is available than is
|
|
4237
4485
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
4238
4486
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -4245,11 +4493,13 @@ export interface ListHandshakesForAccountResponse {
|
|
|
4245
4493
|
*/
|
|
4246
4494
|
export interface ListHandshakesForOrganizationResponse {
|
|
4247
4495
|
/**
|
|
4496
|
+
* @public
|
|
4248
4497
|
* <p>A list of <a>Handshake</a> objects with details about each of the
|
|
4249
4498
|
* handshakes that are associated with an organization.</p>
|
|
4250
4499
|
*/
|
|
4251
4500
|
Handshakes?: Handshake[];
|
|
4252
4501
|
/**
|
|
4502
|
+
* @public
|
|
4253
4503
|
* <p>If present, indicates that more output is available than is
|
|
4254
4504
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
4255
4505
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|