@aws-sdk/client-organizations 3.775.0 → 3.782.0

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

@@ -321,64 +321,8 @@ declare const AcceptHandshakeCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
- * @example To accept a handshake from another account
- * ```javascript
- * // Bill is the owner of an organization, and he invites Juan's account (222222222222) to join his organization. The following example shows Juan's account accepting the handshake and thus agreeing to the invitation.
- * const input = {
- *   "HandshakeId": "h-examplehandshakeid111"
- * };
- * const command = new AcceptHandshakeCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "Handshake": {
- *     "Action": "INVITE",
- *     "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
- *     "ExpirationTimestamp": "20170228T1215Z",
- *     "Id": "h-examplehandshakeid111",
- *     "Parties": [
- *       {
- *         "Id": "o-exampleorgid",
- *         "Type": "ORGANIZATION"
- *       },
- *       {
- *         "Id": "juan@example.com",
- *         "Type": "EMAIL"
- *       }
- *     ],
- *     "RequestedTimestamp": "20170214T1215Z",
- *     "Resources": [
- *       {
- *         "Resources": [
- *           {
- *             "Type": "MASTER_EMAIL",
- *             "Value": "bill@amazon.com"
- *           },
- *           {
- *             "Type": "MASTER_NAME",
- *             "Value": "Org Master Account"
- *           },
- *           {
- *             "Type": "ORGANIZATION_FEATURE_SET",
- *             "Value": "ALL"
- *           }
- *         ],
- *         "Type": "ORGANIZATION",
- *         "Value": "o-exampleorgid"
- *       },
- *       {
- *         "Type": "ACCOUNT",
- *         "Value": "222222222222"
- *       }
- *     ],
- *     "State": "ACCEPTED"
- *   }
- * }
- * *\/
- * // example id: to-accept-a-handshake-from-another-account-1472500561150
- * ```
  *
+ * @public
  */
 export declare class AcceptHandshakeCommand extends AcceptHandshakeCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -451,33 +451,38 @@ declare const AttachPolicyCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
- * @example To attach a policy to an OU
+ *
+ * @example To attach a policy to an account
  * ```javascript
- * // The following example shows how to attach a service control policy (SCP) to an OU:
- * //
+ * // The following example shows how to attach a service control policy (SCP) to an account:
+ *
  * const input = {
- *   "PolicyId": "p-examplepolicyid111",
- *   "TargetId": "ou-examplerootid111-exampleouid111"
+ *   PolicyId: "p-examplepolicyid111",
+ *   TargetId: "333333333333"
  * };
  * const command = new AttachPolicyCommand(input);
- * await client.send(command);
- * // example id: to-attach-a-policy-to-an-ou
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
- * @example To attach a policy to an account
+ * @example To attach a policy to an OU
  * ```javascript
- * // The following example shows how to attach a service control policy (SCP) to an account:
- * //
+ * // The following example shows how to attach a service control policy (SCP) to an OU:
+ *
  * const input = {
- *   "PolicyId": "p-examplepolicyid111",
- *   "TargetId": "333333333333"
+ *   PolicyId: "p-examplepolicyid111",
+ *   TargetId: "ou-examplerootid111-exampleouid111"
  * };
  * const command = new AttachPolicyCommand(input);
- * await client.send(command);
- * // example id: to-attach-a-policy-to-an-account
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class AttachPolicyCommand extends AttachPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -227,69 +227,8 @@ declare const CancelHandshakeCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
- * @example To cancel a handshake sent to a member account
- * ```javascript
- * // Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:
- * //
- * const input = {
- *   "HandshakeId": "h-examplehandshakeid111"
- * };
- * const command = new CancelHandshakeCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "Handshake": {
- *     "Action": "INVITE",
- *     "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
- *     "ExpirationTimestamp": "20170228T1215Z",
- *     "Id": "h-examplehandshakeid111",
- *     "Parties": [
- *       {
- *         "Id": "o-exampleorgid",
- *         "Type": "ORGANIZATION"
- *       },
- *       {
- *         "Id": "susan@example.com",
- *         "Type": "EMAIL"
- *       }
- *     ],
- *     "RequestedTimestamp": "20170214T1215Z",
- *     "Resources": [
- *       {
- *         "Resources": [
- *           {
- *             "Type": "MASTER_EMAIL",
- *             "Value": "bill@example.com"
- *           },
- *           {
- *             "Type": "MASTER_NAME",
- *             "Value": "Master Account"
- *           },
- *           {
- *             "Type": "ORGANIZATION_FEATURE_SET",
- *             "Value": "CONSOLIDATED_BILLING"
- *           }
- *         ],
- *         "Type": "ORGANIZATION",
- *         "Value": "o-exampleorgid"
- *       },
- *       {
- *         "Type": "ACCOUNT",
- *         "Value": "222222222222"
- *       },
- *       {
- *         "Type": "NOTES",
- *         "Value": "This is a request for Susan's account to join Bob's organization."
- *       }
- *     ],
- *     "State": "CANCELED"
- *   }
- * }
- * *\/
- * // example id: to-cancel-a-handshake-sent-to-a-member-account-1472501320506
- * ```
  *
+ * @public
  */
 export declare class CancelHandshakeCommand extends CancelHandshakeCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -447,6 +447,7 @@ declare const CloseAccountCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
+ *
  * @public
  */
 export declare class CloseAccountCommand extends CloseAccountCommand_base {

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

@@ -485,29 +485,29 @@ declare const CreateAccountCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
+ *
  * @example To create a new account that is automatically part of the organization
  * ```javascript
  * // The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name "Production Account" and an owner email address of susan@example.com.  An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a "Welcome to AWS" email:
- * //
- * //
+ *
+ *
  * const input = {
- *   "AccountName": "Production Account",
- *   "Email": "susan@example.com"
+ *   AccountName: "Production Account",
+ *   Email: "susan@example.com"
  * };
  * const command = new CreateAccountCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CreateAccountStatus": {
- *     "Id": "car-examplecreateaccountrequestid111",
- *     "State": "IN_PROGRESS"
+ *   CreateAccountStatus: {
+ *     Id: "car-examplecreateaccountrequestid111",
+ *     State: "IN_PROGRESS"
  *   }
  * }
  * *\/
- * // example id: to-create-a-new-account-that-is-automatically-part-of-the-organization-1472501463507
  * ```
  *
+ * @public
  */
 export declare class CreateAccountCommand extends CreateAccountCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -539,6 +539,7 @@ declare const CreateGovCloudAccountCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
+ *
  * @public
  */
 export declare class CreateGovCloudAccountCommand extends CreateGovCloudAccountCommand_base {

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

@@ -417,62 +417,61 @@ declare const CreateOrganizationCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
+ *
  * @example To create a new organization with all features enabled
  * ```javascript
  * // Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:
- * //
- * //
- * const input = {};
+ *
+ *
+ * const input = { /* empty *\/ };
  * const command = new CreateOrganizationCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Organization": {
- *     "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
- *     "AvailablePolicyTypes": [
+ *   Organization: {
+ *     Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid",
+ *     AvailablePolicyTypes: [
  *       {
- *         "Status": "ENABLED",
- *         "Type": "SERVICE_CONTROL_POLICY"
+ *         Status: "ENABLED",
+ *         Type: "SERVICE_CONTROL_POLICY"
  *       }
  *     ],
- *     "FeatureSet": "ALL",
- *     "Id": "o-exampleorgid",
- *     "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
- *     "MasterAccountEmail": "bill@example.com",
- *     "MasterAccountId": "111111111111"
+ *     FeatureSet: "ALL",
+ *     Id: "o-exampleorgid",
+ *     MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
+ *     MasterAccountEmail: "bill@example.com",
+ *     MasterAccountId: "111111111111"
  *   }
  * }
  * *\/
- * // example id: to-create-a-new-organization-with-all-features enabled
  * ```
  *
  * @example To create a new organization with consolidated billing features only
  * ```javascript
  * // In the following example, Bill creates an organization using credentials from account 111111111111, and configures the organization to support only the consolidated billing feature set:
- * //
- * //
+ *
+ *
  * const input = {
- *   "FeatureSet": "CONSOLIDATED_BILLING"
+ *   FeatureSet: "CONSOLIDATED_BILLING"
  * };
  * const command = new CreateOrganizationCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Organization": {
- *     "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
- *     "AvailablePolicyTypes": [],
- *     "FeatureSet": "CONSOLIDATED_BILLING",
- *     "Id": "o-exampleorgid",
- *     "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
- *     "MasterAccountEmail": "bill@example.com",
- *     "MasterAccountId": "111111111111"
+ *   Organization: {
+ *     Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid",
+ *     AvailablePolicyTypes:     [],
+ *     FeatureSet: "CONSOLIDATED_BILLING",
+ *     Id: "o-exampleorgid",
+ *     MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
+ *     MasterAccountEmail: "bill@example.com",
+ *     MasterAccountId: "111111111111"
  *   }
  * }
  * *\/
- * // example id: to-create-a-new-organization-with-consolidated-billing-features-only
  * ```
  *
+ * @public
  */
 export declare class CreateOrganizationCommand extends CreateOrganizationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -414,30 +414,30 @@ declare const CreateOrganizationalUnitCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
+ *
  * @example To create a new organization unit
  * ```javascript
  * // The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:
- * //
- * //
+ *
+ *
  * const input = {
- *   "Name": "AccountingOU",
- *   "ParentId": "r-examplerootid111"
+ *   Name: "AccountingOU",
+ *   ParentId: "r-examplerootid111"
  * };
  * const command = new CreateOrganizationalUnitCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "OrganizationalUnit": {
- *     "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
- *     "Id": "ou-examplerootid111-exampleouid111",
- *     "Name": "AccountingOU"
+ *   OrganizationalUnit: {
+ *     Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
+ *     Id: "ou-examplerootid111-exampleouid111",
+ *     Name: "AccountingOU"
  *   }
  * }
  * *\/
- * // example id: to-create-a-new-organizational-unit
  * ```
  *
+ * @public
  */
 export declare class CreateOrganizationalUnitCommand extends CreateOrganizationalUnitCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -432,36 +432,36 @@ declare const CreatePolicyCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
+ *
  * @example To create a service control policy
  * ```javascript
  * // The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:
- * //
- * //
+ *
+ *
  * const input = {
- *   "Content": "{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}",
- *   "Description": "Enables admins of attached accounts to delegate all S3 permissions",
- *   "Name": "AllowAllS3Actions",
- *   "Type": "SERVICE_CONTROL_POLICY"
+ *   Content: `{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}`,
+ *   Description: "Enables admins of attached accounts to delegate all S3 permissions",
+ *   Name: "AllowAllS3Actions",
+ *   Type: "SERVICE_CONTROL_POLICY"
  * };
  * const command = new CreatePolicyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Policy": {
- *     "Content": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}",
- *     "PolicySummary": {
- *       "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
- *       "Description": "Allows delegation of all S3 actions",
- *       "Name": "AllowAllS3Actions",
- *       "Type": "SERVICE_CONTROL_POLICY"
+ *   Policy: {
+ *     Content: `{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"s3:*"}}`,
+ *     PolicySummary: {
+ *       Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
+ *       Description: "Allows delegation of all S3 actions",
+ *       Name: "AllowAllS3Actions",
+ *       Type: "SERVICE_CONTROL_POLICY"
  *     }
  *   }
  * }
  * *\/
- * // example id: to-create-a-service-control-policy
  * ```
  *
+ * @public
  */
 export declare class CreatePolicyCommand extends CreatePolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -228,64 +228,64 @@ declare const DeclineHandshakeCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
+ *
  * @example To decline a handshake sent from the master account
  * ```javascript
  * // The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED:
  * const input = {
- *   "HandshakeId": "h-examplehandshakeid111"
+ *   HandshakeId: "h-examplehandshakeid111"
  * };
  * const command = new DeclineHandshakeCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Handshake": {
- *     "Action": "INVITE",
- *     "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
- *     "ExpirationTimestamp": "2016-12-15T19:27:58Z",
- *     "Id": "h-examplehandshakeid111",
- *     "Parties": [
+ *   Handshake: {
+ *     Action: "INVITE",
+ *     Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
+ *     ExpirationTimestamp: "2016-12-15T19:27:58Z",
+ *     Id: "h-examplehandshakeid111",
+ *     Parties: [
  *       {
- *         "Id": "222222222222",
- *         "Type": "ACCOUNT"
+ *         Id: "222222222222",
+ *         Type: "ACCOUNT"
  *       },
  *       {
- *         "Id": "o-exampleorgid",
- *         "Type": "ORGANIZATION"
+ *         Id: "o-exampleorgid",
+ *         Type: "ORGANIZATION"
  *       }
  *     ],
- *     "RequestedTimestamp": "2016-11-30T19:27:58Z",
- *     "Resources": [
+ *     RequestedTimestamp: "2016-11-30T19:27:58Z",
+ *     Resources: [
  *       {
- *         "Resources": [
+ *         Resources: [
  *           {
- *             "Type": "MASTER_EMAIL",
- *             "Value": "bill@example.com"
+ *             Type: "MASTER_EMAIL",
+ *             Value: "bill@example.com"
  *           },
  *           {
- *             "Type": "MASTER_NAME",
- *             "Value": "Master Account"
+ *             Type: "MASTER_NAME",
+ *             Value: "Master Account"
  *           }
  *         ],
- *         "Type": "ORGANIZATION",
- *         "Value": "o-exampleorgid"
+ *         Type: "ORGANIZATION",
+ *         Value: "o-exampleorgid"
  *       },
  *       {
- *         "Type": "ACCOUNT",
- *         "Value": "222222222222"
+ *         Type: "ACCOUNT",
+ *         Value: "222222222222"
  *       },
  *       {
- *         "Type": "NOTES",
- *         "Value": "This is an invitation to Susan's account to join the Bill's organization."
+ *         Type: "NOTES",
+ *         Value: "This is an invitation to Susan's account to join the Bill's organization."
  *       }
  *     ],
- *     "State": "DECLINED"
+ *     State: "DECLINED"
  *   }
  * }
  * *\/
- * // example id: to-decline-a-handshake-sent-from-the-master-account-1472502666967
  * ```
  *
+ * @public
  */
 export declare class DeclineHandshakeCommand extends DeclineHandshakeCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -188,6 +188,7 @@ declare const DeleteOrganizationCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteOrganizationCommand extends DeleteOrganizationCommand_base {

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

@@ -196,20 +196,23 @@ declare const DeleteOrganizationalUnitCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
+ *
  * @example To delete an organization unit
  * ```javascript
  * // The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:
- * //
- * //
+ *
+ *
  * const input = {
- *   "OrganizationalUnitId": "ou-examplerootid111-exampleouid111"
+ *   OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
  * };
  * const command = new DeleteOrganizationalUnitCommand(input);
- * await client.send(command);
- * // example id: to-delete-an-organizational-unit
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteOrganizationalUnitCommand extends DeleteOrganizationalUnitCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -200,20 +200,23 @@ declare const DeletePolicyCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
- * @public
+ *
  * @example To delete a policy
  * ```javascript
  * // The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:
- * //
- * //
+ *
+ *
  * const input = {
- *   "PolicyId": "p-examplepolicyid111"
+ *   PolicyId: "p-examplepolicyid111"
  * };
  * const command = new DeletePolicyCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-policy
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeletePolicyCommand extends DeletePolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -280,6 +280,7 @@ declare const DeleteResourcePolicyCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteResourcePolicyCommand extends DeleteResourcePolicyCommand_base {

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

@@ -411,6 +411,7 @@ declare const DeregisterDelegatedAdministratorCommand_base: {
  * @throws {@link OrganizationsServiceException}
  * <p>Base exception class for all service exceptions from Organizations service.</p>
  *
+ *
  * @public
  */
 export declare class DeregisterDelegatedAdministratorCommand extends DeregisterDelegatedAdministratorCommand_base {