feat(client-ssm): Support for additional levels of cross-account, cro…

…ss-Region organizational units in Automation. Various documentation updates.
aws · Sep 17, 2024 · 849e058 · 849e058
1 parent 9b2dac1
commit 849e058
Show file tree

Hide file tree

Showing 20 changed files with 533 additions and 196 deletions.
diff --git a/clients/client-ssm/src/commands/CreateActivationCommand.ts b/clients/client-ssm/src/commands/CreateActivationCommand.ts
@@ -32,9 +32,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
  *    servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with
  *    Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and
  *    ID when installing SSM Agent on machines in your hybrid environment. For more information about
- *    requirements for managing on-premises machines using Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html">Setting up
- *     Amazon Web Services Systems Manager for hybrid and multicloud environments</a> in the
- *     <i>Amazon Web Services Systems Manager User Guide</i>. </p>
+ *    requirements for managing on-premises machines using Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html">Using Amazon Web Services Systems Manager in
+ *     hybrid and multicloud environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
  *          <note>
  *             <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
  *     configured for Systems Manager are all called <i>managed nodes</i>.</p>

diff --git a/clients/client-ssm/src/commands/CreateAssociationBatchCommand.ts b/clients/client-ssm/src/commands/CreateAssociationBatchCommand.ts
@@ -102,6 +102,20 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
  *               },
  *             ],
  *           },
+ *           IncludeChildOrganizationUnits: true || false,
+ *           ExcludeAccounts: [ // ExcludeAccounts
+ *             "STRING_VALUE",
+ *           ],
+ *           Targets: [
+ *             {
+ *               Key: "STRING_VALUE",
+ *               Values: [
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *           ],
+ *           TargetsMaxConcurrency: "STRING_VALUE",
+ *           TargetsMaxErrors: "STRING_VALUE",
  *         },
  *       ],
  *       ScheduleOffset: Number("int"),
@@ -201,6 +215,20 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
  * //               },
  * //             ],
  * //           },
+ * //           IncludeChildOrganizationUnits: true || false,
+ * //           ExcludeAccounts: [ // ExcludeAccounts
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           Targets: [
+ * //             {
+ * //               Key: "STRING_VALUE",
+ * //               Values: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //             },
+ * //           ],
+ * //           TargetsMaxConcurrency: "STRING_VALUE",
+ * //           TargetsMaxErrors: "STRING_VALUE",
  * //         },
  * //       ],
  * //       ScheduleOffset: Number("int"),
@@ -240,14 +268,7 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
  * //         },
  * //         AutomationTargetParameterName: "STRING_VALUE",
  * //         DocumentVersion: "STRING_VALUE",
- * //         Targets: [
- * //           {
- * //             Key: "STRING_VALUE",
- * //             Values: [
- * //               "STRING_VALUE",
- * //             ],
- * //           },
- * //         ],
+ * //         Targets: "<Targets>",
  * //         ScheduleExpression: "STRING_VALUE",
  * //         OutputLocation: {
  * //           S3Location: {
@@ -277,6 +298,13 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
  * //             TargetLocationMaxErrors: "STRING_VALUE",
  * //             ExecutionRoleName: "STRING_VALUE",
  * //             TargetLocationAlarmConfiguration: "<AlarmConfiguration>",
+ * //             IncludeChildOrganizationUnits: true || false,
+ * //             ExcludeAccounts: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             Targets: "<Targets>",
+ * //             TargetsMaxConcurrency: "STRING_VALUE",
+ * //             TargetsMaxErrors: "STRING_VALUE",
  * //           },
  * //         ],
  * //         ScheduleOffset: Number("int"),

diff --git a/clients/client-ssm/src/commands/CreateAssociationCommand.ts b/clients/client-ssm/src/commands/CreateAssociationCommand.ts
@@ -103,6 +103,20 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
  *           },
  *         ],
  *       },
+ *       IncludeChildOrganizationUnits: true || false,
+ *       ExcludeAccounts: [ // ExcludeAccounts
+ *         "STRING_VALUE",
+ *       ],
+ *       Targets: [
+ *         {
+ *           Key: "STRING_VALUE",
+ *           Values: [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *       ],
+ *       TargetsMaxConcurrency: "STRING_VALUE",
+ *       TargetsMaxErrors: "STRING_VALUE",
  *     },
  *   ],
  *   ScheduleOffset: Number("int"),
@@ -205,6 +219,20 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
  * //             },
  * //           ],
  * //         },
+ * //         IncludeChildOrganizationUnits: true || false,
+ * //         ExcludeAccounts: [ // ExcludeAccounts
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Targets: [
+ * //           {
+ * //             Key: "STRING_VALUE",
+ * //             Values: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         ],
+ * //         TargetsMaxConcurrency: "STRING_VALUE",
+ * //         TargetsMaxErrors: "STRING_VALUE",
  * //       },
  * //     ],
  * //     ScheduleOffset: Number("int"),

diff --git a/clients/client-ssm/src/commands/CreateDocumentCommand.ts b/clients/client-ssm/src/commands/CreateDocumentCommand.ts
@@ -30,7 +30,7 @@ export interface CreateDocumentCommandOutput extends CreateDocumentResult, __Met
 /**
  * <p>Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs
  *    on your managed nodes. For more information about SSM documents, including information about
- *    supported schemas, features, and syntax, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html">Amazon Web Services Systems Manager Documents</a> in the
+ *    supported schemas, features, and syntax, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents.html">Amazon Web Services Systems Manager Documents</a> in the
  *     <i>Amazon Web Services Systems Manager User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-ssm/src/commands/CreateResourceDataSyncCommand.ts b/clients/client-ssm/src/commands/CreateResourceDataSyncCommand.ts
@@ -32,8 +32,8 @@ export interface CreateResourceDataSyncCommandOutput extends CreateResourceDataS
  *    Amazon Web Services Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and
  *     <code>SyncFromSource</code>.</p>
  *          <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to
- *    synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html">Configuring resource data
- *     sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
+ *    synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-create-resource-data-sync.html">Creatinga a
+ *     resource data sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
  *          <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize
  *    operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a
  *    single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple

diff --git a/clients/client-ssm/src/commands/DescribeAssociationCommand.ts b/clients/client-ssm/src/commands/DescribeAssociationCommand.ts
@@ -123,6 +123,20 @@ export interface DescribeAssociationCommandOutput extends DescribeAssociationRes
  * //             },
  * //           ],
  * //         },
+ * //         IncludeChildOrganizationUnits: true || false,
+ * //         ExcludeAccounts: [ // ExcludeAccounts
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Targets: [
+ * //           {
+ * //             Key: "STRING_VALUE",
+ * //             Values: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         ],
+ * //         TargetsMaxConcurrency: "STRING_VALUE",
+ * //         TargetsMaxErrors: "STRING_VALUE",
  * //       },
  * //     ],
  * //     ScheduleOffset: Number("int"),

diff --git a/clients/client-ssm/src/commands/DescribeAutomationExecutionsCommand.ts b/clients/client-ssm/src/commands/DescribeAutomationExecutionsCommand.ts
@@ -115,6 +115,7 @@ export interface DescribeAutomationExecutionsCommandOutput
  * //           State: "UNKNOWN" || "ALARM", // required
  * //         },
  * //       ],
+ * //       TargetLocationsURL: "STRING_VALUE",
  * //       AutomationSubtype: "ChangeRequest",
  * //       ScheduledTime: new Date("TIMESTAMP"),
  * //       Runbooks: [ // Runbooks
@@ -163,6 +164,13 @@ export interface DescribeAutomationExecutionsCommandOutput
  * //                   },
  * //                 ],
  * //               },
+ * //               IncludeChildOrganizationUnits: true || false,
+ * //               ExcludeAccounts: [ // ExcludeAccounts
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //               Targets: "<Targets>",
+ * //               TargetsMaxConcurrency: "STRING_VALUE",
+ * //               TargetsMaxErrors: "STRING_VALUE",
  * //             },
  * //           ],
  * //         },

diff --git a/clients/client-ssm/src/commands/DescribeAutomationStepExecutionsCommand.ts b/clients/client-ssm/src/commands/DescribeAutomationStepExecutionsCommand.ts
@@ -126,6 +126,20 @@ export interface DescribeAutomationStepExecutionsCommandOutput
  * //             },
  * //           ],
  * //         },
+ * //         IncludeChildOrganizationUnits: true || false,
+ * //         ExcludeAccounts: [ // ExcludeAccounts
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Targets: [
+ * //           {
+ * //             Key: "STRING_VALUE",
+ * //             Values: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         ],
+ * //         TargetsMaxConcurrency: "STRING_VALUE",
+ * //         TargetsMaxErrors: "STRING_VALUE",
  * //       },
  * //       TriggeredAlarms: [ // AlarmStateInformationList
  * //         { // AlarmStateInformation

diff --git a/clients/client-ssm/src/commands/GetAutomationExecutionCommand.ts b/clients/client-ssm/src/commands/GetAutomationExecutionCommand.ts
@@ -116,6 +116,20 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
  * //               },
  * //             ],
  * //           },
+ * //           IncludeChildOrganizationUnits: true || false,
+ * //           ExcludeAccounts: [ // ExcludeAccounts
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           Targets: [
+ * //             {
+ * //               Key: "STRING_VALUE",
+ * //               Values: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //             },
+ * //           ],
+ * //           TargetsMaxConcurrency: "STRING_VALUE",
+ * //           TargetsMaxErrors: "STRING_VALUE",
  * //         },
  * //         TriggeredAlarms: [ // AlarmStateInformationList
  * //           { // AlarmStateInformation
@@ -142,14 +156,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
  * //     CurrentStepName: "STRING_VALUE",
  * //     CurrentAction: "STRING_VALUE",
  * //     TargetParameterName: "STRING_VALUE",
- * //     Targets: [
- * //       {
- * //         Key: "STRING_VALUE",
- * //         Values: [
- * //           "STRING_VALUE",
- * //         ],
- * //       },
- * //     ],
+ * //     Targets: "<Targets>",
  * //     TargetMaps: [ // TargetMaps
  * //       { // TargetMap
  * //         "<keys>": [ // TargetMapValueList
@@ -185,6 +192,13 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
  * //             },
  * //           ],
  * //         },
+ * //         IncludeChildOrganizationUnits: true || false,
+ * //         ExcludeAccounts: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Targets: "<Targets>",
+ * //         TargetsMaxConcurrency: "STRING_VALUE",
+ * //         TargetsMaxErrors: "STRING_VALUE",
  * //       },
  * //     ],
  * //     ProgressCounters: { // ProgressCounters
@@ -201,6 +215,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
  * //         State: "UNKNOWN" || "ALARM", // required
  * //       },
  * //     ],
+ * //     TargetLocationsURL: "STRING_VALUE",
  * //     AutomationSubtype: "ChangeRequest",
  * //     ScheduledTime: new Date("TIMESTAMP"),
  * //     Runbooks: [ // Runbooks
@@ -209,14 +224,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
  * //         DocumentVersion: "STRING_VALUE",
  * //         Parameters: "<AutomationParameterMap>",
  * //         TargetParameterName: "STRING_VALUE",
- * //         Targets: [
- * //           {
- * //             Key: "STRING_VALUE",
- * //             Values: [
- * //               "STRING_VALUE",
- * //             ],
- * //           },
- * //         ],
+ * //         Targets: "<Targets>",
  * //         TargetMaps: [
  * //           {
  * //             "<keys>": [

diff --git a/clients/client-ssm/src/commands/ListAssociationVersionsCommand.ts b/clients/client-ssm/src/commands/ListAssociationVersionsCommand.ts
@@ -103,6 +103,20 @@ export interface ListAssociationVersionsCommandOutput extends ListAssociationVer
  * //               },
  * //             ],
  * //           },
+ * //           IncludeChildOrganizationUnits: true || false,
+ * //           ExcludeAccounts: [ // ExcludeAccounts
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           Targets: [
+ * //             {
+ * //               Key: "STRING_VALUE",
+ * //               Values: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //             },
+ * //           ],
+ * //           TargetsMaxConcurrency: "STRING_VALUE",
+ * //           TargetsMaxErrors: "STRING_VALUE",
  * //         },
  * //       ],
  * //       ScheduleOffset: Number("int"),

diff --git a/clients/client-ssm/src/commands/StartAutomationExecutionCommand.ts b/clients/client-ssm/src/commands/StartAutomationExecutionCommand.ts
@@ -82,6 +82,20 @@ export interface StartAutomationExecutionCommandOutput extends StartAutomationEx
  *           },
  *         ],
  *       },
+ *       IncludeChildOrganizationUnits: true || false,
+ *       ExcludeAccounts: [ // ExcludeAccounts
+ *         "STRING_VALUE",
+ *       ],
+ *       Targets: [
+ *         {
+ *           Key: "STRING_VALUE",
+ *           Values: [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *       ],
+ *       TargetsMaxConcurrency: "STRING_VALUE",
+ *       TargetsMaxErrors: "STRING_VALUE",
  *     },
  *   ],
  *   Tags: [ // TagList
@@ -98,6 +112,7 @@ export interface StartAutomationExecutionCommandOutput extends StartAutomationEx
  *       },
  *     ],
  *   },
+ *   TargetLocationsURL: "STRING_VALUE",
  * };
  * const command = new StartAutomationExecutionCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-ssm/src/commands/StartChangeRequestExecutionCommand.ts b/clients/client-ssm/src/commands/StartChangeRequestExecutionCommand.ts
@@ -95,6 +95,20 @@ export interface StartChangeRequestExecutionCommandOutput extends StartChangeReq
  *               },
  *             ],
  *           },
+ *           IncludeChildOrganizationUnits: true || false,
+ *           ExcludeAccounts: [ // ExcludeAccounts
+ *             "STRING_VALUE",
+ *           ],
+ *           Targets: [
+ *             {
+ *               Key: "STRING_VALUE",
+ *               Values: [
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *           ],
+ *           TargetsMaxConcurrency: "STRING_VALUE",
+ *           TargetsMaxErrors: "STRING_VALUE",
  *         },
  *       ],
  *     },

diff --git a/clients/client-ssm/src/commands/StartSessionCommand.ts b/clients/client-ssm/src/commands/StartSessionCommand.ts
@@ -78,7 +78,7 @@ export interface StartSessionCommandOutput extends StartSessionResponse, __Metad
  *
  * @throws {@link TargetNotConnected} (client fault)
  *  <p>The specified target managed node for the session isn't fully configured for use with Session Manager.
- *    For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html">Getting started with
+ *    For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html">Setting up
  *     Session Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. This error is also returned if you
  *    attempt to start a session on a managed node that is located in a different account or
  *    Region</p>