@aws-sdk/client-organizations 3.321.1 → 3.326.0

package/dist-types/commands/DescribeResourcePolicyCommand.d.ts

@@ -31,6 +31,16 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
  * const input = {};
  * const command = new DescribeResourcePolicyCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeResourcePolicyResponse
+ * //   ResourcePolicy: { // ResourcePolicy
+ * //     ResourcePolicySummary: { // ResourcePolicySummary
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //     },
+ * //     Content: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeResourcePolicyCommandInput - {@link DescribeResourcePolicyCommandInput}
@@ -264,6 +274,8 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  */
 export declare class DescribeResourcePolicyCommand extends $Command<DescribeResourcePolicyCommandInput, DescribeResourcePolicyCommandOutput, OrganizationsClientResolvedConfig> {

package/dist-types/commands/DetachPolicyCommand.d.ts

@@ -46,6 +46,8 @@ export interface DetachPolicyCommandOutput extends __MetadataBearer {
  * };
  * const command = new DetachPolicyCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DetachPolicyCommandInput - {@link DetachPolicyCommandInput}
@@ -398,6 +400,8 @@ export interface DetachPolicyCommandOutput extends __MetadataBearer {
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To detach a policy from a root, OU, or account
  * ```javascript

package/dist-types/commands/DisableAWSServiceAccessCommand.d.ts

@@ -86,6 +86,8 @@ export interface DisableAWSServiceAccessCommandOutput extends __MetadataBearer {
  * };
  * const command = new DisableAWSServiceAccessCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisableAWSServiceAccessCommandInput - {@link DisableAWSServiceAccessCommandInput}
@@ -424,6 +426,8 @@ export interface DisableAWSServiceAccessCommandOutput extends __MetadataBearer {
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  */
 export declare class DisableAWSServiceAccessCommand extends $Command<DisableAWSServiceAccessCommandInput, DisableAWSServiceAccessCommandOutput, OrganizationsClientResolvedConfig> {

package/dist-types/commands/DisablePolicyTypeCommand.d.ts

@@ -42,6 +42,20 @@ export interface DisablePolicyTypeCommandOutput extends DisablePolicyTypeRespons
  * };
  * const command = new DisablePolicyTypeCommand(input);
  * const response = await client.send(command);
+ * // { // DisablePolicyTypeResponse
+ * //   Root: { // Root
+ * //     Id: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     PolicyTypes: [ // PolicyTypes
+ * //       { // PolicyTypeSummary
+ * //         Type: "SERVICE_CONTROL_POLICY" || "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
+ * //         Status: "ENABLED" || "PENDING_ENABLE" || "PENDING_DISABLE",
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DisablePolicyTypeCommandInput - {@link DisablePolicyTypeCommandInput}
@@ -394,6 +408,8 @@ export interface DisablePolicyTypeCommandOutput extends DisablePolicyTypeRespons
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To disable a policy type in a root
  * ```javascript

package/dist-types/commands/EnableAWSServiceAccessCommand.d.ts

@@ -50,6 +50,8 @@ export interface EnableAWSServiceAccessCommandOutput extends __MetadataBearer {
  * };
  * const command = new EnableAWSServiceAccessCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param EnableAWSServiceAccessCommandInput - {@link EnableAWSServiceAccessCommandInput}
@@ -388,6 +390,8 @@ export interface EnableAWSServiceAccessCommandOutput extends __MetadataBearer {
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  */
 export declare class EnableAWSServiceAccessCommand extends $Command<EnableAWSServiceAccessCommandInput, EnableAWSServiceAccessCommandOutput, OrganizationsClientResolvedConfig> {

package/dist-types/commands/EnableAllFeaturesCommand.d.ts

@@ -54,6 +54,36 @@ export interface EnableAllFeaturesCommandOutput extends EnableAllFeaturesRespons
  * const input = {};
  * const command = new EnableAllFeaturesCommand(input);
  * const response = await client.send(command);
+ * // { // EnableAllFeaturesResponse
+ * //   Handshake: { // Handshake
+ * //     Id: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     Parties: [ // HandshakeParties
+ * //       { // HandshakeParty
+ * //         Id: "STRING_VALUE", // required
+ * //         Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
+ * //       },
+ * //     ],
+ * //     State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
+ * //     RequestedTimestamp: new Date("TIMESTAMP"),
+ * //     ExpirationTimestamp: new Date("TIMESTAMP"),
+ * //     Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
+ * //     Resources: [ // HandshakeResources
+ * //       { // HandshakeResource
+ * //         Value: "STRING_VALUE",
+ * //         Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //         Resources: [
+ * //           {
+ * //             Value: "STRING_VALUE",
+ * //             Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //             Resources: "<HandshakeResources>",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param EnableAllFeaturesCommandInput - {@link EnableAllFeaturesCommandInput}
@@ -251,6 +281,8 @@ export interface EnableAllFeaturesCommandOutput extends EnableAllFeaturesRespons
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To enable all features in an organization
  * ```javascript

package/dist-types/commands/EnablePolicyTypeCommand.d.ts

@@ -42,6 +42,20 @@ export interface EnablePolicyTypeCommandOutput extends EnablePolicyTypeResponse,
  * };
  * const command = new EnablePolicyTypeCommand(input);
  * const response = await client.send(command);
+ * // { // EnablePolicyTypeResponse
+ * //   Root: { // Root
+ * //     Id: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     PolicyTypes: [ // PolicyTypes
+ * //       { // PolicyTypeSummary
+ * //         Type: "SERVICE_CONTROL_POLICY" || "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
+ * //         Status: "ENABLED" || "PENDING_ENABLE" || "PENDING_DISABLE",
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param EnablePolicyTypeCommandInput - {@link EnablePolicyTypeCommandInput}
@@ -397,6 +411,8 @@ export interface EnablePolicyTypeCommandOutput extends EnablePolicyTypeResponse,
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To enable a policy type in a root
  * ```javascript

package/dist-types/commands/InviteAccountToOrganizationCommand.d.ts

@@ -66,6 +66,36 @@ export interface InviteAccountToOrganizationCommandOutput extends InviteAccountT
  * };
  * const command = new InviteAccountToOrganizationCommand(input);
  * const response = await client.send(command);
+ * // { // InviteAccountToOrganizationResponse
+ * //   Handshake: { // Handshake
+ * //     Id: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     Parties: [ // HandshakeParties
+ * //       { // HandshakeParty
+ * //         Id: "STRING_VALUE", // required
+ * //         Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
+ * //       },
+ * //     ],
+ * //     State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
+ * //     RequestedTimestamp: new Date("TIMESTAMP"),
+ * //     ExpirationTimestamp: new Date("TIMESTAMP"),
+ * //     Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
+ * //     Resources: [ // HandshakeResources
+ * //       { // HandshakeResource
+ * //         Value: "STRING_VALUE",
+ * //         Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //         Resources: [
+ * //           {
+ * //             Value: "STRING_VALUE",
+ * //             Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //             Resources: "<HandshakeResources>",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param InviteAccountToOrganizationCommandInput - {@link InviteAccountToOrganizationCommandInput}
@@ -479,6 +509,8 @@ export interface InviteAccountToOrganizationCommandOutput extends InviteAccountT
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To invite an account to join an organization
  * ```javascript

package/dist-types/commands/LeaveOrganizationCommand.d.ts

@@ -92,6 +92,8 @@ export interface LeaveOrganizationCommandOutput extends __MetadataBearer {
  * const input = {};
  * const command = new LeaveOrganizationCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param LeaveOrganizationCommandInput - {@link LeaveOrganizationCommandInput}
@@ -437,6 +439,8 @@ export interface LeaveOrganizationCommandOutput extends __MetadataBearer {
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To leave an organization as a member account
  * ```javascript

package/dist-types/commands/ListAWSServiceAccessForOrganizationCommand.d.ts

@@ -40,6 +40,16 @@ export interface ListAWSServiceAccessForOrganizationCommandOutput extends ListAW
  * };
  * const command = new ListAWSServiceAccessForOrganizationCommand(input);
  * const response = await client.send(command);
+ * // { // ListAWSServiceAccessForOrganizationResponse
+ * //   EnabledServicePrincipals: [ // EnabledServicePrincipals
+ * //     { // EnabledServicePrincipal
+ * //       ServicePrincipal: "STRING_VALUE",
+ * //       DateEnabled: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListAWSServiceAccessForOrganizationCommandInput - {@link ListAWSServiceAccessForOrganizationCommandInput}
@@ -374,6 +384,8 @@ export interface ListAWSServiceAccessForOrganizationCommandOutput extends ListAW
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  */
 export declare class ListAWSServiceAccessForOrganizationCommand extends $Command<ListAWSServiceAccessForOrganizationCommandInput, ListAWSServiceAccessForOrganizationCommandOutput, OrganizationsClientResolvedConfig> {

package/dist-types/commands/ListAccountsCommand.d.ts

@@ -43,6 +43,21 @@ export interface ListAccountsCommandOutput extends ListAccountsResponse, __Metad
  * };
  * const command = new ListAccountsCommand(input);
  * const response = await client.send(command);
+ * // { // ListAccountsResponse
+ * //   Accounts: [ // Accounts
+ * //     { // Account
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Email: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Status: "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE",
+ * //       JoinedMethod: "INVITED" || "CREATED",
+ * //       JoinedTimestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListAccountsCommandInput - {@link ListAccountsCommandInput}
@@ -177,6 +192,8 @@ export interface ListAccountsCommandOutput extends ListAccountsResponse, __Metad
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list of all of the accounts in an organization
  * ```javascript

package/dist-types/commands/ListAccountsForParentCommand.d.ts

@@ -47,6 +47,21 @@ export interface ListAccountsForParentCommandOutput extends ListAccountsForParen
  * };
  * const command = new ListAccountsForParentCommand(input);
  * const response = await client.send(command);
+ * // { // ListAccountsForParentResponse
+ * //   Accounts: [ // Accounts
+ * //     { // Account
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Email: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Status: "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE",
+ * //       JoinedMethod: "INVITED" || "CREATED",
+ * //       JoinedTimestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListAccountsForParentCommandInput - {@link ListAccountsForParentCommandInput}
@@ -184,6 +199,8 @@ export interface ListAccountsForParentCommandOutput extends ListAccountsForParen
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list of all of the accounts in a root or OU
  * ```javascript

package/dist-types/commands/ListChildrenCommand.d.ts

@@ -46,6 +46,16 @@ export interface ListChildrenCommandOutput extends ListChildrenResponse, __Metad
  * };
  * const command = new ListChildrenCommand(input);
  * const response = await client.send(command);
+ * // { // ListChildrenResponse
+ * //   Children: [ // Children
+ * //     { // Child
+ * //       Id: "STRING_VALUE",
+ * //       Type: "ACCOUNT" || "ORGANIZATIONAL_UNIT",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListChildrenCommandInput - {@link ListChildrenCommandInput}
@@ -183,6 +193,8 @@ export interface ListChildrenCommandOutput extends ListChildrenResponse, __Metad
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list of all of the child accounts and OUs in a parent root or OU
  * ```javascript

package/dist-types/commands/ListCreateAccountStatusCommand.d.ts

@@ -46,6 +46,22 @@ export interface ListCreateAccountStatusCommandOutput extends ListCreateAccountS
  * };
  * const command = new ListCreateAccountStatusCommand(input);
  * const response = await client.send(command);
+ * // { // ListCreateAccountStatusResponse
+ * //   CreateAccountStatuses: [ // CreateAccountStatuses
+ * //     { // CreateAccountStatus
+ * //       Id: "STRING_VALUE",
+ * //       AccountName: "STRING_VALUE",
+ * //       State: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
+ * //       RequestedTimestamp: new Date("TIMESTAMP"),
+ * //       CompletedTimestamp: new Date("TIMESTAMP"),
+ * //       AccountId: "STRING_VALUE",
+ * //       GovCloudAccountId: "STRING_VALUE",
+ * //       FailureReason: "ACCOUNT_LIMIT_EXCEEDED" || "EMAIL_ALREADY_EXISTS" || "INVALID_ADDRESS" || "INVALID_EMAIL" || "CONCURRENT_ACCOUNT_MODIFICATION" || "INTERNAL_FAILURE" || "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" || "MISSING_BUSINESS_VALIDATION" || "FAILED_BUSINESS_VALIDATION" || "PENDING_BUSINESS_VALIDATION" || "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION" || "UNKNOWN_BUSINESS_VALIDATION" || "MISSING_PAYMENT_INSTRUMENT" || "INVALID_PAYMENT_INSTRUMENT" || "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListCreateAccountStatusCommandInput - {@link ListCreateAccountStatusCommandInput}
@@ -183,6 +199,8 @@ export interface ListCreateAccountStatusCommandOutput extends ListCreateAccountS
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To get a list of completed account creation requests made in the organization
  * ```javascript

package/dist-types/commands/ListDelegatedAdministratorsCommand.d.ts

@@ -36,6 +36,22 @@ export interface ListDelegatedAdministratorsCommandOutput extends ListDelegatedA
  * };
  * const command = new ListDelegatedAdministratorsCommand(input);
  * const response = await client.send(command);
+ * // { // ListDelegatedAdministratorsResponse
+ * //   DelegatedAdministrators: [ // DelegatedAdministrators
+ * //     { // DelegatedAdministrator
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Email: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Status: "ACTIVE" || "SUSPENDED" || "PENDING_CLOSURE",
+ * //       JoinedMethod: "INVITED" || "CREATED",
+ * //       JoinedTimestamp: new Date("TIMESTAMP"),
+ * //       DelegationEnabledDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListDelegatedAdministratorsCommandInput - {@link ListDelegatedAdministratorsCommandInput}
@@ -370,6 +386,8 @@ export interface ListDelegatedAdministratorsCommandOutput extends ListDelegatedA
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  */
 export declare class ListDelegatedAdministratorsCommand extends $Command<ListDelegatedAdministratorsCommandInput, ListDelegatedAdministratorsCommandOutput, OrganizationsClientResolvedConfig> {

package/dist-types/commands/ListDelegatedServicesForAccountCommand.d.ts

@@ -36,6 +36,16 @@ export interface ListDelegatedServicesForAccountCommandOutput extends ListDelega
  * };
  * const command = new ListDelegatedServicesForAccountCommand(input);
  * const response = await client.send(command);
+ * // { // ListDelegatedServicesForAccountResponse
+ * //   DelegatedServices: [ // DelegatedServices
+ * //     { // DelegatedService
+ * //       ServicePrincipal: "STRING_VALUE",
+ * //       DelegationEnabledDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListDelegatedServicesForAccountCommandInput - {@link ListDelegatedServicesForAccountCommandInput}
@@ -378,6 +388,8 @@ export interface ListDelegatedServicesForAccountCommandOutput extends ListDelega
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  */
 export declare class ListDelegatedServicesForAccountCommand extends $Command<ListDelegatedServicesForAccountCommandInput, ListDelegatedServicesForAccountCommandOutput, OrganizationsClientResolvedConfig> {

package/dist-types/commands/ListHandshakesForAccountCommand.d.ts

@@ -50,6 +50,39 @@ export interface ListHandshakesForAccountCommandOutput extends ListHandshakesFor
  * };
  * const command = new ListHandshakesForAccountCommand(input);
  * const response = await client.send(command);
+ * // { // ListHandshakesForAccountResponse
+ * //   Handshakes: [ // Handshakes
+ * //     { // Handshake
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Parties: [ // HandshakeParties
+ * //         { // HandshakeParty
+ * //           Id: "STRING_VALUE", // required
+ * //           Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
+ * //         },
+ * //       ],
+ * //       State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
+ * //       RequestedTimestamp: new Date("TIMESTAMP"),
+ * //       ExpirationTimestamp: new Date("TIMESTAMP"),
+ * //       Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
+ * //       Resources: [ // HandshakeResources
+ * //         { // HandshakeResource
+ * //           Value: "STRING_VALUE",
+ * //           Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //           Resources: [
+ * //             {
+ * //               Value: "STRING_VALUE",
+ * //               Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //               Resources: "<HandshakeResources>",
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListHandshakesForAccountCommandInput - {@link ListHandshakesForAccountCommandInput}
@@ -184,6 +217,8 @@ export interface ListHandshakesForAccountCommandOutput extends ListHandshakesFor
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list of the handshakes sent to an account
  * ```javascript

package/dist-types/commands/ListHandshakesForOrganizationCommand.d.ts

@@ -53,6 +53,39 @@ export interface ListHandshakesForOrganizationCommandOutput extends ListHandshak
  * };
  * const command = new ListHandshakesForOrganizationCommand(input);
  * const response = await client.send(command);
+ * // { // ListHandshakesForOrganizationResponse
+ * //   Handshakes: [ // Handshakes
+ * //     { // Handshake
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Parties: [ // HandshakeParties
+ * //         { // HandshakeParty
+ * //           Id: "STRING_VALUE", // required
+ * //           Type: "ACCOUNT" || "ORGANIZATION" || "EMAIL", // required
+ * //         },
+ * //       ],
+ * //       State: "REQUESTED" || "OPEN" || "CANCELED" || "ACCEPTED" || "DECLINED" || "EXPIRED",
+ * //       RequestedTimestamp: new Date("TIMESTAMP"),
+ * //       ExpirationTimestamp: new Date("TIMESTAMP"),
+ * //       Action: "INVITE" || "ENABLE_ALL_FEATURES" || "APPROVE_ALL_FEATURES" || "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
+ * //       Resources: [ // HandshakeResources
+ * //         { // HandshakeResource
+ * //           Value: "STRING_VALUE",
+ * //           Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //           Resources: [
+ * //             {
+ * //               Value: "STRING_VALUE",
+ * //               Type: "ACCOUNT" || "ORGANIZATION" || "ORGANIZATION_FEATURE_SET" || "EMAIL" || "MASTER_EMAIL" || "MASTER_NAME" || "NOTES" || "PARENT_HANDSHAKE",
+ * //               Resources: "<HandshakeResources>",
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListHandshakesForOrganizationCommandInput - {@link ListHandshakesForOrganizationCommandInput}
@@ -191,6 +224,8 @@ export interface ListHandshakesForOrganizationCommandOutput extends ListHandshak
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list of the handshakes associated with an organization
  * ```javascript

package/dist-types/commands/ListOrganizationalUnitsForParentCommand.d.ts

@@ -43,6 +43,17 @@ export interface ListOrganizationalUnitsForParentCommandOutput extends ListOrgan
  * };
  * const command = new ListOrganizationalUnitsForParentCommand(input);
  * const response = await client.send(command);
+ * // { // ListOrganizationalUnitsForParentResponse
+ * //   OrganizationalUnits: [ // OrganizationalUnits
+ * //     { // OrganizationalUnit
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListOrganizationalUnitsForParentCommandInput - {@link ListOrganizationalUnitsForParentCommandInput}
@@ -180,6 +191,8 @@ export interface ListOrganizationalUnitsForParentCommandOutput extends ListOrgan
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list of all of the child OUs in a parent root or OU
  * ```javascript

package/dist-types/commands/ListParentsCommand.d.ts

@@ -48,6 +48,16 @@ export interface ListParentsCommandOutput extends ListParentsResponse, __Metadat
  * };
  * const command = new ListParentsCommand(input);
  * const response = await client.send(command);
+ * // { // ListParentsResponse
+ * //   Parents: [ // Parents
+ * //     { // Parent
+ * //       Id: "STRING_VALUE",
+ * //       Type: "ROOT" || "ORGANIZATIONAL_UNIT",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListParentsCommandInput - {@link ListParentsCommandInput}
@@ -186,6 +196,8 @@ export interface ListParentsCommandOutput extends ListParentsResponse, __Metadat
  *                 <i>Organizations User Guide.</i>
  *          </p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list of all of the parents of a child OU or account
  * ```javascript

package/dist-types/commands/ListPoliciesCommand.d.ts

@@ -43,6 +43,20 @@ export interface ListPoliciesCommandOutput extends ListPoliciesResponse, __Metad
  * };
  * const command = new ListPoliciesCommand(input);
  * const response = await client.send(command);
+ * // { // ListPoliciesResponse
+ * //   Policies: [ // Policies
+ * //     { // PolicySummary
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       Type: "SERVICE_CONTROL_POLICY" || "TAG_POLICY" || "BACKUP_POLICY" || "AISERVICES_OPT_OUT_POLICY",
+ * //       AwsManaged: true || false,
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListPoliciesCommandInput - {@link ListPoliciesCommandInput}
@@ -180,6 +194,8 @@ export interface ListPoliciesCommandOutput extends ListPoliciesResponse, __Metad
  * @throws {@link UnsupportedAPIEndpointException} (client fault)
  *  <p>This action isn't available in the current Amazon Web Services Region.</p>
  *
+ * @throws {@link OrganizationsServiceException}
+ * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
  * @example To retrieve a list policies in the organization
  * ```javascript