@aws-sdk/client-organizations 3.287.0 → 3.289.0

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

@@ -41,6 +41,32 @@ export interface ListPoliciesForTargetCommandOutput extends ListPoliciesForTarge
  * @see {@link ListPoliciesForTargetCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @example To retrieve a list policies attached to a root, OU, or account
+ * ```javascript
+ * // The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n
+ * const input = {
+ *   "Filter": "SERVICE_CONTROL_POLICY",
+ *   "TargetId": "444444444444"
+ * };
+ * const command = new ListPoliciesForTargetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Policies": [
+ *     {
+ *       "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222",
+ *       "AwsManaged": false,
+ *       "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts.",
+ *       "Id": "p-examplepolicyid222",
+ *       "Name": "AllowAllEC2Actions",
+ *       "Type": "SERVICE_CONTROL_POLICY"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-retrieve-a-list-of-policies-attached-to-a-root-ou-or-account
+ * ```
+ *
  */
 export declare class ListPoliciesForTargetCommand extends $Command<ListPoliciesForTargetCommandInput, ListPoliciesForTargetCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: ListPoliciesForTargetCommandInput;

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

@@ -46,6 +46,32 @@ export interface ListRootsCommandOutput extends ListRootsResponse, __MetadataBea
  * @see {@link ListRootsCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @example To retrieve a list of roots in the organization
+ * ```javascript
+ * // The following example shows how to get the list of the roots in the current organization:/n/n
+ * const input = {};
+ * const command = new ListRootsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Roots": [
+ *     {
+ *       "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
+ *       "Id": "r-examplerootid111",
+ *       "Name": "Root",
+ *       "PolicyTypes": [
+ *         {
+ *           "Status": "ENABLED",
+ *           "Type": "SERVICE_CONTROL_POLICY"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-retrieve-a-list-of-roots-in-the-organization
+ * ```
+ *
  */
 export declare class ListRootsCommand extends $Command<ListRootsCommandInput, ListRootsCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: ListRootsCommandInput;

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

@@ -40,6 +40,41 @@ export interface ListTargetsForPolicyCommandOutput extends ListTargetsForPolicyR
  * @see {@link ListTargetsForPolicyCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @example To retrieve a list of roots, OUs, and accounts to which a policy is attached
+ * ```javascript
+ * // The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n
+ * const input = {
+ *   "PolicyId": "p-FullAWSAccess"
+ * };
+ * const command = new ListTargetsForPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Targets": [
+ *     {
+ *       "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111",
+ *       "Name": "Root",
+ *       "TargetId": "r-examplerootid111",
+ *       "Type": "ROOT"
+ *     },
+ *     {
+ *       "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;",
+ *       "Name": "Developer Test Account",
+ *       "TargetId": "333333333333",
+ *       "Type": "ACCOUNT"
+ *     },
+ *     {
+ *       "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
+ *       "Name": "Accounting",
+ *       "TargetId": "ou-examplerootid111-exampleouid111",
+ *       "Type": "ORGANIZATIONAL_UNIT"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-retrieve-a-list-of-roots-ous-and-accounts-to-which-a-policy-is-attached
+ * ```
+ *
  */
 export declare class ListTargetsForPolicyCommand extends $Command<ListTargetsForPolicyCommandInput, ListTargetsForPolicyCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: ListTargetsForPolicyCommandInput;

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

@@ -31,6 +31,19 @@ export interface MoveAccountCommandOutput extends __MetadataBearer {
  * @see {@link MoveAccountCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @example To move an OU or account to another OU or the root
+ * ```javascript
+ * // The following example shows how to move a member account from the root to an OU:/n/n
+ * const input = {
+ *   "AccountId": "333333333333",
+ *   "DestinationParentId": "ou-examplerootid111-exampleouid111",
+ *   "SourceParentId": "r-examplerootid111"
+ * };
+ * const command = new MoveAccountCommand(input);
+ * await client.send(command);
+ * // example id: to-move-an-ou-or-account-to-another-ou-or-the-root
+ * ```
+ *
  */
 export declare class MoveAccountCommand extends $Command<MoveAccountCommandInput, MoveAccountCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: MoveAccountCommandInput;

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

@@ -66,6 +66,17 @@ export interface RemoveAccountFromOrganizationCommandOutput extends __MetadataBe
  * @see {@link RemoveAccountFromOrganizationCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @example To remove an account from an organization as the master account
+ * ```javascript
+ * // The following example shows you how to remove an account from an organization:
+ * const input = {
+ *   "AccountId": "333333333333"
+ * };
+ * const command = new RemoveAccountFromOrganizationCommand(input);
+ * await client.send(command);
+ * // example id: to-remove-an-account-from-an-organization-as-the-master-account
+ * ```
+ *
  */
 export declare class RemoveAccountFromOrganizationCommand extends $Command<RemoveAccountFromOrganizationCommandInput, RemoveAccountFromOrganizationCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: RemoveAccountFromOrganizationCommandInput;

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

@@ -32,6 +32,27 @@ export interface UpdateOrganizationalUnitCommandOutput extends UpdateOrganizatio
  * @see {@link UpdateOrganizationalUnitCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @example To rename an organizational unit
+ * ```javascript
+ * // The following example shows how to rename an OU. The output confirms the new name:/n/n
+ * const input = {
+ *   "Name": "AccountingOU",
+ *   "OrganizationalUnitId": "ou-examplerootid111-exampleouid111"
+ * };
+ * const command = new UpdateOrganizationalUnitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "OrganizationalUnit": {
+ *     "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111",
+ *     "Id": "ou-examplerootid111-exampleouid111",
+ *     "Name": "AccountingOU"
+ *   }
+ * }
+ * *\/
+ * // example id: to-rename-an-organizational-unit
+ * ```
+ *
  */
 export declare class UpdateOrganizationalUnitCommand extends $Command<UpdateOrganizationalUnitCommandInput, UpdateOrganizationalUnitCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: UpdateOrganizationalUnitCommandInput;

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

@@ -32,6 +32,61 @@ export interface UpdatePolicyCommandOutput extends UpdatePolicyResponse, __Metad
  * @see {@link UpdatePolicyCommandOutput} for command's `response` shape.
  * @see {@link OrganizationsClientResolvedConfig | config} for OrganizationsClient's `config` shape.
  *
+ * @example To update the details of a policy
+ * ```javascript
+ * // The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n
+ * const input = {
+ *   "Description": "This description replaces the original.",
+ *   "Name": "Renamed-Policy",
+ *   "PolicyId": "p-examplepolicyid111"
+ * };
+ * const command = new UpdatePolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Policy": {
+ *     "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }",
+ *     "PolicySummary": {
+ *       "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
+ *       "AwsManaged": false,
+ *       "Description": "This description replaces the original.",
+ *       "Id": "p-examplepolicyid111",
+ *       "Name": "Renamed-Policy",
+ *       "Type": "SERVICE_CONTROL_POLICY"
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: to-update-the-details-of-a-policy
+ * ```
+ *
+ * @example To update the content of a policy
+ * ```javascript
+ * // The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n
+ * const input = {
+ *   "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }",
+ *   "PolicyId": "p-examplepolicyid111"
+ * };
+ * const command = new UpdatePolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Policy": {
+ *     "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }",
+ *     "PolicySummary": {
+ *       "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
+ *       "AwsManaged": false,
+ *       "Description": "This description replaces the original.",
+ *       "Id": "p-examplepolicyid111",
+ *       "Name": "Renamed-Policy",
+ *       "Type": "SERVICE_CONTROL_POLICY"
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: to-update-the-content-of-a-policy
+ * ```
+ *
  */
 export declare class UpdatePolicyCommand extends $Command<UpdatePolicyCommandInput, UpdatePolicyCommandOutput, OrganizationsClientResolvedConfig> {
     readonly input: UpdatePolicyCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-organizations",
   "description": "AWS SDK for JavaScript Organizations Client for Node.js, Browser and React Native",
-  "version": "3.287.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.287.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.287.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.287.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
     "tslib": "^2.3.1"
   },