From 35113ae0981456900f458ed78e48a5c039e575c1 Mon Sep 17 00:00:00 2001
From: awstools
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
+For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the diff --git a/clients/client-ssm/src/SSM.ts b/clients/client-ssm/src/SSM.ts index 076bf8f49d74..7ac20215cc41 100644 --- a/clients/client-ssm/src/SSM.ts +++ b/clients/client-ssm/src/SSM.ts @@ -3082,7 +3082,7 @@ export interface SSM { *
*For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
+ *For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
*For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the diff --git a/clients/client-ssm/src/SSMClient.ts b/clients/client-ssm/src/SSMClient.ts index 141baf001a62..33de2c4bf29b 100644 --- a/clients/client-ssm/src/SSMClient.ts +++ b/clients/client-ssm/src/SSMClient.ts @@ -945,7 +945,7 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {} *
*For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
+ *For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
*For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
diff --git a/clients/client-ssm/src/commands/DescribeAutomationExecutionsCommand.ts b/clients/client-ssm/src/commands/DescribeAutomationExecutionsCommand.ts
index d9fd19116ecf..dd9e8bda70a2 100644
--- a/clients/client-ssm/src/commands/DescribeAutomationExecutionsCommand.ts
+++ b/clients/client-ssm/src/commands/DescribeAutomationExecutionsCommand.ts
@@ -69,7 +69,7 @@ export interface DescribeAutomationExecutionsCommandOutput
* // AutomationExecutionId: "STRING_VALUE",
* // DocumentName: "STRING_VALUE",
* // DocumentVersion: "STRING_VALUE",
- * // AutomationExecutionStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure",
+ * // AutomationExecutionStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure" || "Exited",
* // ExecutionStartTime: new Date("TIMESTAMP"),
* // ExecutionEndTime: new Date("TIMESTAMP"),
* // ExecutedBy: "STRING_VALUE",
diff --git a/clients/client-ssm/src/commands/DescribeAutomationStepExecutionsCommand.ts b/clients/client-ssm/src/commands/DescribeAutomationStepExecutionsCommand.ts
index 5e65bf011dcf..382f76ca7c3c 100644
--- a/clients/client-ssm/src/commands/DescribeAutomationStepExecutionsCommand.ts
+++ b/clients/client-ssm/src/commands/DescribeAutomationStepExecutionsCommand.ts
@@ -54,7 +54,7 @@ export interface DescribeAutomationStepExecutionsCommandOutput
* AutomationExecutionId: "STRING_VALUE", // required
* Filters: [ // StepExecutionFilterList
* { // StepExecutionFilter
- * Key: "StartTimeBefore" || "StartTimeAfter" || "StepExecutionStatus" || "StepExecutionId" || "StepName" || "Action", // required
+ * Key: "StartTimeBefore" || "StartTimeAfter" || "StepExecutionStatus" || "StepExecutionId" || "StepName" || "Action" || "ParentStepExecutionId" || "ParentStepIteration" || "ParentStepIteratorValue", // required
* Values: [ // StepExecutionFilterValueList // required
* "STRING_VALUE",
* ],
@@ -76,7 +76,7 @@ export interface DescribeAutomationStepExecutionsCommandOutput
* // MaxAttempts: Number("int"),
* // ExecutionStartTime: new Date("TIMESTAMP"),
* // ExecutionEndTime: new Date("TIMESTAMP"),
- * // StepStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure",
+ * // StepStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure" || "Exited",
* // ResponseCode: "STRING_VALUE",
* // Inputs: { // NormalStringMap
* // "
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
+ *For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
*For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the diff --git a/clients/client-ssm/src/models/models_0.ts b/clients/client-ssm/src/models/models_0.ts index 12bf72f1225c..383250e6dfae 100644 --- a/clients/client-ssm/src/models/models_0.ts +++ b/clients/client-ssm/src/models/models_0.ts @@ -3113,7 +3113,7 @@ export interface CreateOpsItemRequest { *
- * /aws/insights
+ * /aws/insight
*
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate * OpsItems.
@@ -5610,6 +5610,7 @@ export const AutomationExecutionStatus = { CHANGE_CALENDAR_OVERRIDE_REJECTED: "ChangeCalendarOverrideRejected", COMPLETED_WITH_FAILURE: "CompletedWithFailure", COMPLETED_WITH_SUCCESS: "CompletedWithSuccess", + EXITED: "Exited", FAILED: "Failed", INPROGRESS: "InProgress", PENDING: "Pending", @@ -6048,6 +6049,9 @@ export class AutomationExecutionNotFoundException extends __BaseException { */ export const StepExecutionFilterKey = { ACTION: "Action", + PARENT_STEP_EXECUTION_ID: "ParentStepExecutionId", + PARENT_STEP_ITERATION: "ParentStepIteration", + PARENT_STEP_ITERATOR_VALUE: "ParentStepIteratorValue", START_TIME_AFTER: "StartTimeAfter", START_TIME_BEFORE: "StartTimeBefore", STEP_EXECUTION_ID: "StepExecutionId", @@ -6067,8 +6071,7 @@ export type StepExecutionFilterKey = (typeof StepExecutionFilterKey)[keyof typeo export interface StepExecutionFilter { /** * @public - *One or more keys to limit the results. Valid filter keys include the following: StepName, - * Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.
+ *One or more keys to limit the results.
*/ Key: StepExecutionFilterKey | undefined; @@ -6143,6 +6146,42 @@ export interface FailureDetails { Details?: RecordA detailed status of the parent step.
+ */ +export interface ParentStepDetails { + /** + * @public + *The unique ID of a step execution.
+ */ + StepExecutionId?: string; + + /** + * @public + *The name of the step.
+ */ + StepName?: string; + + /** + * @public + *The name of the automation action.
+ */ + Action?: string; + + /** + * @public + *The current repetition of the loop represented by an integer.
+ */ + Iteration?: number; + + /** + * @public + *The current value of the specified iterator in the loop.
+ */ + IteratorValue?: string; +} + /** * @public *Detailed information about an the execution state of an Automation step.
@@ -6294,6 +6333,12 @@ export interface StepExecution { *The CloudWatch alarms that were invoked by the automation.
*/ TriggeredAlarms?: AlarmStateInformation[]; + + /** + * @public + *Information about the parent step.
+ */ + ParentStepDetails?: ParentStepDetails; } /** @@ -7659,6 +7704,8 @@ export interface DescribeInstancePatchesRequest { *Sample values: Installed
| InstalledOther
|
* InstalledPendingReboot
*
For lists of all State
values, see Understanding
+ * patch compliance state values in the Amazon Web Services Systems Manager User Guide.
Information about a task defined for a maintenance window.
- */ -export interface MaintenanceWindowTask { - /** - * @public - *The ID of the maintenance window where the task is registered.
- */ - WindowId?: string; - - /** - * @public - *The task ID.
- */ - WindowTaskId?: string; - - /** - * @public - *The resource that the task uses during execution. For RUN_COMMAND
and
- * AUTOMATION
task types, TaskArn
is the Amazon Web Services Systems Manager (SSM document) name or
- * ARN. For LAMBDA
tasks, it's the function name or ARN. For
- * STEP_FUNCTIONS
tasks, it's the state machine ARN.
The type of task.
- */ - Type?: MaintenanceWindowTaskType; - - /** - * @public - *The targets (either managed nodes or tags). Managed nodes are specified using
- * Key=instanceids,Values=
. Tags are specified
- * using Key=
.
The parameters that should be passed to the task when it is run.
- *
- * TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs,
- * instead use the Parameters
option in the TaskInvocationParameters
structure. For information
- * about how Systems Manager handles these options for the supported maintenance window task
- * types, see MaintenanceWindowTaskInvocationParameters.
The priority of the task in the maintenance window. The lower the number, the higher the - * priority. Tasks that have the same priority are scheduled in parallel.
- */ - Priority?: number; - - /** - * @public - *Information about an S3 bucket to write task-level logs to.
- *
- * LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
- * OutputS3BucketName
and OutputS3KeyPrefix
options in the TaskInvocationParameters
structure.
- * For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
- * window task types, see MaintenanceWindowTaskInvocationParameters.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service - * (Amazon SNS) notifications for maintenance window Run Command tasks.
- */ - ServiceRoleArn?: string; - - /** - * @public - *The maximum number of targets this task can be run for, in parallel.
- *Although this element is listed as "Required: No", a value can be omitted only when you are - * registering or updating a targetless - * task You must provide a value in all other cases.
- *For maintenance window tasks without a target specified, you can't supply a value for this
- * option. Instead, the system inserts a placeholder value of 1
. This value doesn't
- * affect the running of your task.
The maximum number of errors allowed before this task stops being scheduled.
- *Although this element is listed as "Required: No", a value can be omitted only when you are - * registering or updating a targetless - * task You must provide a value in all other cases.
- *For maintenance window tasks without a target specified, you can't supply a value for this
- * option. Instead, the system inserts a placeholder value of 1
. This value doesn't
- * affect the running of your task.
The task name.
- */ - Name?: string; - - /** - * @public - *A description of the task.
- */ - Description?: string; - - /** - * @public - *The specification for whether tasks should continue to run after the cutoff time specified - * in the maintenance windows is reached.
- */ - CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior; - - /** - * @public - *The details for the CloudWatch alarm applied to your maintenance window task.
- */ - AlarmConfiguration?: AlarmConfiguration; -} - /** * @internal */ @@ -9639,12 +9552,3 @@ export const MaintenanceWindowTaskParameterValueExpressionFilterSensitiveLog = ( ...obj, ...(obj.Values && { Values: SENSITIVE_STRING }), }); - -/** - * @internal - */ -export const MaintenanceWindowTaskFilterSensitiveLog = (obj: MaintenanceWindowTask): any => ({ - ...obj, - ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), - ...(obj.Description && { Description: SENSITIVE_STRING }), -}); diff --git a/clients/client-ssm/src/models/models_1.ts b/clients/client-ssm/src/models/models_1.ts index 16706d2c78ab..e8ef995e9668 100644 --- a/clients/client-ssm/src/models/models_1.ts +++ b/clients/client-ssm/src/models/models_1.ts @@ -20,9 +20,7 @@ import { LoggingInfo, MaintenanceWindowExecutionStatus, MaintenanceWindowResourceType, - MaintenanceWindowTask, MaintenanceWindowTaskCutoffBehavior, - MaintenanceWindowTaskFilterSensitiveLog, MaintenanceWindowTaskParameterValueExpression, MaintenanceWindowTaskType, MetadataValue, @@ -51,6 +49,140 @@ import { } from "./models_0"; import { SSMServiceException as __BaseException } from "./SSMServiceException"; +/** + * @public + *Information about a task defined for a maintenance window.
+ */ +export interface MaintenanceWindowTask { + /** + * @public + *The ID of the maintenance window where the task is registered.
+ */ + WindowId?: string; + + /** + * @public + *The task ID.
+ */ + WindowTaskId?: string; + + /** + * @public + *The resource that the task uses during execution. For RUN_COMMAND
and
+ * AUTOMATION
task types, TaskArn
is the Amazon Web Services Systems Manager (SSM document) name or
+ * ARN. For LAMBDA
tasks, it's the function name or ARN. For
+ * STEP_FUNCTIONS
tasks, it's the state machine ARN.
The type of task.
+ */ + Type?: MaintenanceWindowTaskType; + + /** + * @public + *The targets (either managed nodes or tags). Managed nodes are specified using
+ * Key=instanceids,Values=
. Tags are specified
+ * using Key=
.
The parameters that should be passed to the task when it is run.
+ *
+ * TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs,
+ * instead use the Parameters
option in the TaskInvocationParameters
structure. For information
+ * about how Systems Manager handles these options for the supported maintenance window task
+ * types, see MaintenanceWindowTaskInvocationParameters.
The priority of the task in the maintenance window. The lower the number, the higher the + * priority. Tasks that have the same priority are scheduled in parallel.
+ */ + Priority?: number; + + /** + * @public + *Information about an S3 bucket to write task-level logs to.
+ *
+ * LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
+ * OutputS3BucketName
and OutputS3KeyPrefix
options in the TaskInvocationParameters
structure.
+ * For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
+ * window task types, see MaintenanceWindowTaskInvocationParameters.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service + * (Amazon SNS) notifications for maintenance window Run Command tasks.
+ */ + ServiceRoleArn?: string; + + /** + * @public + *The maximum number of targets this task can be run for, in parallel.
+ *Although this element is listed as "Required: No", a value can be omitted only when you are + * registering or updating a targetless + * task You must provide a value in all other cases.
+ *For maintenance window tasks without a target specified, you can't supply a value for this
+ * option. Instead, the system inserts a placeholder value of 1
. This value doesn't
+ * affect the running of your task.
The maximum number of errors allowed before this task stops being scheduled.
+ *Although this element is listed as "Required: No", a value can be omitted only when you are + * registering or updating a targetless + * task You must provide a value in all other cases.
+ *For maintenance window tasks without a target specified, you can't supply a value for this
+ * option. Instead, the system inserts a placeholder value of 1
. This value doesn't
+ * affect the running of your task.
The task name.
+ */ + Name?: string; + + /** + * @public + *A description of the task.
+ */ + Description?: string; + + /** + * @public + *The specification for whether tasks should continue to run after the cutoff time specified + * in the maintenance windows is reached.
+ */ + CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior; + + /** + * @public + *The details for the CloudWatch alarm applied to your maintenance window task.
+ */ + AlarmConfiguration?: AlarmConfiguration; +} + /** * @public */ @@ -367,7 +499,7 @@ export interface OpsItemSummary { *
- * /aws/insights
+ * /aws/insight
*
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate * OpsItems.
@@ -1663,6 +1795,12 @@ export interface AutomationExecution { *The name of the Change Manager change request.
*/ ChangeRequestName?: string; + + /** + * @public + *Variables defined for the automation.
+ */ + Variables?: Record
- * /aws/insights
+ * /aws/insight
*
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate * OpsItems.
@@ -10737,15 +10875,13 @@ export interface TerminateSessionRequest { } /** - * @public + * @internal */ -export interface TerminateSessionResponse { - /** - * @public - *The ID of the session that has been terminated.
- */ - SessionId?: string; -} +export const MaintenanceWindowTaskFilterSensitiveLog = (obj: MaintenanceWindowTask): any => ({ + ...obj, + ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), + ...(obj.Description && { Description: SENSITIVE_STRING }), +}); /** * @internal diff --git a/clients/client-ssm/src/models/models_2.ts b/clients/client-ssm/src/models/models_2.ts index 1fd61bfeb78c..51799b82a5a3 100644 --- a/clients/client-ssm/src/models/models_2.ts +++ b/clients/client-ssm/src/models/models_2.ts @@ -43,6 +43,17 @@ import { } from "./models_1"; import { SSMServiceException as __BaseException } from "./SSMServiceException"; +/** + * @public + */ +export interface TerminateSessionResponse { + /** + * @public + *The ID of the session that has been terminated.
+ */ + SessionId?: string; +} + /** * @public */ @@ -1794,47 +1805,36 @@ export interface UpdateServiceSettingRequest { * values for each setting. *
- * /ssm/managed-instance/default-ec2-instance-management-role: The name of an IAM role
- *
For /ssm/managed-instance/default-ec2-instance-management-role
, enter the
+ * name of an IAM role.
- * /ssm/automation/customer-script-log-destination
: CloudWatch
- *
For /ssm/automation/customer-script-log-destination
, enter CloudWatch
.
- * /ssm/automation/customer-script-log-group-name
: The name of an Amazon CloudWatch Logs log group
For /ssm/automation/customer-script-log-group-name
, enter the name of an
+ * Amazon CloudWatch Logs log group.
- * /ssm/documents/console/public-sharing-permission
: Enable
or
- * Disable
- *
For /ssm/documents/console/public-sharing-permission
, enter
+ * Enable
or Disable
.
- * /ssm/managed-instance/activation-tier
: standard
or
- * advanced
- *
For /ssm/managed-instance/activation-tier
, enter standard
or
+ * advanced
.
- * /ssm/opsinsights/opscenter
: Enabled
or Disabled
- *
For /ssm/opsinsights/opscenter
, enter Enabled
or
+ * Disabled
.
- * /ssm/parameter-store/default-parameter-tier
: Standard
,
- * Advanced
, Intelligent-Tiering
+ *
For /ssm/parameter-store/default-parameter-tier
, enter Standard
,
+ * Advanced
, or Intelligent-Tiering
*
- * /ssm/parameter-store/high-throughput-enabled
: true
or
- * false
- *
For /ssm/parameter-store/high-throughput-enabled
, enter true
or
+ * false
.
Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
\n\n Related resources\n
\nFor information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
\nFor details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the\n \n Systems Manager Automation runbook reference\n .
\nFor information about AppConfig, a capability of Systems Manager, see the \n AppConfig User Guide\n \n and the \n AppConfig\n API Reference\n .
\nFor information about Incident Manager, a capability of Systems Manager, see the \n Systems Manager Incident Manager User\n Guide\n and the \n Systems Manager Incident Manager API\n Reference\n .
\nAmazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.
\nThis reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
\n\n Related resources\n
\nFor information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
\nFor details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the\n \n Systems Manager Automation runbook reference\n .
\nFor information about AppConfig, a capability of Systems Manager, see the \n AppConfig User Guide\n \n and the \n AppConfig\n API Reference\n .
\nFor information about Incident Manager, a capability of Systems Manager, see the \n Systems Manager Incident Manager User\n Guide\n and the \n Systems Manager Incident Manager API\n Reference\n .
\nThe name of the Change Manager change request.
" } + }, + "Variables": { + "target": "com.amazonaws.ssm#AutomationParameterMap", + "traits": { + "smithy.api#documentation": "Variables defined for the automation.
" + } } }, "traits": { @@ -3989,6 +3995,12 @@ "traits": { "smithy.api#enumValue": "CompletedWithFailure" } + }, + "EXITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Exited" + } } } }, @@ -6370,7 +6382,7 @@ "OpsItemType": { "target": "com.amazonaws.ssm#OpsItemType", "traits": { - "smithy.api#documentation": "The type of OpsItem to create. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue
\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest
\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights
\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem to create. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue
\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest
\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight
\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nEach element in the array is a structure containing a key-value pair.
\nSupported keys for DescribeInstancePatches
include the following:
\n \n Classification
\n \n
Sample values: Security
| SecurityUpdates
\n
\n \n KBId
\n \n
Sample values: KB4480056
| java-1.7.0-openjdk.x86_64
\n
\n \n Severity
\n \n
Sample values: Important
| Medium
| Low
\n
\n \n State
\n \n
Sample values: Installed
| InstalledOther
|\n InstalledPendingReboot
\n
Each element in the array is a structure containing a key-value pair.
\nSupported keys for DescribeInstancePatches
include the following:
\n \n Classification
\n \n
Sample values: Security
| SecurityUpdates
\n
\n \n KBId
\n \n
Sample values: KB4480056
| java-1.7.0-openjdk.x86_64
\n
\n \n Severity
\n \n
Sample values: Important
| Medium
| Low
\n
\n \n State
\n \n
Sample values: Installed
| InstalledOther
|\n InstalledPendingReboot
\n
For lists of all State
values, see Understanding\n patch compliance state values in the Amazon Web Services Systems Manager User Guide.
The type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue
\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest
\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights
\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue
\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest
\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight
\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue
\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest
\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights
\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue
\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest
\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight
\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe unique ID of a step execution.
" + } + }, + "StepName": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "Action": { + "target": "com.amazonaws.ssm#AutomationActionName", + "traits": { + "smithy.api#documentation": "The name of the automation action.
" + } + }, + "Iteration": { + "target": "com.amazonaws.ssm#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The current repetition of the loop represented by an integer.
" + } + }, + "IteratorValue": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The current value of the specified iterator in the loop.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A detailed status of the parent step.
" + } + }, "com.amazonaws.ssm#Patch": { "type": "structure", "members": { @@ -27231,6 +27282,12 @@ "traits": { "smithy.api#documentation": "The CloudWatch alarms that were invoked by the automation.
" } + }, + "ParentStepDetails": { + "target": "com.amazonaws.ssm#ParentStepDetails", + "traits": { + "smithy.api#documentation": "Information about the parent step.
" + } } }, "traits": { @@ -27243,7 +27300,7 @@ "Key": { "target": "com.amazonaws.ssm#StepExecutionFilterKey", "traits": { - "smithy.api#documentation": "One or more keys to limit the results. Valid filter keys include the following: StepName,\n Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.
", + "smithy.api#documentation": "One or more keys to limit the results.
", "smithy.api#required": {} } }, @@ -27297,6 +27354,24 @@ "traits": { "smithy.api#enumValue": "Action" } + }, + "PARENT_STEP_EXECUTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentStepExecutionId" + } + }, + "PARENT_STEP_ITERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentStepIteration" + } + }, + "PARENT_STEP_ITERATOR_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentStepIteratorValue" + } } } }, @@ -29633,7 +29708,7 @@ "SettingValue": { "target": "com.amazonaws.ssm#ServiceSettingValue", "traits": { - "smithy.api#documentation": "The new value to specify for the service setting. The following list specifies the available\n values for each setting.
\n\n /ssm/managed-instance/default-ec2-instance-management-role: The name of an IAM role
\n
\n /ssm/automation/customer-script-log-destination
: CloudWatch
\n
\n /ssm/automation/customer-script-log-group-name
: The name of an Amazon CloudWatch Logs log group
\n /ssm/documents/console/public-sharing-permission
: Enable
or\n Disable
\n
\n /ssm/managed-instance/activation-tier
: standard
or\n advanced
\n
\n /ssm/opsinsights/opscenter
: Enabled
or Disabled
\n
\n /ssm/parameter-store/default-parameter-tier
: Standard
,\n Advanced
, Intelligent-Tiering
\n
\n /ssm/parameter-store/high-throughput-enabled
: true
or\n false
\n
The new value to specify for the service setting. The following list specifies the available\n values for each setting.
\nFor /ssm/managed-instance/default-ec2-instance-management-role
, enter the\n name of an IAM role.
For /ssm/automation/customer-script-log-destination
, enter CloudWatch
.
For /ssm/automation/customer-script-log-group-name
, enter the name of an\n Amazon CloudWatch Logs log group.
For /ssm/documents/console/public-sharing-permission
, enter\n Enable
or Disable
.
For /ssm/managed-instance/activation-tier
, enter standard
or\n advanced
.
For /ssm/opsinsights/opscenter
, enter Enabled
or\n Disabled
.
For /ssm/parameter-store/default-parameter-tier
, enter Standard
,\n Advanced
, or Intelligent-Tiering
\n
For /ssm/parameter-store/high-throughput-enabled
, enter true
or\n false
.