Skip to content

Commit 35113ae

Browse files
author
awstools
committed
feat(client-ssm): This release introduces the ability to filter automation execution steps which have parent steps. In addition, runbook variable information is returned by GetAutomationExecution and parent step information is returned by the DescribeAutomationStepExecutions API.
1 parent e9e1aaa commit 35113ae

File tree

13 files changed

+336
-201
lines changed

13 files changed

+336
-201
lines changed

clients/client-ssm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ operations at scale.</p>
1515
</p>
1616
<ul>
1717
<li>
18-
<p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
18+
<p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
1919
</li>
2020
<li>
2121
<p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the

clients/client-ssm/src/SSM.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3082,7 +3082,7 @@ export interface SSM {
30823082
* </p>
30833083
* <ul>
30843084
* <li>
3085-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3085+
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
30863086
* </li>
30873087
* <li>
30883088
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the

clients/client-ssm/src/SSMClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -945,7 +945,7 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
945945
* </p>
946946
* <ul>
947947
* <li>
948-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
948+
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
949949
* </li>
950950
* <li>
951951
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export interface DescribeAutomationExecutionsCommandOutput
6969
* // AutomationExecutionId: "STRING_VALUE",
7070
* // DocumentName: "STRING_VALUE",
7171
* // DocumentVersion: "STRING_VALUE",
72-
* // AutomationExecutionStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure",
72+
* // AutomationExecutionStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure" || "Exited",
7373
* // ExecutionStartTime: new Date("TIMESTAMP"),
7474
* // ExecutionEndTime: new Date("TIMESTAMP"),
7575
* // ExecutedBy: "STRING_VALUE",

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export interface DescribeAutomationStepExecutionsCommandOutput
5454
* AutomationExecutionId: "STRING_VALUE", // required
5555
* Filters: [ // StepExecutionFilterList
5656
* { // StepExecutionFilter
57-
* Key: "StartTimeBefore" || "StartTimeAfter" || "StepExecutionStatus" || "StepExecutionId" || "StepName" || "Action", // required
57+
* Key: "StartTimeBefore" || "StartTimeAfter" || "StepExecutionStatus" || "StepExecutionId" || "StepName" || "Action" || "ParentStepExecutionId" || "ParentStepIteration" || "ParentStepIteratorValue", // required
5858
* Values: [ // StepExecutionFilterValueList // required
5959
* "STRING_VALUE",
6060
* ],
@@ -76,7 +76,7 @@ export interface DescribeAutomationStepExecutionsCommandOutput
7676
* // MaxAttempts: Number("int"),
7777
* // ExecutionStartTime: new Date("TIMESTAMP"),
7878
* // ExecutionEndTime: new Date("TIMESTAMP"),
79-
* // StepStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure",
79+
* // StepStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure" || "Exited",
8080
* // ResponseCode: "STRING_VALUE",
8181
* // Inputs: { // NormalStringMap
8282
* // "<keys>": "STRING_VALUE",
@@ -142,6 +142,13 @@ export interface DescribeAutomationStepExecutionsCommandOutput
142142
* // State: "UNKNOWN" || "ALARM", // required
143143
* // },
144144
* // ],
145+
* // ParentStepDetails: { // ParentStepDetails
146+
* // StepExecutionId: "STRING_VALUE",
147+
* // StepName: "STRING_VALUE",
148+
* // Action: "STRING_VALUE",
149+
* // Iteration: Number("int"),
150+
* // IteratorValue: "STRING_VALUE",
151+
* // },
145152
* // },
146153
* // ],
147154
* // NextToken: "STRING_VALUE",

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
5656
* // DocumentVersion: "STRING_VALUE",
5757
* // ExecutionStartTime: new Date("TIMESTAMP"),
5858
* // ExecutionEndTime: new Date("TIMESTAMP"),
59-
* // AutomationExecutionStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure",
59+
* // AutomationExecutionStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure" || "Exited",
6060
* // StepExecutions: [ // StepExecutionList
6161
* // { // StepExecution
6262
* // StepName: "STRING_VALUE",
@@ -66,7 +66,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
6666
* // MaxAttempts: Number("int"),
6767
* // ExecutionStartTime: new Date("TIMESTAMP"),
6868
* // ExecutionEndTime: new Date("TIMESTAMP"),
69-
* // StepStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure",
69+
* // StepStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure" || "Exited",
7070
* // ResponseCode: "STRING_VALUE",
7171
* // Inputs: { // NormalStringMap
7272
* // "<keys>": "STRING_VALUE",
@@ -132,6 +132,13 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
132132
* // State: "UNKNOWN" || "ALARM", // required
133133
* // },
134134
* // ],
135+
* // ParentStepDetails: { // ParentStepDetails
136+
* // StepExecutionId: "STRING_VALUE",
137+
* // StepName: "STRING_VALUE",
138+
* // Action: "STRING_VALUE",
139+
* // Iteration: Number("int"),
140+
* // IteratorValue: "STRING_VALUE",
141+
* // },
135142
* // },
136143
* // ],
137144
* // StepExecutionsTruncated: true || false,
@@ -236,6 +243,7 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut
236243
* // OpsItemId: "STRING_VALUE",
237244
* // AssociationId: "STRING_VALUE",
238245
* // ChangeRequestName: "STRING_VALUE",
246+
* // Variables: "<AutomationParameterMap>",
239247
* // },
240248
* // };
241249
*

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ import {
1414
SMITHY_CONTEXT_KEY,
1515
} from "@smithy/types";
1616

17-
import { TerminateSessionRequest, TerminateSessionResponse } from "../models/models_1";
17+
import { TerminateSessionRequest } from "../models/models_1";
18+
import { TerminateSessionResponse } from "../models/models_2";
1819
import { de_TerminateSessionCommand, se_TerminateSessionCommand } from "../protocols/Aws_json1_1";
1920
import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient";
2021

clients/client-ssm/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* </p>
1111
* <ul>
1212
* <li>
13-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
13+
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
1414
* </li>
1515
* <li>
1616
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the

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

Lines changed: 50 additions & 146 deletions
Original file line numberDiff line numberDiff line change
@@ -3113,7 +3113,7 @@ export interface CreateOpsItemRequest {
31133113
* </li>
31143114
* <li>
31153115
* <p>
3116-
* <code>/aws/insights</code>
3116+
* <code>/aws/insight</code>
31173117
* </p>
31183118
* <p>This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate
31193119
* OpsItems. </p>
@@ -5610,6 +5610,7 @@ export const AutomationExecutionStatus = {
56105610
CHANGE_CALENDAR_OVERRIDE_REJECTED: "ChangeCalendarOverrideRejected",
56115611
COMPLETED_WITH_FAILURE: "CompletedWithFailure",
56125612
COMPLETED_WITH_SUCCESS: "CompletedWithSuccess",
5613+
EXITED: "Exited",
56135614
FAILED: "Failed",
56145615
INPROGRESS: "InProgress",
56155616
PENDING: "Pending",
@@ -6048,6 +6049,9 @@ export class AutomationExecutionNotFoundException extends __BaseException {
60486049
*/
60496050
export const StepExecutionFilterKey = {
60506051
ACTION: "Action",
6052+
PARENT_STEP_EXECUTION_ID: "ParentStepExecutionId",
6053+
PARENT_STEP_ITERATION: "ParentStepIteration",
6054+
PARENT_STEP_ITERATOR_VALUE: "ParentStepIteratorValue",
60516055
START_TIME_AFTER: "StartTimeAfter",
60526056
START_TIME_BEFORE: "StartTimeBefore",
60536057
STEP_EXECUTION_ID: "StepExecutionId",
@@ -6067,8 +6071,7 @@ export type StepExecutionFilterKey = (typeof StepExecutionFilterKey)[keyof typeo
60676071
export interface StepExecutionFilter {
60686072
/**
60696073
* @public
6070-
* <p>One or more keys to limit the results. Valid filter keys include the following: StepName,
6071-
* Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.</p>
6074+
* <p>One or more keys to limit the results.</p>
60726075
*/
60736076
Key: StepExecutionFilterKey | undefined;
60746077

@@ -6143,6 +6146,42 @@ export interface FailureDetails {
61436146
Details?: Record<string, string[]>;
61446147
}
61456148

6149+
/**
6150+
* @public
6151+
* <p>A detailed status of the parent step.</p>
6152+
*/
6153+
export interface ParentStepDetails {
6154+
/**
6155+
* @public
6156+
* <p>The unique ID of a step execution.</p>
6157+
*/
6158+
StepExecutionId?: string;
6159+
6160+
/**
6161+
* @public
6162+
* <p>The name of the step.</p>
6163+
*/
6164+
StepName?: string;
6165+
6166+
/**
6167+
* @public
6168+
* <p>The name of the automation action.</p>
6169+
*/
6170+
Action?: string;
6171+
6172+
/**
6173+
* @public
6174+
* <p>The current repetition of the loop represented by an integer.</p>
6175+
*/
6176+
Iteration?: number;
6177+
6178+
/**
6179+
* @public
6180+
* <p>The current value of the specified iterator in the loop.</p>
6181+
*/
6182+
IteratorValue?: string;
6183+
}
6184+
61466185
/**
61476186
* @public
61486187
* <p>Detailed information about an the execution state of an Automation step.</p>
@@ -6294,6 +6333,12 @@ export interface StepExecution {
62946333
* <p>The CloudWatch alarms that were invoked by the automation.</p>
62956334
*/
62966335
TriggeredAlarms?: AlarmStateInformation[];
6336+
6337+
/**
6338+
* @public
6339+
* <p>Information about the parent step.</p>
6340+
*/
6341+
ParentStepDetails?: ParentStepDetails;
62976342
}
62986343

62996344
/**
@@ -7659,6 +7704,8 @@ export interface DescribeInstancePatchesRequest {
76597704
* <p>Sample values: <code>Installed</code> | <code>InstalledOther</code> |
76607705
* <code>InstalledPendingReboot</code>
76617706
* </p>
7707+
* <p>For lists of all <code>State</code> values, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-compliance-states.html">Understanding
7708+
* patch compliance state values</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
76627709
* </li>
76637710
* </ul>
76647711
*/
@@ -9309,140 +9356,6 @@ export interface MaintenanceWindowTaskParameterValueExpression {
93099356
Values?: string[];
93109357
}
93119358

9312-
/**
9313-
* @public
9314-
* <p>Information about a task defined for a maintenance window.</p>
9315-
*/
9316-
export interface MaintenanceWindowTask {
9317-
/**
9318-
* @public
9319-
* <p>The ID of the maintenance window where the task is registered.</p>
9320-
*/
9321-
WindowId?: string;
9322-
9323-
/**
9324-
* @public
9325-
* <p>The task ID.</p>
9326-
*/
9327-
WindowTaskId?: string;
9328-
9329-
/**
9330-
* @public
9331-
* <p>The resource that the task uses during execution. For <code>RUN_COMMAND</code> and
9332-
* <code>AUTOMATION</code> task types, <code>TaskArn</code> is the Amazon Web Services Systems Manager (SSM document) name or
9333-
* ARN. For <code>LAMBDA</code> tasks, it's the function name or ARN. For
9334-
* <code>STEP_FUNCTIONS</code> tasks, it's the state machine ARN.</p>
9335-
*/
9336-
TaskArn?: string;
9337-
9338-
/**
9339-
* @public
9340-
* <p>The type of task.</p>
9341-
*/
9342-
Type?: MaintenanceWindowTaskType;
9343-
9344-
/**
9345-
* @public
9346-
* <p>The targets (either managed nodes or tags). Managed nodes are specified using
9347-
* <code>Key=instanceids,Values=<instanceid1>,<instanceid2></code>. Tags are specified
9348-
* using <code>Key=<tag name>,Values=<tag value></code>.</p>
9349-
*/
9350-
Targets?: Target[];
9351-
9352-
/**
9353-
* @public
9354-
* <p>The parameters that should be passed to the task when it is run.</p>
9355-
* <note>
9356-
* <p>
9357-
* <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs,
9358-
* instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information
9359-
* about how Systems Manager handles these options for the supported maintenance window task
9360-
* types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
9361-
* </note>
9362-
*/
9363-
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression>;
9364-
9365-
/**
9366-
* @public
9367-
* <p>The priority of the task in the maintenance window. The lower the number, the higher the
9368-
* priority. Tasks that have the same priority are scheduled in parallel.</p>
9369-
*/
9370-
Priority?: number;
9371-
9372-
/**
9373-
* @public
9374-
* <p>Information about an S3 bucket to write task-level logs to.</p>
9375-
* <note>
9376-
* <p>
9377-
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
9378-
* <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure.
9379-
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
9380-
* window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
9381-
* </note>
9382-
*/
9383-
LoggingInfo?: LoggingInfo;
9384-
9385-
/**
9386-
* @public
9387-
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service
9388-
* (Amazon SNS) notifications for maintenance window Run Command tasks.</p>
9389-
*/
9390-
ServiceRoleArn?: string;
9391-
9392-
/**
9393-
* @public
9394-
* <p>The maximum number of targets this task can be run for, in parallel.</p>
9395-
* <note>
9396-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
9397-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
9398-
* task</a> You must provide a value in all other cases.</p>
9399-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
9400-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
9401-
* affect the running of your task.</p>
9402-
* </note>
9403-
*/
9404-
MaxConcurrency?: string;
9405-
9406-
/**
9407-
* @public
9408-
* <p>The maximum number of errors allowed before this task stops being scheduled.</p>
9409-
* <note>
9410-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
9411-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
9412-
* task</a> You must provide a value in all other cases.</p>
9413-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
9414-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
9415-
* affect the running of your task.</p>
9416-
* </note>
9417-
*/
9418-
MaxErrors?: string;
9419-
9420-
/**
9421-
* @public
9422-
* <p>The task name.</p>
9423-
*/
9424-
Name?: string;
9425-
9426-
/**
9427-
* @public
9428-
* <p>A description of the task.</p>
9429-
*/
9430-
Description?: string;
9431-
9432-
/**
9433-
* @public
9434-
* <p>The specification for whether tasks should continue to run after the cutoff time specified
9435-
* in the maintenance windows is reached. </p>
9436-
*/
9437-
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior;
9438-
9439-
/**
9440-
* @public
9441-
* <p>The details for the CloudWatch alarm applied to your maintenance window task.</p>
9442-
*/
9443-
AlarmConfiguration?: AlarmConfiguration;
9444-
}
9445-
94469359
/**
94479360
* @internal
94489361
*/
@@ -9639,12 +9552,3 @@ export const MaintenanceWindowTaskParameterValueExpressionFilterSensitiveLog = (
96399552
...obj,
96409553
...(obj.Values && { Values: SENSITIVE_STRING }),
96419554
});
9642-
9643-
/**
9644-
* @internal
9645-
*/
9646-
export const MaintenanceWindowTaskFilterSensitiveLog = (obj: MaintenanceWindowTask): any => ({
9647-
...obj,
9648-
...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }),
9649-
...(obj.Description && { Description: SENSITIVE_STRING }),
9650-
});

0 commit comments

Comments
 (0)