Skip to content

Commit 1a4fe40

Browse files
author
awstools
committed
feat(client-ssm): Update the StartChangeRequestExecution, adding TargetMaps to the Runbook parameter
1 parent ec8aea0 commit 1a4fe40

File tree

7 files changed

+63
-39
lines changed

7 files changed

+63
-39
lines changed

clients/client-ssm/src/SSM.ts

+14-13
Original file line numberDiff line numberDiff line change
@@ -707,11 +707,11 @@ import { SSMClient } from "./SSMClient";
707707
export class SSM extends SSMClient {
708708
/**
709709
* <p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you
710-
* can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and
711-
* patch baselines. Tags enable you to categorize your resources in different ways, for example, by
712-
* purpose, owner, or environment. Each tag consists of a key and an optional value, both of which
713-
* you define. For example, you could define a set of tags for your account's managed nodes that
714-
* helps you track each node's owner and stack level. For example:</p>
710+
* can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store
711+
* parameters, and patch baselines. Tags enable you to categorize your resources in different ways,
712+
* for example, by purpose, owner, or environment. Each tag consists of a key and an optional value,
713+
* both of which you define. For example, you could define a set of tags for your account's managed
714+
* nodes that helps you track each node's owner and stack level. For example:</p>
715715
* <ul>
716716
* <li>
717717
* <p>
@@ -744,7 +744,8 @@ export class SSM extends SSMClient {
744744
* </p>
745745
* </li>
746746
* </ul>
747-
* <p>Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.</p>
747+
* <p>Most resources can have a maximum of 50 tags. Automations can have a maximum of 5
748+
* tags.</p>
748749
* <p>We recommend that you devise a set of tag keys that meets your needs for each resource type.
749750
* Using a consistent set of tag keys makes it easier for you to manage your resources. You can
750751
* search and filter the resources based on the tags you add. Tags don't have any semantic meaning
@@ -3322,13 +3323,13 @@ export class SSM extends SSMClient {
33223323

33233324
/**
33243325
* <p>Retrieves the details of a maintenance window task.</p>
3325-
* <note>
3326-
* <p>For maintenance window tasks without a specified target, you can't supply values for
3327-
* <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a
3328-
* placeholder value of <code>1</code>, which may be reported in the response to this command.
3329-
* These values don't affect the running of your task and can be ignored.</p>
3330-
* </note>
3331-
* <p>To retrieve a list of tasks in a maintenance window, instead use the <a>DescribeMaintenanceWindowTasks</a> command.</p>
3326+
* <note>
3327+
* <p>For maintenance window tasks without a specified target, you can't supply values for
3328+
* <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a
3329+
* placeholder value of <code>1</code>, which may be reported in the response to this command.
3330+
* These values don't affect the running of your task and can be ignored.</p>
3331+
* </note>
3332+
* <p>To retrieve a list of tasks in a maintenance window, instead use the <a>DescribeMaintenanceWindowTasks</a> command.</p>
33323333
*/
33333334
public getMaintenanceWindowTask(
33343335
args: GetMaintenanceWindowTaskCommandInput,

clients/client-ssm/src/commands/AddTagsToResourceCommand.ts

+7-6
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult,
2323

2424
/**
2525
* <p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you
26-
* can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and
27-
* patch baselines. Tags enable you to categorize your resources in different ways, for example, by
28-
* purpose, owner, or environment. Each tag consists of a key and an optional value, both of which
29-
* you define. For example, you could define a set of tags for your account's managed nodes that
30-
* helps you track each node's owner and stack level. For example:</p>
26+
* can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store
27+
* parameters, and patch baselines. Tags enable you to categorize your resources in different ways,
28+
* for example, by purpose, owner, or environment. Each tag consists of a key and an optional value,
29+
* both of which you define. For example, you could define a set of tags for your account's managed
30+
* nodes that helps you track each node's owner and stack level. For example:</p>
3131
* <ul>
3232
* <li>
3333
* <p>
@@ -60,7 +60,8 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult,
6060
* </p>
6161
* </li>
6262
* </ul>
63-
* <p>Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.</p>
63+
* <p>Most resources can have a maximum of 50 tags. Automations can have a maximum of 5
64+
* tags.</p>
6465
* <p>We recommend that you devise a set of tag keys that meets your needs for each resource type.
6566
* Using a consistent set of tag keys makes it easier for you to manage your resources. You can
6667
* search and filter the resources based on the tags you add. Tags don't have any semantic meaning

clients/client-ssm/src/commands/GetMaintenanceWindowTaskCommand.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ export interface GetMaintenanceWindowTaskCommandOutput extends GetMaintenanceWin
2323

2424
/**
2525
* <p>Retrieves the details of a maintenance window task.</p>
26-
* <note>
27-
* <p>For maintenance window tasks without a specified target, you can't supply values for
28-
* <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a
29-
* placeholder value of <code>1</code>, which may be reported in the response to this command.
30-
* These values don't affect the running of your task and can be ignored.</p>
31-
* </note>
32-
* <p>To retrieve a list of tasks in a maintenance window, instead use the <a>DescribeMaintenanceWindowTasks</a> command.</p>
26+
* <note>
27+
* <p>For maintenance window tasks without a specified target, you can't supply values for
28+
* <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a
29+
* placeholder value of <code>1</code>, which may be reported in the response to this command.
30+
* These values don't affect the running of your task and can be ignored.</p>
31+
* </note>
32+
* <p>To retrieve a list of tasks in a maintenance window, instead use the <a>DescribeMaintenanceWindowTasks</a> command.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

clients/client-ssm/src/models/models_0.ts

+9-1
Original file line numberDiff line numberDiff line change
@@ -1235,7 +1235,9 @@ export interface CreateAssociationRequest {
12351235
/**
12361236
* <p>Number of days to wait after the scheduled day to run an association. For example, if you
12371237
* specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3
1238-
* to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
1238+
* to run the association each Sunday after the second Thursday of the month. For more information
1239+
* about cron schedules for associations, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html">Reference: Cron
1240+
* and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
12391241
* <note>
12401242
* <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This
12411243
* option tells the system not to run an association immediately after you create it. </p>
@@ -5384,6 +5386,12 @@ export interface Runbook {
53845386
*/
53855387
Targets?: Target[];
53865388

5389+
/**
5390+
* <p>A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps
5391+
* can't be specified together.</p>
5392+
*/
5393+
TargetMaps?: { [key: string]: string[] }[];
5394+
53875395
/**
53885396
* <p>The <code>MaxConcurrency</code> value specified by the user when the operation started,
53895397
* indicating the maximum number of resources that the runbook operation can run on at the same

clients/client-ssm/src/models/models_1.ts

+9-7
Original file line numberDiff line numberDiff line change
@@ -1254,13 +1254,13 @@ export interface GetCommandInvocationRequest {
12541254
InstanceId: string | undefined;
12551255

12561256
/**
1257-
* <p>The name of the plugin for which you want detailed results. If the document contains only
1258-
* one plugin, you can omit the name and details for that plugin. If the document contains more than
1259-
* one plugin, you must specify the name of the plugin for which you want to view details.</p>
1260-
* <p>Plugin names are also referred to as <i>step names</i> in Systems Manager documents (SSM
1261-
* documents). For example, <code>aws:RunShellScript</code> is a plugin.</p>
1257+
* <p>The name of the step for which you want detailed results. If the document contains only one
1258+
* step, you can omit the name and details for that step. If the document contains more than one
1259+
* step, you must specify the name of the step for which you want to view details. Be sure to
1260+
* specify the name of the step, not the name of a plugin like
1261+
* <code>aws:RunShellScript</code>.</p>
12621262
* <p>To find the <code>PluginName</code>, check the document content and find the name of the
1263-
* plugin. Alternatively, use <a>ListCommandInvocations</a> with the
1263+
* step you want details for. Alternatively, use <a>ListCommandInvocations</a> with the
12641264
* <code>CommandId</code> and <code>Details</code> parameters. The <code>PluginName</code> is the
12651265
* <code>Name</code> attribute of the <code>CommandPlugin</code> object in the
12661266
* <code>CommandPlugins</code> list.</p>
@@ -10331,7 +10331,9 @@ export interface UpdateAssociationRequest {
1033110331
/**
1033210332
* <p>Number of days to wait after the scheduled day to run an association. For example, if you
1033310333
* specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3
10334-
* to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
10334+
* to run the association each Sunday after the second Thursday of the month. For more information
10335+
* about cron schedules for associations, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html">Reference: Cron
10336+
* and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
1033510337
* <note>
1033610338
* <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This
1033710339
* option tells the system not to run an association immediately after you create it. </p>

clients/client-ssm/src/protocols/Aws_json1_1.ts

+6
Original file line numberDiff line numberDiff line change
@@ -14441,6 +14441,8 @@ const serializeAws_json1_1Runbook = (input: Runbook, context: __SerdeContext): a
1444114441
input.TargetLocations !== null && {
1444214442
TargetLocations: serializeAws_json1_1TargetLocations(input.TargetLocations, context),
1444314443
}),
14444+
...(input.TargetMaps !== undefined &&
14445+
input.TargetMaps !== null && { TargetMaps: serializeAws_json1_1TargetMaps(input.TargetMaps, context) }),
1444414446
...(input.TargetParameterName !== undefined &&
1444514447
input.TargetParameterName !== null && { TargetParameterName: input.TargetParameterName }),
1444614448
...(input.Targets !== undefined &&
@@ -20676,6 +20678,10 @@ const deserializeAws_json1_1Runbook = (output: any, context: __SerdeContext): Ru
2067620678
output.TargetLocations !== undefined && output.TargetLocations !== null
2067720679
? deserializeAws_json1_1TargetLocations(output.TargetLocations, context)
2067820680
: undefined,
20681+
TargetMaps:
20682+
output.TargetMaps !== undefined && output.TargetMaps !== null
20683+
? deserializeAws_json1_1TargetMaps(output.TargetMaps, context)
20684+
: undefined,
2067920685
TargetParameterName: __expectString(output.TargetParameterName),
2068020686
Targets:
2068120687
output.Targets !== undefined && output.Targets !== null

0 commit comments

Comments
 (0)