Skip to content

Commit 849e058

Browse files
author
awstools
committed
feat(client-ssm): Support for additional levels of cross-account, cross-Region organizational units in Automation. Various documentation updates.
1 parent 9b2dac1 commit 849e058

20 files changed

+533
-196
lines changed

‎clients/client-ssm/src/commands/CreateActivationCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
3232
* servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with
3333
* Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and
3434
* ID when installing SSM Agent on machines in your hybrid environment. For more information about
35-
* 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
36-
* Amazon Web Services Systems Manager for hybrid and multicloud environments</a> in the
37-
* <i>Amazon Web Services Systems Manager User Guide</i>. </p>
35+
* 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
36+
* hybrid and multicloud environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
3837
* <note>
3938
* <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
4039
* configured for Systems Manager are all called <i>managed nodes</i>.</p>

‎clients/client-ssm/src/commands/CreateAssociationBatchCommand.ts

+36-8
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,20 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
102102
* },
103103
* ],
104104
* },
105+
* IncludeChildOrganizationUnits: true || false,
106+
* ExcludeAccounts: [ // ExcludeAccounts
107+
* "STRING_VALUE",
108+
* ],
109+
* Targets: [
110+
* {
111+
* Key: "STRING_VALUE",
112+
* Values: [
113+
* "STRING_VALUE",
114+
* ],
115+
* },
116+
* ],
117+
* TargetsMaxConcurrency: "STRING_VALUE",
118+
* TargetsMaxErrors: "STRING_VALUE",
105119
* },
106120
* ],
107121
* ScheduleOffset: Number("int"),
@@ -201,6 +215,20 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
201215
* // },
202216
* // ],
203217
* // },
218+
* // IncludeChildOrganizationUnits: true || false,
219+
* // ExcludeAccounts: [ // ExcludeAccounts
220+
* // "STRING_VALUE",
221+
* // ],
222+
* // Targets: [
223+
* // {
224+
* // Key: "STRING_VALUE",
225+
* // Values: [
226+
* // "STRING_VALUE",
227+
* // ],
228+
* // },
229+
* // ],
230+
* // TargetsMaxConcurrency: "STRING_VALUE",
231+
* // TargetsMaxErrors: "STRING_VALUE",
204232
* // },
205233
* // ],
206234
* // ScheduleOffset: Number("int"),
@@ -240,14 +268,7 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
240268
* // },
241269
* // AutomationTargetParameterName: "STRING_VALUE",
242270
* // DocumentVersion: "STRING_VALUE",
243-
* // Targets: [
244-
* // {
245-
* // Key: "STRING_VALUE",
246-
* // Values: [
247-
* // "STRING_VALUE",
248-
* // ],
249-
* // },
250-
* // ],
271+
* // Targets: "<Targets>",
251272
* // ScheduleExpression: "STRING_VALUE",
252273
* // OutputLocation: {
253274
* // S3Location: {
@@ -277,6 +298,13 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
277298
* // TargetLocationMaxErrors: "STRING_VALUE",
278299
* // ExecutionRoleName: "STRING_VALUE",
279300
* // TargetLocationAlarmConfiguration: "<AlarmConfiguration>",
301+
* // IncludeChildOrganizationUnits: true || false,
302+
* // ExcludeAccounts: [
303+
* // "STRING_VALUE",
304+
* // ],
305+
* // Targets: "<Targets>",
306+
* // TargetsMaxConcurrency: "STRING_VALUE",
307+
* // TargetsMaxErrors: "STRING_VALUE",
280308
* // },
281309
* // ],
282310
* // ScheduleOffset: Number("int"),

‎clients/client-ssm/src/commands/CreateAssociationCommand.ts

+28
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,20 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
103103
* },
104104
* ],
105105
* },
106+
* IncludeChildOrganizationUnits: true || false,
107+
* ExcludeAccounts: [ // ExcludeAccounts
108+
* "STRING_VALUE",
109+
* ],
110+
* Targets: [
111+
* {
112+
* Key: "STRING_VALUE",
113+
* Values: [
114+
* "STRING_VALUE",
115+
* ],
116+
* },
117+
* ],
118+
* TargetsMaxConcurrency: "STRING_VALUE",
119+
* TargetsMaxErrors: "STRING_VALUE",
106120
* },
107121
* ],
108122
* ScheduleOffset: Number("int"),
@@ -205,6 +219,20 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
205219
* // },
206220
* // ],
207221
* // },
222+
* // IncludeChildOrganizationUnits: true || false,
223+
* // ExcludeAccounts: [ // ExcludeAccounts
224+
* // "STRING_VALUE",
225+
* // ],
226+
* // Targets: [
227+
* // {
228+
* // Key: "STRING_VALUE",
229+
* // Values: [
230+
* // "STRING_VALUE",
231+
* // ],
232+
* // },
233+
* // ],
234+
* // TargetsMaxConcurrency: "STRING_VALUE",
235+
* // TargetsMaxErrors: "STRING_VALUE",
208236
* // },
209237
* // ],
210238
* // ScheduleOffset: Number("int"),

‎clients/client-ssm/src/commands/CreateDocumentCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface CreateDocumentCommandOutput extends CreateDocumentResult, __Met
3030
/**
3131
* <p>Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs
3232
* on your managed nodes. For more information about SSM documents, including information about
33-
* 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
33+
* 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
3434
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ssm/src/commands/CreateResourceDataSyncCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export interface CreateResourceDataSyncCommandOutput extends CreateResourceDataS
3232
* Amazon Web Services Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and
3333
* <code>SyncFromSource</code>.</p>
3434
* <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to
35-
* 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
36-
* sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
35+
* 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
36+
* resource data sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3737
* <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize
3838
* operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a
3939
* single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple

‎clients/client-ssm/src/commands/DescribeAssociationCommand.ts

+14
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,20 @@ export interface DescribeAssociationCommandOutput extends DescribeAssociationRes
123123
* // },
124124
* // ],
125125
* // },
126+
* // IncludeChildOrganizationUnits: true || false,
127+
* // ExcludeAccounts: [ // ExcludeAccounts
128+
* // "STRING_VALUE",
129+
* // ],
130+
* // Targets: [
131+
* // {
132+
* // Key: "STRING_VALUE",
133+
* // Values: [
134+
* // "STRING_VALUE",
135+
* // ],
136+
* // },
137+
* // ],
138+
* // TargetsMaxConcurrency: "STRING_VALUE",
139+
* // TargetsMaxErrors: "STRING_VALUE",
126140
* // },
127141
* // ],
128142
* // ScheduleOffset: Number("int"),

‎clients/client-ssm/src/commands/DescribeAutomationExecutionsCommand.ts

+8
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ export interface DescribeAutomationExecutionsCommandOutput
115115
* // State: "UNKNOWN" || "ALARM", // required
116116
* // },
117117
* // ],
118+
* // TargetLocationsURL: "STRING_VALUE",
118119
* // AutomationSubtype: "ChangeRequest",
119120
* // ScheduledTime: new Date("TIMESTAMP"),
120121
* // Runbooks: [ // Runbooks
@@ -163,6 +164,13 @@ export interface DescribeAutomationExecutionsCommandOutput
163164
* // },
164165
* // ],
165166
* // },
167+
* // IncludeChildOrganizationUnits: true || false,
168+
* // ExcludeAccounts: [ // ExcludeAccounts
169+
* // "STRING_VALUE",
170+
* // ],
171+
* // Targets: "<Targets>",
172+
* // TargetsMaxConcurrency: "STRING_VALUE",
173+
* // TargetsMaxErrors: "STRING_VALUE",
166174
* // },
167175
* // ],
168176
* // },

‎clients/client-ssm/src/commands/DescribeAutomationStepExecutionsCommand.ts

+14
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,20 @@ export interface DescribeAutomationStepExecutionsCommandOutput
126126
* // },
127127
* // ],
128128
* // },
129+
* // IncludeChildOrganizationUnits: true || false,
130+
* // ExcludeAccounts: [ // ExcludeAccounts
131+
* // "STRING_VALUE",
132+
* // ],
133+
* // Targets: [
134+
* // {
135+
* // Key: "STRING_VALUE",
136+
* // Values: [
137+
* // "STRING_VALUE",
138+
* // ],
139+
* // },
140+
* // ],
141+
* // TargetsMaxConcurrency: "STRING_VALUE",
142+
* // TargetsMaxErrors: "STRING_VALUE",
129143
* // },
130144
* // TriggeredAlarms: [ // AlarmStateInformationList
131145
* // { // AlarmStateInformation

‎clients/client-ssm/src/commands/GetAutomationExecutionCommand.ts

+24-16
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,20 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
116116
* // },
117117
* // ],
118118
* // },
119+
* // IncludeChildOrganizationUnits: true || false,
120+
* // ExcludeAccounts: [ // ExcludeAccounts
121+
* // "STRING_VALUE",
122+
* // ],
123+
* // Targets: [
124+
* // {
125+
* // Key: "STRING_VALUE",
126+
* // Values: [
127+
* // "STRING_VALUE",
128+
* // ],
129+
* // },
130+
* // ],
131+
* // TargetsMaxConcurrency: "STRING_VALUE",
132+
* // TargetsMaxErrors: "STRING_VALUE",
119133
* // },
120134
* // TriggeredAlarms: [ // AlarmStateInformationList
121135
* // { // AlarmStateInformation
@@ -142,14 +156,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
142156
* // CurrentStepName: "STRING_VALUE",
143157
* // CurrentAction: "STRING_VALUE",
144158
* // TargetParameterName: "STRING_VALUE",
145-
* // Targets: [
146-
* // {
147-
* // Key: "STRING_VALUE",
148-
* // Values: [
149-
* // "STRING_VALUE",
150-
* // ],
151-
* // },
152-
* // ],
159+
* // Targets: "<Targets>",
153160
* // TargetMaps: [ // TargetMaps
154161
* // { // TargetMap
155162
* // "<keys>": [ // TargetMapValueList
@@ -185,6 +192,13 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
185192
* // },
186193
* // ],
187194
* // },
195+
* // IncludeChildOrganizationUnits: true || false,
196+
* // ExcludeAccounts: [
197+
* // "STRING_VALUE",
198+
* // ],
199+
* // Targets: "<Targets>",
200+
* // TargetsMaxConcurrency: "STRING_VALUE",
201+
* // TargetsMaxErrors: "STRING_VALUE",
188202
* // },
189203
* // ],
190204
* // ProgressCounters: { // ProgressCounters
@@ -201,6 +215,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
201215
* // State: "UNKNOWN" || "ALARM", // required
202216
* // },
203217
* // ],
218+
* // TargetLocationsURL: "STRING_VALUE",
204219
* // AutomationSubtype: "ChangeRequest",
205220
* // ScheduledTime: new Date("TIMESTAMP"),
206221
* // Runbooks: [ // Runbooks
@@ -209,14 +224,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
209224
* // DocumentVersion: "STRING_VALUE",
210225
* // Parameters: "<AutomationParameterMap>",
211226
* // TargetParameterName: "STRING_VALUE",
212-
* // Targets: [
213-
* // {
214-
* // Key: "STRING_VALUE",
215-
* // Values: [
216-
* // "STRING_VALUE",
217-
* // ],
218-
* // },
219-
* // ],
227+
* // Targets: "<Targets>",
220228
* // TargetMaps: [
221229
* // {
222230
* // "<keys>": [

‎clients/client-ssm/src/commands/ListAssociationVersionsCommand.ts

+14
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,20 @@ export interface ListAssociationVersionsCommandOutput extends ListAssociationVer
103103
* // },
104104
* // ],
105105
* // },
106+
* // IncludeChildOrganizationUnits: true || false,
107+
* // ExcludeAccounts: [ // ExcludeAccounts
108+
* // "STRING_VALUE",
109+
* // ],
110+
* // Targets: [
111+
* // {
112+
* // Key: "STRING_VALUE",
113+
* // Values: [
114+
* // "STRING_VALUE",
115+
* // ],
116+
* // },
117+
* // ],
118+
* // TargetsMaxConcurrency: "STRING_VALUE",
119+
* // TargetsMaxErrors: "STRING_VALUE",
106120
* // },
107121
* // ],
108122
* // ScheduleOffset: Number("int"),

‎clients/client-ssm/src/commands/StartAutomationExecutionCommand.ts

+15
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,20 @@ export interface StartAutomationExecutionCommandOutput extends StartAutomationEx
8282
* },
8383
* ],
8484
* },
85+
* IncludeChildOrganizationUnits: true || false,
86+
* ExcludeAccounts: [ // ExcludeAccounts
87+
* "STRING_VALUE",
88+
* ],
89+
* Targets: [
90+
* {
91+
* Key: "STRING_VALUE",
92+
* Values: [
93+
* "STRING_VALUE",
94+
* ],
95+
* },
96+
* ],
97+
* TargetsMaxConcurrency: "STRING_VALUE",
98+
* TargetsMaxErrors: "STRING_VALUE",
8599
* },
86100
* ],
87101
* Tags: [ // TagList
@@ -98,6 +112,7 @@ export interface StartAutomationExecutionCommandOutput extends StartAutomationEx
98112
* },
99113
* ],
100114
* },
115+
* TargetLocationsURL: "STRING_VALUE",
101116
* };
102117
* const command = new StartAutomationExecutionCommand(input);
103118
* const response = await client.send(command);

‎clients/client-ssm/src/commands/StartChangeRequestExecutionCommand.ts

+14
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,20 @@ export interface StartChangeRequestExecutionCommandOutput extends StartChangeReq
9595
* },
9696
* ],
9797
* },
98+
* IncludeChildOrganizationUnits: true || false,
99+
* ExcludeAccounts: [ // ExcludeAccounts
100+
* "STRING_VALUE",
101+
* ],
102+
* Targets: [
103+
* {
104+
* Key: "STRING_VALUE",
105+
* Values: [
106+
* "STRING_VALUE",
107+
* ],
108+
* },
109+
* ],
110+
* TargetsMaxConcurrency: "STRING_VALUE",
111+
* TargetsMaxErrors: "STRING_VALUE",
98112
* },
99113
* ],
100114
* },

‎clients/client-ssm/src/commands/StartSessionCommand.ts

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

0 commit comments

Comments
 (0)