@aws-sdk/client-ssm 3.934.0 → 3.936.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +675 -676
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +674 -0
- package/dist-es/models/errors.js +1915 -0
- package/dist-es/models/models_0.js +1 -1375
- package/dist-es/models/models_1.js +1 -873
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowTargetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowTasksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeMaintenanceWindowsForTargetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeOpsItemsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchBaselinesCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchGroupStateCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSessionsCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateOpsItemRelatedItemCommand.d.ts +1 -1
- package/dist-types/commands/GetAccessTokenCommand.d.ts +1 -1
- package/dist-types/commands/GetAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/GetCalendarStateCommand.d.ts +1 -1
- package/dist-types/commands/GetCommandInvocationCommand.d.ts +1 -1
- package/dist-types/commands/GetConnectionStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetDefaultPatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/GetDeployablePatchSnapshotForInstanceCommand.d.ts +1 -1
- package/dist-types/commands/GetDocumentCommand.d.ts +1 -1
- package/dist-types/commands/GetExecutionPreviewCommand.d.ts +1 -1
- package/dist-types/commands/GetInventoryCommand.d.ts +2 -2
- package/dist-types/commands/GetInventorySchemaCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowExecutionCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowExecutionTaskCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowExecutionTaskInvocationCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowTaskCommand.d.ts +1 -1
- package/dist-types/commands/GetOpsItemCommand.d.ts +1 -1
- package/dist-types/commands/GetOpsMetadataCommand.d.ts +1 -1
- package/dist-types/commands/GetOpsSummaryCommand.d.ts +2 -2
- package/dist-types/commands/GetParameterCommand.d.ts +1 -1
- package/dist-types/commands/GetParameterHistoryCommand.d.ts +1 -1
- package/dist-types/commands/GetParametersByPathCommand.d.ts +1 -1
- package/dist-types/commands/GetParametersCommand.d.ts +1 -1
- package/dist-types/commands/GetPatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/GetPatchBaselineForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcePoliciesCommand.d.ts +1 -1
- package/dist-types/commands/GetServiceSettingCommand.d.ts +2 -1
- package/dist-types/commands/ListNodesSummaryCommand.d.ts +1 -2
- package/dist-types/commands/RegisterPatchBaselineForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/RegisterTargetWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/RegisterTaskWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/commands/ResetServiceSettingCommand.d.ts +1 -1
- package/dist-types/commands/ResumeSessionCommand.d.ts +1 -1
- package/dist-types/commands/SendAutomationSignalCommand.d.ts +1 -1
- package/dist-types/commands/SendCommandCommand.d.ts +1 -1
- package/dist-types/commands/StartAccessRequestCommand.d.ts +1 -1
- package/dist-types/commands/StartAssociationsOnceCommand.d.ts +1 -1
- package/dist-types/commands/StartAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/StartChangeRequestExecutionCommand.d.ts +1 -1
- package/dist-types/commands/StartExecutionPreviewCommand.d.ts +1 -1
- package/dist-types/commands/StartSessionCommand.d.ts +1 -1
- package/dist-types/commands/StopAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/TerminateSessionCommand.d.ts +1 -1
- package/dist-types/commands/UnlabelParameterVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssociationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssociationStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentDefaultVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMaintenanceWindowTargetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMaintenanceWindowTaskCommand.d.ts +1 -1
- package/dist-types/commands/UpdateManagedInstanceRoleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateOpsItemCommand.d.ts +1 -1
- package/dist-types/commands/UpdateOpsMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/UpdateResourceDataSyncCommand.d.ts +1 -1
- package/dist-types/commands/UpdateServiceSettingCommand.d.ts +1 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +1458 -0
- package/dist-types/models/errors.d.ts +1953 -0
- package/dist-types/models/models_0.d.ts +4526 -1781
- package/dist-types/models/models_1.d.ts +4042 -6926
- package/dist-types/ts3.4/commands/DescribeMaintenanceWindowScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeMaintenanceWindowTargetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeMaintenanceWindowTasksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeMaintenanceWindowsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeMaintenanceWindowsForTargetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeOpsItemsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeParametersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribePatchBaselinesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribePatchGroupStateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribePatchGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribePatchPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeSessionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DisassociateOpsItemRelatedItemCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAccessTokenCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetCalendarStateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetCommandInvocationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetConnectionStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDefaultPatchBaselineCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDeployablePatchSnapshotForInstanceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDocumentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetExecutionPreviewCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInventoryCommand.d.ts +2 -2
- package/dist-types/ts3.4/commands/GetInventorySchemaCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMaintenanceWindowExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMaintenanceWindowExecutionTaskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMaintenanceWindowExecutionTaskInvocationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMaintenanceWindowTaskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetOpsItemCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetOpsMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetOpsSummaryCommand.d.ts +2 -2
- package/dist-types/ts3.4/commands/GetParameterCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetParameterHistoryCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetParametersByPathCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetParametersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPatchBaselineCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPatchBaselineForPatchGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetResourcePoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetServiceSettingCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListNodesSummaryCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RegisterPatchBaselineForPatchGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterTargetWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterTaskWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ResetServiceSettingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ResumeSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendAutomationSignalCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendCommandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartAccessRequestCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartAssociationsOnceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartChangeRequestExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartExecutionPreviewCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TerminateSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UnlabelParameterVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssociationStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDocumentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDocumentDefaultVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDocumentMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateMaintenanceWindowTargetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateMaintenanceWindowTaskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateManagedInstanceRoleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateOpsItemCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateOpsMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePatchBaselineCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateResourceDataSyncCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateServiceSettingCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +844 -0
- package/dist-types/ts3.4/models/errors.d.ts +1191 -0
- package/dist-types/ts3.4/models/models_0.d.ts +905 -1047
- package/dist-types/ts3.4/models/models_1.d.ts +919 -1991
- package/package.json +19 -19
- package/dist-es/models/index.js +0 -3
- package/dist-es/models/models_2.js +0 -343
- package/dist-types/models/index.d.ts +0 -3
- package/dist-types/models/models_2.d.ts +0 -3276
- package/dist-types/ts3.4/models/index.d.ts +0 -3
- package/dist-types/ts3.4/models/models_2.d.ts +0 -764
|
@@ -1,3276 +0,0 @@
|
|
|
1
|
-
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
import { AlarmConfiguration, AssociationComplianceSeverity, AssociationDescription, AssociationStatus, AssociationSyncCompliance, AttachmentsSource, DocumentDescription, DocumentFormat, DocumentHashType, ExecutionMode, InstanceAssociationOutputLocation, MaintenanceWindowTaskType, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, PatchAction, PatchComplianceLevel, PatchComplianceStatus, PatchFilterGroup, PatchRuleGroup, PatchSource, RelatedOpsItem, ResourceDataSyncSource, ResourceTypeForTagging, Runbook, Tag, Target, TargetLocation } from "./models_0";
|
|
3
|
-
import { CloudWatchOutputConfig, Command, DocumentReviewCommentSource, InventoryFilter, InventoryGroup, LoggingInfo, MaintenanceWindowResourceType, MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskInvocationParameters, MaintenanceWindowTaskParameterValueExpression, NodeAggregatorType, NodeAttributeName, NodeFilter, NodeTypeName, NotificationConfig, OpsFilter, OpsItemStatus, OpsResultAttribute, ResultAttribute, ServiceSetting } from "./models_1";
|
|
4
|
-
import { SSMServiceException as __BaseException } from "./SSMServiceException";
|
|
5
|
-
/**
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export interface RegisterPatchBaselineForPatchGroupRequest {
|
|
9
|
-
/**
|
|
10
|
-
* <p>The ID of the patch baseline to register with the patch group.</p>
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
|
-
BaselineId: string | undefined;
|
|
14
|
-
/**
|
|
15
|
-
* <p>The name of the patch group to be registered with the patch baseline.</p>
|
|
16
|
-
* @public
|
|
17
|
-
*/
|
|
18
|
-
PatchGroup: string | undefined;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* @public
|
|
22
|
-
*/
|
|
23
|
-
export interface RegisterPatchBaselineForPatchGroupResult {
|
|
24
|
-
/**
|
|
25
|
-
* <p>The ID of the patch baseline the patch group was registered with.</p>
|
|
26
|
-
* @public
|
|
27
|
-
*/
|
|
28
|
-
BaselineId?: string | undefined;
|
|
29
|
-
/**
|
|
30
|
-
* <p>The name of the patch group registered with the patch baseline.</p>
|
|
31
|
-
* @public
|
|
32
|
-
*/
|
|
33
|
-
PatchGroup?: string | undefined;
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* @public
|
|
37
|
-
*/
|
|
38
|
-
export interface RegisterTargetWithMaintenanceWindowRequest {
|
|
39
|
-
/**
|
|
40
|
-
* <p>The ID of the maintenance window the target should be registered with.</p>
|
|
41
|
-
* @public
|
|
42
|
-
*/
|
|
43
|
-
WindowId: string | undefined;
|
|
44
|
-
/**
|
|
45
|
-
* <p>The type of target being registered with the maintenance window.</p>
|
|
46
|
-
* @public
|
|
47
|
-
*/
|
|
48
|
-
ResourceType: MaintenanceWindowResourceType | undefined;
|
|
49
|
-
/**
|
|
50
|
-
* <p>The targets to register with the maintenance window. In other words, the managed nodes to
|
|
51
|
-
* run commands on when the maintenance window runs.</p>
|
|
52
|
-
* <note>
|
|
53
|
-
* <p>If a single maintenance window task is registered with multiple targets, its task
|
|
54
|
-
* invocations occur sequentially and not in parallel. If your task must run on multiple targets at
|
|
55
|
-
* the same time, register a task for each target individually and assign each task the same
|
|
56
|
-
* priority level.</p>
|
|
57
|
-
* </note>
|
|
58
|
-
* <p>You can specify targets using managed node IDs, resource group names, or tags that have been
|
|
59
|
-
* applied to managed nodes.</p>
|
|
60
|
-
* <p>
|
|
61
|
-
* <b>Example 1</b>: Specify managed node IDs</p>
|
|
62
|
-
* <p>
|
|
63
|
-
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3></code>
|
|
64
|
-
* </p>
|
|
65
|
-
* <p>
|
|
66
|
-
* <b>Example 2</b>: Use tag key-pairs applied to managed
|
|
67
|
-
* nodes</p>
|
|
68
|
-
* <p>
|
|
69
|
-
* <code>Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2></code>
|
|
70
|
-
* </p>
|
|
71
|
-
* <p>
|
|
72
|
-
* <b>Example 3</b>: Use tag-keys applied to managed nodes</p>
|
|
73
|
-
* <p>
|
|
74
|
-
* <code>Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2></code>
|
|
75
|
-
* </p>
|
|
76
|
-
* <p>
|
|
77
|
-
* <b>Example 4</b>: Use resource group names</p>
|
|
78
|
-
* <p>
|
|
79
|
-
* <code>Key=resource-groups:Name,Values=<resource-group-name></code>
|
|
80
|
-
* </p>
|
|
81
|
-
* <p>
|
|
82
|
-
* <b>Example 5</b>: Use filters for resource group types</p>
|
|
83
|
-
* <p>
|
|
84
|
-
* <code>Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2></code>
|
|
85
|
-
* </p>
|
|
86
|
-
* <note>
|
|
87
|
-
* <p>For <code>Key=resource-groups:ResourceTypeFilters</code>, specify resource types in the
|
|
88
|
-
* following format</p>
|
|
89
|
-
* <p>
|
|
90
|
-
* <code>Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC</code>
|
|
91
|
-
* </p>
|
|
92
|
-
* </note>
|
|
93
|
-
* <p>For more information about these examples formats, including the best use case for each one,
|
|
94
|
-
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html">Examples: Register
|
|
95
|
-
* targets with a maintenance window</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
96
|
-
* @public
|
|
97
|
-
*/
|
|
98
|
-
Targets: Target[] | undefined;
|
|
99
|
-
/**
|
|
100
|
-
* <p>User-provided value that will be included in any Amazon CloudWatch Events events raised while
|
|
101
|
-
* running tasks for these targets in this maintenance window.</p>
|
|
102
|
-
* @public
|
|
103
|
-
*/
|
|
104
|
-
OwnerInformation?: string | undefined;
|
|
105
|
-
/**
|
|
106
|
-
* <p>An optional name for the target.</p>
|
|
107
|
-
* @public
|
|
108
|
-
*/
|
|
109
|
-
Name?: string | undefined;
|
|
110
|
-
/**
|
|
111
|
-
* <p>An optional description for the target.</p>
|
|
112
|
-
* @public
|
|
113
|
-
*/
|
|
114
|
-
Description?: string | undefined;
|
|
115
|
-
/**
|
|
116
|
-
* <p>User-provided idempotency token.</p>
|
|
117
|
-
* @public
|
|
118
|
-
*/
|
|
119
|
-
ClientToken?: string | undefined;
|
|
120
|
-
}
|
|
121
|
-
/**
|
|
122
|
-
* @public
|
|
123
|
-
*/
|
|
124
|
-
export interface RegisterTargetWithMaintenanceWindowResult {
|
|
125
|
-
/**
|
|
126
|
-
* <p>The ID of the target definition in this maintenance window.</p>
|
|
127
|
-
* @public
|
|
128
|
-
*/
|
|
129
|
-
WindowTargetId?: string | undefined;
|
|
130
|
-
}
|
|
131
|
-
/**
|
|
132
|
-
* <p>You attempted to register a <code>LAMBDA</code> or <code>STEP_FUNCTIONS</code> task in a
|
|
133
|
-
* region where the corresponding service isn't available. </p>
|
|
134
|
-
* @public
|
|
135
|
-
*/
|
|
136
|
-
export declare class FeatureNotAvailableException extends __BaseException {
|
|
137
|
-
readonly name: "FeatureNotAvailableException";
|
|
138
|
-
readonly $fault: "client";
|
|
139
|
-
Message?: string | undefined;
|
|
140
|
-
/**
|
|
141
|
-
* @internal
|
|
142
|
-
*/
|
|
143
|
-
constructor(opts: __ExceptionOptionType<FeatureNotAvailableException, __BaseException>);
|
|
144
|
-
}
|
|
145
|
-
/**
|
|
146
|
-
* @public
|
|
147
|
-
*/
|
|
148
|
-
export interface RegisterTaskWithMaintenanceWindowRequest {
|
|
149
|
-
/**
|
|
150
|
-
* <p>The ID of the maintenance window the task should be added to.</p>
|
|
151
|
-
* @public
|
|
152
|
-
*/
|
|
153
|
-
WindowId: string | undefined;
|
|
154
|
-
/**
|
|
155
|
-
* <p>The targets (either managed nodes or maintenance window targets).</p>
|
|
156
|
-
* <note>
|
|
157
|
-
* <p>One or more targets must be specified for maintenance window Run Command-type tasks.
|
|
158
|
-
* Depending on the task, targets are optional for other maintenance window task types (Automation,
|
|
159
|
-
* Lambda, and Step Functions). For more information about running tasks
|
|
160
|
-
* that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering
|
|
161
|
-
* maintenance window tasks without targets</a> in the
|
|
162
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
163
|
-
* </note>
|
|
164
|
-
* <p>Specify managed nodes using the following format: </p>
|
|
165
|
-
* <p>
|
|
166
|
-
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2></code>
|
|
167
|
-
* </p>
|
|
168
|
-
* <p>Specify maintenance window targets using the following format:</p>
|
|
169
|
-
* <p>
|
|
170
|
-
* <code>Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2></code>
|
|
171
|
-
* </p>
|
|
172
|
-
* @public
|
|
173
|
-
*/
|
|
174
|
-
Targets?: Target[] | undefined;
|
|
175
|
-
/**
|
|
176
|
-
* <p>The ARN of the task to run.</p>
|
|
177
|
-
* @public
|
|
178
|
-
*/
|
|
179
|
-
TaskArn: string | undefined;
|
|
180
|
-
/**
|
|
181
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role for
|
|
182
|
-
* Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a
|
|
183
|
-
* service role ARN, Systems Manager uses a service-linked role in your account. If no
|
|
184
|
-
* appropriate service-linked role for Systems Manager exists in your account, it is created when
|
|
185
|
-
* you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
|
|
186
|
-
* <p>However, for an improved security posture, we strongly recommend creating a custom
|
|
187
|
-
* policy and custom service role for running your maintenance window tasks. The policy
|
|
188
|
-
* can be crafted to provide only the permissions needed for your particular
|
|
189
|
-
* maintenance window tasks. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html">Setting up Maintenance Windows</a> in the in the
|
|
190
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
191
|
-
* @public
|
|
192
|
-
*/
|
|
193
|
-
ServiceRoleArn?: string | undefined;
|
|
194
|
-
/**
|
|
195
|
-
* <p>The type of task being registered.</p>
|
|
196
|
-
* @public
|
|
197
|
-
*/
|
|
198
|
-
TaskType: MaintenanceWindowTaskType | undefined;
|
|
199
|
-
/**
|
|
200
|
-
* <p>The parameters that should be passed to the task when it is run.</p>
|
|
201
|
-
* <note>
|
|
202
|
-
* <p>
|
|
203
|
-
* <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs,
|
|
204
|
-
* instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information
|
|
205
|
-
* about how Systems Manager handles these options for the supported maintenance window task
|
|
206
|
-
* types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
207
|
-
* </note>
|
|
208
|
-
* @public
|
|
209
|
-
*/
|
|
210
|
-
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression> | undefined;
|
|
211
|
-
/**
|
|
212
|
-
* <p>The parameters that the task should use during execution. Populate only the fields that
|
|
213
|
-
* match the task type. All other fields should be empty. </p>
|
|
214
|
-
* @public
|
|
215
|
-
*/
|
|
216
|
-
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | undefined;
|
|
217
|
-
/**
|
|
218
|
-
* <p>The priority of the task in the maintenance window, the lower the number the higher the
|
|
219
|
-
* priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the
|
|
220
|
-
* same priority scheduled in parallel.</p>
|
|
221
|
-
* @public
|
|
222
|
-
*/
|
|
223
|
-
Priority?: number | undefined;
|
|
224
|
-
/**
|
|
225
|
-
* <p>The maximum number of targets this task can be run for, in parallel.</p>
|
|
226
|
-
* <note>
|
|
227
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
228
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
229
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
230
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
231
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
232
|
-
* affect the running of your task.</p>
|
|
233
|
-
* </note>
|
|
234
|
-
* @public
|
|
235
|
-
*/
|
|
236
|
-
MaxConcurrency?: string | undefined;
|
|
237
|
-
/**
|
|
238
|
-
* <p>The maximum number of errors allowed before this task stops being scheduled.</p>
|
|
239
|
-
* <note>
|
|
240
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
241
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
242
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
243
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
244
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
245
|
-
* affect the running of your task.</p>
|
|
246
|
-
* </note>
|
|
247
|
-
* @public
|
|
248
|
-
*/
|
|
249
|
-
MaxErrors?: string | undefined;
|
|
250
|
-
/**
|
|
251
|
-
* <p>A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket
|
|
252
|
-
* to write managed node-level logs to. </p>
|
|
253
|
-
* <note>
|
|
254
|
-
* <p>
|
|
255
|
-
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
|
|
256
|
-
* <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure.
|
|
257
|
-
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
|
|
258
|
-
* window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
259
|
-
* </note>
|
|
260
|
-
* @public
|
|
261
|
-
*/
|
|
262
|
-
LoggingInfo?: LoggingInfo | undefined;
|
|
263
|
-
/**
|
|
264
|
-
* <p>An optional name for the task.</p>
|
|
265
|
-
* @public
|
|
266
|
-
*/
|
|
267
|
-
Name?: string | undefined;
|
|
268
|
-
/**
|
|
269
|
-
* <p>An optional description for the task.</p>
|
|
270
|
-
* @public
|
|
271
|
-
*/
|
|
272
|
-
Description?: string | undefined;
|
|
273
|
-
/**
|
|
274
|
-
* <p>User-provided idempotency token.</p>
|
|
275
|
-
* @public
|
|
276
|
-
*/
|
|
277
|
-
ClientToken?: string | undefined;
|
|
278
|
-
/**
|
|
279
|
-
* <p>Indicates whether tasks should continue to run after the cutoff time specified in the
|
|
280
|
-
* maintenance windows is reached. </p>
|
|
281
|
-
* <ul>
|
|
282
|
-
* <li>
|
|
283
|
-
* <p>
|
|
284
|
-
* <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running
|
|
285
|
-
* continue. The default value.</p>
|
|
286
|
-
* </li>
|
|
287
|
-
* <li>
|
|
288
|
-
* <p>
|
|
289
|
-
* <code>CANCEL_TASK</code>:</p>
|
|
290
|
-
* <ul>
|
|
291
|
-
* <li>
|
|
292
|
-
* <p>For Automation, Lambda, Step Functions tasks: When the cutoff
|
|
293
|
-
* time is reached, any task invocations that are already running continue, but no new task
|
|
294
|
-
* invocations are started.</p>
|
|
295
|
-
* </li>
|
|
296
|
-
* <li>
|
|
297
|
-
* <p>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the
|
|
298
|
-
* task. However, there is no guarantee that the command will be terminated and the underlying
|
|
299
|
-
* process stopped.</p>
|
|
300
|
-
* </li>
|
|
301
|
-
* </ul>
|
|
302
|
-
* <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p>
|
|
303
|
-
* </li>
|
|
304
|
-
* </ul>
|
|
305
|
-
* @public
|
|
306
|
-
*/
|
|
307
|
-
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | undefined;
|
|
308
|
-
/**
|
|
309
|
-
* <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
|
|
310
|
-
* @public
|
|
311
|
-
*/
|
|
312
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
313
|
-
}
|
|
314
|
-
/**
|
|
315
|
-
* @public
|
|
316
|
-
*/
|
|
317
|
-
export interface RegisterTaskWithMaintenanceWindowResult {
|
|
318
|
-
/**
|
|
319
|
-
* <p>The ID of the task in the maintenance window.</p>
|
|
320
|
-
* @public
|
|
321
|
-
*/
|
|
322
|
-
WindowTaskId?: string | undefined;
|
|
323
|
-
}
|
|
324
|
-
/**
|
|
325
|
-
* @public
|
|
326
|
-
*/
|
|
327
|
-
export interface RemoveTagsFromResourceRequest {
|
|
328
|
-
/**
|
|
329
|
-
* <p>The type of resource from which you want to remove a tag.</p>
|
|
330
|
-
* <note>
|
|
331
|
-
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
332
|
-
* managed nodes. Specify the name of the managed node in the following format:
|
|
333
|
-
* <code>mi-<i>ID_number</i>
|
|
334
|
-
* </code>. For example,
|
|
335
|
-
* <code>mi-1a2b3c4d5e6f</code>.</p>
|
|
336
|
-
* </note>
|
|
337
|
-
* @public
|
|
338
|
-
*/
|
|
339
|
-
ResourceType: ResourceTypeForTagging | undefined;
|
|
340
|
-
/**
|
|
341
|
-
* <p>The ID of the resource from which you want to remove tags. For example:</p>
|
|
342
|
-
* <p>ManagedInstance: mi-012345abcde</p>
|
|
343
|
-
* <p>MaintenanceWindow: mw-012345abcde</p>
|
|
344
|
-
* <p>
|
|
345
|
-
* <code>Automation</code>: <code>example-c160-4567-8519-012345abcde</code>
|
|
346
|
-
* </p>
|
|
347
|
-
* <p>PatchBaseline: pb-012345abcde</p>
|
|
348
|
-
* <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource
|
|
349
|
-
* Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that
|
|
350
|
-
* come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with
|
|
351
|
-
* an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code>
|
|
352
|
-
* has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or
|
|
353
|
-
* <code>/aws/ssm/MyGroup/appmanager</code>.</p>
|
|
354
|
-
* <p>For the Document and Parameter values, use the name of the resource.</p>
|
|
355
|
-
* <note>
|
|
356
|
-
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
357
|
-
* managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For
|
|
358
|
-
* example, mi-1a2b3c4d5e6f.</p>
|
|
359
|
-
* </note>
|
|
360
|
-
* @public
|
|
361
|
-
*/
|
|
362
|
-
ResourceId: string | undefined;
|
|
363
|
-
/**
|
|
364
|
-
* <p>Tag keys that you want to remove from the specified resource.</p>
|
|
365
|
-
* @public
|
|
366
|
-
*/
|
|
367
|
-
TagKeys: string[] | undefined;
|
|
368
|
-
}
|
|
369
|
-
/**
|
|
370
|
-
* @public
|
|
371
|
-
*/
|
|
372
|
-
export interface RemoveTagsFromResourceResult {
|
|
373
|
-
}
|
|
374
|
-
/**
|
|
375
|
-
* <p>The request body of the ResetServiceSetting API operation.</p>
|
|
376
|
-
* @public
|
|
377
|
-
*/
|
|
378
|
-
export interface ResetServiceSettingRequest {
|
|
379
|
-
/**
|
|
380
|
-
* <p>The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of
|
|
381
|
-
* the following.</p>
|
|
382
|
-
* <ul>
|
|
383
|
-
* <li>
|
|
384
|
-
* <p>
|
|
385
|
-
* <code>/ssm/appmanager/appmanager-enabled</code>
|
|
386
|
-
* </p>
|
|
387
|
-
* </li>
|
|
388
|
-
* <li>
|
|
389
|
-
* <p>
|
|
390
|
-
* <code>/ssm/automation/customer-script-log-destination</code>
|
|
391
|
-
* </p>
|
|
392
|
-
* </li>
|
|
393
|
-
* <li>
|
|
394
|
-
* <p>
|
|
395
|
-
* <code>/ssm/automation/customer-script-log-group-name</code>
|
|
396
|
-
* </p>
|
|
397
|
-
* </li>
|
|
398
|
-
* <li>
|
|
399
|
-
* <p>/ssm/automation/enable-adaptive-concurrency</p>
|
|
400
|
-
* </li>
|
|
401
|
-
* <li>
|
|
402
|
-
* <p>
|
|
403
|
-
* <code>/ssm/documents/console/public-sharing-permission</code>
|
|
404
|
-
* </p>
|
|
405
|
-
* </li>
|
|
406
|
-
* <li>
|
|
407
|
-
* <p>
|
|
408
|
-
* <code>/ssm/managed-instance/activation-tier</code>
|
|
409
|
-
* </p>
|
|
410
|
-
* </li>
|
|
411
|
-
* <li>
|
|
412
|
-
* <p>
|
|
413
|
-
* <code>/ssm/managed-instance/default-ec2-instance-management-role</code>
|
|
414
|
-
* </p>
|
|
415
|
-
* </li>
|
|
416
|
-
* <li>
|
|
417
|
-
* <p>
|
|
418
|
-
* <code>/ssm/opsinsights/opscenter</code>
|
|
419
|
-
* </p>
|
|
420
|
-
* </li>
|
|
421
|
-
* <li>
|
|
422
|
-
* <p>
|
|
423
|
-
* <code>/ssm/parameter-store/default-parameter-tier</code>
|
|
424
|
-
* </p>
|
|
425
|
-
* </li>
|
|
426
|
-
* <li>
|
|
427
|
-
* <p>
|
|
428
|
-
* <code>/ssm/parameter-store/high-throughput-enabled</code>
|
|
429
|
-
* </p>
|
|
430
|
-
* </li>
|
|
431
|
-
* </ul>
|
|
432
|
-
* @public
|
|
433
|
-
*/
|
|
434
|
-
SettingId: string | undefined;
|
|
435
|
-
}
|
|
436
|
-
/**
|
|
437
|
-
* <p>The result body of the ResetServiceSetting API operation.</p>
|
|
438
|
-
* @public
|
|
439
|
-
*/
|
|
440
|
-
export interface ResetServiceSettingResult {
|
|
441
|
-
/**
|
|
442
|
-
* <p>The current, effective service setting after calling the ResetServiceSetting API
|
|
443
|
-
* operation.</p>
|
|
444
|
-
* @public
|
|
445
|
-
*/
|
|
446
|
-
ServiceSetting?: ServiceSetting | undefined;
|
|
447
|
-
}
|
|
448
|
-
/**
|
|
449
|
-
* @public
|
|
450
|
-
*/
|
|
451
|
-
export interface ResumeSessionRequest {
|
|
452
|
-
/**
|
|
453
|
-
* <p>The ID of the disconnected session to resume.</p>
|
|
454
|
-
* @public
|
|
455
|
-
*/
|
|
456
|
-
SessionId: string | undefined;
|
|
457
|
-
}
|
|
458
|
-
/**
|
|
459
|
-
* @public
|
|
460
|
-
*/
|
|
461
|
-
export interface ResumeSessionResponse {
|
|
462
|
-
/**
|
|
463
|
-
* <p>The ID of the session.</p>
|
|
464
|
-
* @public
|
|
465
|
-
*/
|
|
466
|
-
SessionId?: string | undefined;
|
|
467
|
-
/**
|
|
468
|
-
* <p>An encrypted token value containing session and caller information. Used to authenticate the
|
|
469
|
-
* connection to the managed node.</p>
|
|
470
|
-
* @public
|
|
471
|
-
*/
|
|
472
|
-
TokenValue?: string | undefined;
|
|
473
|
-
/**
|
|
474
|
-
* <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
|
|
475
|
-
* receive output from the managed node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p>
|
|
476
|
-
* <p>
|
|
477
|
-
* <b>region</b> represents the Region identifier for an
|
|
478
|
-
* Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.
|
|
479
|
-
* For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems Manager service endpoints</a> in the
|
|
480
|
-
* <i>Amazon Web Services General Reference</i>.</p>
|
|
481
|
-
* <p>
|
|
482
|
-
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|
483
|
-
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|
484
|
-
* @public
|
|
485
|
-
*/
|
|
486
|
-
StreamUrl?: string | undefined;
|
|
487
|
-
}
|
|
488
|
-
/**
|
|
489
|
-
* <p>The specified step name and execution ID don't exist. Verify the information and try
|
|
490
|
-
* again.</p>
|
|
491
|
-
* @public
|
|
492
|
-
*/
|
|
493
|
-
export declare class AutomationStepNotFoundException extends __BaseException {
|
|
494
|
-
readonly name: "AutomationStepNotFoundException";
|
|
495
|
-
readonly $fault: "client";
|
|
496
|
-
Message?: string | undefined;
|
|
497
|
-
/**
|
|
498
|
-
* @internal
|
|
499
|
-
*/
|
|
500
|
-
constructor(opts: __ExceptionOptionType<AutomationStepNotFoundException, __BaseException>);
|
|
501
|
-
}
|
|
502
|
-
/**
|
|
503
|
-
* <p>The signal isn't valid for the current Automation execution.</p>
|
|
504
|
-
* @public
|
|
505
|
-
*/
|
|
506
|
-
export declare class InvalidAutomationSignalException extends __BaseException {
|
|
507
|
-
readonly name: "InvalidAutomationSignalException";
|
|
508
|
-
readonly $fault: "client";
|
|
509
|
-
Message?: string | undefined;
|
|
510
|
-
/**
|
|
511
|
-
* @internal
|
|
512
|
-
*/
|
|
513
|
-
constructor(opts: __ExceptionOptionType<InvalidAutomationSignalException, __BaseException>);
|
|
514
|
-
}
|
|
515
|
-
/**
|
|
516
|
-
* @public
|
|
517
|
-
* @enum
|
|
518
|
-
*/
|
|
519
|
-
export declare const SignalType: {
|
|
520
|
-
readonly APPROVE: "Approve";
|
|
521
|
-
readonly REJECT: "Reject";
|
|
522
|
-
readonly RESUME: "Resume";
|
|
523
|
-
readonly REVOKE: "Revoke";
|
|
524
|
-
readonly START_STEP: "StartStep";
|
|
525
|
-
readonly STOP_STEP: "StopStep";
|
|
526
|
-
};
|
|
527
|
-
/**
|
|
528
|
-
* @public
|
|
529
|
-
*/
|
|
530
|
-
export type SignalType = (typeof SignalType)[keyof typeof SignalType];
|
|
531
|
-
/**
|
|
532
|
-
* @public
|
|
533
|
-
*/
|
|
534
|
-
export interface SendAutomationSignalRequest {
|
|
535
|
-
/**
|
|
536
|
-
* <p>The unique identifier for an existing Automation execution that you want to send the signal
|
|
537
|
-
* to.</p>
|
|
538
|
-
* @public
|
|
539
|
-
*/
|
|
540
|
-
AutomationExecutionId: string | undefined;
|
|
541
|
-
/**
|
|
542
|
-
* <p>The type of signal to send to an Automation execution. </p>
|
|
543
|
-
* @public
|
|
544
|
-
*/
|
|
545
|
-
SignalType: SignalType | undefined;
|
|
546
|
-
/**
|
|
547
|
-
* <p>The data sent with the signal. The data schema depends on the type of signal used in the
|
|
548
|
-
* request.</p>
|
|
549
|
-
* <p>For <code>Approve</code> and <code>Reject</code> signal types, the payload is an optional
|
|
550
|
-
* comment that you can send with the signal type. For example:</p>
|
|
551
|
-
* <p>
|
|
552
|
-
* <code>Comment="Looks good"</code>
|
|
553
|
-
* </p>
|
|
554
|
-
* <p>For <code>StartStep</code> and <code>Resume</code> signal types, you must send the name of
|
|
555
|
-
* the Automation step to start or resume as the payload. For example:</p>
|
|
556
|
-
* <p>
|
|
557
|
-
* <code>StepName="step1"</code>
|
|
558
|
-
* </p>
|
|
559
|
-
* <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the
|
|
560
|
-
* payload. For example:</p>
|
|
561
|
-
* <p>
|
|
562
|
-
* <code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code>
|
|
563
|
-
* </p>
|
|
564
|
-
* @public
|
|
565
|
-
*/
|
|
566
|
-
Payload?: Record<string, string[]> | undefined;
|
|
567
|
-
}
|
|
568
|
-
/**
|
|
569
|
-
* @public
|
|
570
|
-
*/
|
|
571
|
-
export interface SendAutomationSignalResult {
|
|
572
|
-
}
|
|
573
|
-
/**
|
|
574
|
-
* <p>One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN)
|
|
575
|
-
* was provided for an Amazon Simple Notification Service topic.</p>
|
|
576
|
-
* @public
|
|
577
|
-
*/
|
|
578
|
-
export declare class InvalidNotificationConfig extends __BaseException {
|
|
579
|
-
readonly name: "InvalidNotificationConfig";
|
|
580
|
-
readonly $fault: "client";
|
|
581
|
-
Message?: string | undefined;
|
|
582
|
-
/**
|
|
583
|
-
* @internal
|
|
584
|
-
*/
|
|
585
|
-
constructor(opts: __ExceptionOptionType<InvalidNotificationConfig, __BaseException>);
|
|
586
|
-
}
|
|
587
|
-
/**
|
|
588
|
-
* <p>The S3 bucket doesn't exist.</p>
|
|
589
|
-
* @public
|
|
590
|
-
*/
|
|
591
|
-
export declare class InvalidOutputFolder extends __BaseException {
|
|
592
|
-
readonly name: "InvalidOutputFolder";
|
|
593
|
-
readonly $fault: "client";
|
|
594
|
-
/**
|
|
595
|
-
* @internal
|
|
596
|
-
*/
|
|
597
|
-
constructor(opts: __ExceptionOptionType<InvalidOutputFolder, __BaseException>);
|
|
598
|
-
}
|
|
599
|
-
/**
|
|
600
|
-
* <p>The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about
|
|
601
|
-
* configuring the IAM role for Run Command notifications, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in
|
|
602
|
-
* the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
603
|
-
* @public
|
|
604
|
-
*/
|
|
605
|
-
export declare class InvalidRole extends __BaseException {
|
|
606
|
-
readonly name: "InvalidRole";
|
|
607
|
-
readonly $fault: "client";
|
|
608
|
-
Message?: string | undefined;
|
|
609
|
-
/**
|
|
610
|
-
* @internal
|
|
611
|
-
*/
|
|
612
|
-
constructor(opts: __ExceptionOptionType<InvalidRole, __BaseException>);
|
|
613
|
-
}
|
|
614
|
-
/**
|
|
615
|
-
* @public
|
|
616
|
-
*/
|
|
617
|
-
export interface SendCommandRequest {
|
|
618
|
-
/**
|
|
619
|
-
* <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is
|
|
620
|
-
* most useful when you are targeting a limited number of managed nodes, though you can specify up
|
|
621
|
-
* to 50 IDs.</p>
|
|
622
|
-
* <p>To target a larger number of managed nodes, or if you prefer not to list individual node
|
|
623
|
-
* IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>,
|
|
624
|
-
* which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a
|
|
625
|
-
* send command to tens, hundreds, or thousands of nodes at once.</p>
|
|
626
|
-
* <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a>
|
|
627
|
-
* in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
628
|
-
* @public
|
|
629
|
-
*/
|
|
630
|
-
InstanceIds?: string[] | undefined;
|
|
631
|
-
/**
|
|
632
|
-
* <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code>
|
|
633
|
-
* combination that you specify. Specifying targets is most useful when you want to send a command
|
|
634
|
-
* to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag
|
|
635
|
-
* key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands
|
|
636
|
-
* of nodes at once.</p>
|
|
637
|
-
* <p>To send a command to a smaller number of managed nodes, you can use the
|
|
638
|
-
* <code>InstanceIds</code> option instead.</p>
|
|
639
|
-
* <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a>
|
|
640
|
-
* in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
641
|
-
* @public
|
|
642
|
-
*/
|
|
643
|
-
Targets?: Target[] | undefined;
|
|
644
|
-
/**
|
|
645
|
-
* <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a
|
|
646
|
-
* custom document. To run a shared document belonging to another account, specify the document
|
|
647
|
-
* Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM
|
|
648
|
-
* documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
649
|
-
* <note>
|
|
650
|
-
* <p>If you specify a document name or ARN that hasn't been shared with your account, you
|
|
651
|
-
* receive an <code>InvalidDocument</code> error. </p>
|
|
652
|
-
* </note>
|
|
653
|
-
* @public
|
|
654
|
-
*/
|
|
655
|
-
DocumentName: string | undefined;
|
|
656
|
-
/**
|
|
657
|
-
* <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a
|
|
658
|
-
* specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then
|
|
659
|
-
* you must escape the first two options by using a backslash. If you specify a version number, then
|
|
660
|
-
* you don't need to use the backslash. For example:</p>
|
|
661
|
-
* <p>--document-version "\$DEFAULT"</p>
|
|
662
|
-
* <p>--document-version "\$LATEST"</p>
|
|
663
|
-
* <p>--document-version "3"</p>
|
|
664
|
-
* @public
|
|
665
|
-
*/
|
|
666
|
-
DocumentVersion?: string | undefined;
|
|
667
|
-
/**
|
|
668
|
-
* <p>The Sha256 or Sha1 hash created by the system when the document was created. </p>
|
|
669
|
-
* <note>
|
|
670
|
-
* <p>Sha1 hashes have been deprecated.</p>
|
|
671
|
-
* </note>
|
|
672
|
-
* @public
|
|
673
|
-
*/
|
|
674
|
-
DocumentHash?: string | undefined;
|
|
675
|
-
/**
|
|
676
|
-
* <p>Sha256 or Sha1.</p>
|
|
677
|
-
* <note>
|
|
678
|
-
* <p>Sha1 hashes have been deprecated.</p>
|
|
679
|
-
* </note>
|
|
680
|
-
* @public
|
|
681
|
-
*/
|
|
682
|
-
DocumentHashType?: DocumentHashType | undefined;
|
|
683
|
-
/**
|
|
684
|
-
* <p>If this time is reached and the command hasn't already started running, it won't run.</p>
|
|
685
|
-
* @public
|
|
686
|
-
*/
|
|
687
|
-
TimeoutSeconds?: number | undefined;
|
|
688
|
-
/**
|
|
689
|
-
* <p>User-specified information about the command, such as a brief description of what the
|
|
690
|
-
* command should do.</p>
|
|
691
|
-
* @public
|
|
692
|
-
*/
|
|
693
|
-
Comment?: string | undefined;
|
|
694
|
-
/**
|
|
695
|
-
* <p>The required and optional parameters specified in the document being run.</p>
|
|
696
|
-
* @public
|
|
697
|
-
*/
|
|
698
|
-
Parameters?: Record<string, string[]> | undefined;
|
|
699
|
-
/**
|
|
700
|
-
* <p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager
|
|
701
|
-
* automatically determines the Amazon Web Services Region of the S3 bucket.</p>
|
|
702
|
-
* @public
|
|
703
|
-
*/
|
|
704
|
-
OutputS3Region?: string | undefined;
|
|
705
|
-
/**
|
|
706
|
-
* <p>The name of the S3 bucket where command execution responses should be stored.</p>
|
|
707
|
-
* @public
|
|
708
|
-
*/
|
|
709
|
-
OutputS3BucketName?: string | undefined;
|
|
710
|
-
/**
|
|
711
|
-
* <p>The directory structure within the S3 bucket where the responses should be stored.</p>
|
|
712
|
-
* @public
|
|
713
|
-
*/
|
|
714
|
-
OutputS3KeyPrefix?: string | undefined;
|
|
715
|
-
/**
|
|
716
|
-
* <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the
|
|
717
|
-
* same time. You can specify a number such as 10 or a percentage such as 10%. The default value is
|
|
718
|
-
* <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using
|
|
719
|
-
* concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
720
|
-
* @public
|
|
721
|
-
*/
|
|
722
|
-
MaxConcurrency?: string | undefined;
|
|
723
|
-
/**
|
|
724
|
-
* <p>The maximum number of errors allowed without the command failing. When the command fails one
|
|
725
|
-
* more time beyond the value of <code>MaxErrors</code>, the systems stops sending the command to
|
|
726
|
-
* additional targets. You can specify a number like 10 or a percentage like 10%. The default value
|
|
727
|
-
* is <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using
|
|
728
|
-
* error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
729
|
-
* @public
|
|
730
|
-
*/
|
|
731
|
-
MaxErrors?: string | undefined;
|
|
732
|
-
/**
|
|
733
|
-
* <p>The ARN of the Identity and Access Management (IAM) service role to use to publish
|
|
734
|
-
* Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
|
|
735
|
-
* <p>This role must provide the <code>sns:Publish</code> permission for your notification topic.
|
|
736
|
-
* For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the
|
|
737
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
738
|
-
* @public
|
|
739
|
-
*/
|
|
740
|
-
ServiceRoleArn?: string | undefined;
|
|
741
|
-
/**
|
|
742
|
-
* <p>Configurations for sending notifications.</p>
|
|
743
|
-
* @public
|
|
744
|
-
*/
|
|
745
|
-
NotificationConfig?: NotificationConfig | undefined;
|
|
746
|
-
/**
|
|
747
|
-
* <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a
|
|
748
|
-
* tool in Amazon Web Services Systems Manager.</p>
|
|
749
|
-
* @public
|
|
750
|
-
*/
|
|
751
|
-
CloudWatchOutputConfig?: CloudWatchOutputConfig | undefined;
|
|
752
|
-
/**
|
|
753
|
-
* <p>The CloudWatch alarm you want to apply to your command.</p>
|
|
754
|
-
* @public
|
|
755
|
-
*/
|
|
756
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
757
|
-
}
|
|
758
|
-
/**
|
|
759
|
-
* @public
|
|
760
|
-
*/
|
|
761
|
-
export interface SendCommandResult {
|
|
762
|
-
/**
|
|
763
|
-
* <p>The request as it was received by Systems Manager. Also provides the command ID which can be used
|
|
764
|
-
* future references to this request.</p>
|
|
765
|
-
* @public
|
|
766
|
-
*/
|
|
767
|
-
Command?: Command | undefined;
|
|
768
|
-
}
|
|
769
|
-
/**
|
|
770
|
-
* <p>The request exceeds the service quota. Service quotas, also referred to as limits, are the
|
|
771
|
-
* maximum number of service resources or operations for your Amazon Web Services account.</p>
|
|
772
|
-
* @public
|
|
773
|
-
*/
|
|
774
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
775
|
-
readonly name: "ServiceQuotaExceededException";
|
|
776
|
-
readonly $fault: "client";
|
|
777
|
-
Message: string | undefined;
|
|
778
|
-
/**
|
|
779
|
-
* <p>The unique ID of the resource referenced in the failed request.</p>
|
|
780
|
-
* @public
|
|
781
|
-
*/
|
|
782
|
-
ResourceId?: string | undefined;
|
|
783
|
-
/**
|
|
784
|
-
* <p>The resource type of the resource referenced in the failed request.</p>
|
|
785
|
-
* @public
|
|
786
|
-
*/
|
|
787
|
-
ResourceType?: string | undefined;
|
|
788
|
-
/**
|
|
789
|
-
* <p>The quota code recognized by the Amazon Web Services Service Quotas service.</p>
|
|
790
|
-
* @public
|
|
791
|
-
*/
|
|
792
|
-
QuotaCode: string | undefined;
|
|
793
|
-
/**
|
|
794
|
-
* <p>The code for the Amazon Web Services service that owns the quota.</p>
|
|
795
|
-
* @public
|
|
796
|
-
*/
|
|
797
|
-
ServiceCode: string | undefined;
|
|
798
|
-
/**
|
|
799
|
-
* @internal
|
|
800
|
-
*/
|
|
801
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
802
|
-
}
|
|
803
|
-
/**
|
|
804
|
-
* @public
|
|
805
|
-
*/
|
|
806
|
-
export interface StartAccessRequestRequest {
|
|
807
|
-
/**
|
|
808
|
-
* <p>A brief description explaining why you are requesting access to the node.</p>
|
|
809
|
-
* @public
|
|
810
|
-
*/
|
|
811
|
-
Reason: string | undefined;
|
|
812
|
-
/**
|
|
813
|
-
* <p>The node you are requesting access to.</p>
|
|
814
|
-
* @public
|
|
815
|
-
*/
|
|
816
|
-
Targets: Target[] | undefined;
|
|
817
|
-
/**
|
|
818
|
-
* <p>Key-value pairs of metadata you want to assign to the access request.</p>
|
|
819
|
-
* @public
|
|
820
|
-
*/
|
|
821
|
-
Tags?: Tag[] | undefined;
|
|
822
|
-
}
|
|
823
|
-
/**
|
|
824
|
-
* @public
|
|
825
|
-
*/
|
|
826
|
-
export interface StartAccessRequestResponse {
|
|
827
|
-
/**
|
|
828
|
-
* <p>The ID of the access request.</p>
|
|
829
|
-
* @public
|
|
830
|
-
*/
|
|
831
|
-
AccessRequestId?: string | undefined;
|
|
832
|
-
}
|
|
833
|
-
/**
|
|
834
|
-
* <p>The association isn't valid or doesn't exist. </p>
|
|
835
|
-
* @public
|
|
836
|
-
*/
|
|
837
|
-
export declare class InvalidAssociation extends __BaseException {
|
|
838
|
-
readonly name: "InvalidAssociation";
|
|
839
|
-
readonly $fault: "client";
|
|
840
|
-
Message?: string | undefined;
|
|
841
|
-
/**
|
|
842
|
-
* @internal
|
|
843
|
-
*/
|
|
844
|
-
constructor(opts: __ExceptionOptionType<InvalidAssociation, __BaseException>);
|
|
845
|
-
}
|
|
846
|
-
/**
|
|
847
|
-
* @public
|
|
848
|
-
*/
|
|
849
|
-
export interface StartAssociationsOnceRequest {
|
|
850
|
-
/**
|
|
851
|
-
* <p>The association IDs that you want to run immediately and only one time.</p>
|
|
852
|
-
* @public
|
|
853
|
-
*/
|
|
854
|
-
AssociationIds: string[] | undefined;
|
|
855
|
-
}
|
|
856
|
-
/**
|
|
857
|
-
* @public
|
|
858
|
-
*/
|
|
859
|
-
export interface StartAssociationsOnceResult {
|
|
860
|
-
}
|
|
861
|
-
/**
|
|
862
|
-
* <p>An Automation runbook with the specified name couldn't be found.</p>
|
|
863
|
-
* @public
|
|
864
|
-
*/
|
|
865
|
-
export declare class AutomationDefinitionNotFoundException extends __BaseException {
|
|
866
|
-
readonly name: "AutomationDefinitionNotFoundException";
|
|
867
|
-
readonly $fault: "client";
|
|
868
|
-
Message?: string | undefined;
|
|
869
|
-
/**
|
|
870
|
-
* @internal
|
|
871
|
-
*/
|
|
872
|
-
constructor(opts: __ExceptionOptionType<AutomationDefinitionNotFoundException, __BaseException>);
|
|
873
|
-
}
|
|
874
|
-
/**
|
|
875
|
-
* <p>An Automation runbook with the specified name and version couldn't be found.</p>
|
|
876
|
-
* @public
|
|
877
|
-
*/
|
|
878
|
-
export declare class AutomationDefinitionVersionNotFoundException extends __BaseException {
|
|
879
|
-
readonly name: "AutomationDefinitionVersionNotFoundException";
|
|
880
|
-
readonly $fault: "client";
|
|
881
|
-
Message?: string | undefined;
|
|
882
|
-
/**
|
|
883
|
-
* @internal
|
|
884
|
-
*/
|
|
885
|
-
constructor(opts: __ExceptionOptionType<AutomationDefinitionVersionNotFoundException, __BaseException>);
|
|
886
|
-
}
|
|
887
|
-
/**
|
|
888
|
-
* <p>The number of simultaneously running Automation executions exceeded the allowable
|
|
889
|
-
* limit.</p>
|
|
890
|
-
* @public
|
|
891
|
-
*/
|
|
892
|
-
export declare class AutomationExecutionLimitExceededException extends __BaseException {
|
|
893
|
-
readonly name: "AutomationExecutionLimitExceededException";
|
|
894
|
-
readonly $fault: "client";
|
|
895
|
-
Message?: string | undefined;
|
|
896
|
-
/**
|
|
897
|
-
* @internal
|
|
898
|
-
*/
|
|
899
|
-
constructor(opts: __ExceptionOptionType<AutomationExecutionLimitExceededException, __BaseException>);
|
|
900
|
-
}
|
|
901
|
-
/**
|
|
902
|
-
* <p>The supplied parameters for invoking the specified Automation runbook are incorrect. For
|
|
903
|
-
* example, they may not match the set of parameters permitted for the specified Automation
|
|
904
|
-
* document.</p>
|
|
905
|
-
* @public
|
|
906
|
-
*/
|
|
907
|
-
export declare class InvalidAutomationExecutionParametersException extends __BaseException {
|
|
908
|
-
readonly name: "InvalidAutomationExecutionParametersException";
|
|
909
|
-
readonly $fault: "client";
|
|
910
|
-
Message?: string | undefined;
|
|
911
|
-
/**
|
|
912
|
-
* @internal
|
|
913
|
-
*/
|
|
914
|
-
constructor(opts: __ExceptionOptionType<InvalidAutomationExecutionParametersException, __BaseException>);
|
|
915
|
-
}
|
|
916
|
-
/**
|
|
917
|
-
* @public
|
|
918
|
-
*/
|
|
919
|
-
export interface StartAutomationExecutionRequest {
|
|
920
|
-
/**
|
|
921
|
-
* <p>The name of the SSM document to run. This can be a public document or a custom document. To
|
|
922
|
-
* run a shared document belonging to another account, specify the document ARN. For more
|
|
923
|
-
* information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html">Sharing SSM documents</a>
|
|
924
|
-
* in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
925
|
-
* @public
|
|
926
|
-
*/
|
|
927
|
-
DocumentName: string | undefined;
|
|
928
|
-
/**
|
|
929
|
-
* <p>The version of the Automation runbook to use for this execution.</p>
|
|
930
|
-
* @public
|
|
931
|
-
*/
|
|
932
|
-
DocumentVersion?: string | undefined;
|
|
933
|
-
/**
|
|
934
|
-
* <p>A key-value map of execution parameters, which match the declared parameters in the
|
|
935
|
-
* Automation runbook.</p>
|
|
936
|
-
* @public
|
|
937
|
-
*/
|
|
938
|
-
Parameters?: Record<string, string[]> | undefined;
|
|
939
|
-
/**
|
|
940
|
-
* <p>User-provided idempotency token. The token must be unique, is case insensitive, enforces the
|
|
941
|
-
* UUID format, and can't be reused.</p>
|
|
942
|
-
* @public
|
|
943
|
-
*/
|
|
944
|
-
ClientToken?: string | undefined;
|
|
945
|
-
/**
|
|
946
|
-
* <p>The execution mode of the automation. Valid modes include the following: Auto and
|
|
947
|
-
* Interactive. The default mode is Auto.</p>
|
|
948
|
-
* @public
|
|
949
|
-
*/
|
|
950
|
-
Mode?: ExecutionMode | undefined;
|
|
951
|
-
/**
|
|
952
|
-
* <p>The name of the parameter used as the target resource for the rate-controlled execution.
|
|
953
|
-
* Required if you specify targets.</p>
|
|
954
|
-
* @public
|
|
955
|
-
*/
|
|
956
|
-
TargetParameterName?: string | undefined;
|
|
957
|
-
/**
|
|
958
|
-
* <p>A key-value mapping to target resources. Required if you specify TargetParameterName.</p>
|
|
959
|
-
* <p>If both this parameter and the <code>TargetLocation:Targets</code> parameter are supplied,
|
|
960
|
-
* <code>TargetLocation:Targets</code> takes precedence.</p>
|
|
961
|
-
* @public
|
|
962
|
-
*/
|
|
963
|
-
Targets?: Target[] | undefined;
|
|
964
|
-
/**
|
|
965
|
-
* <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
|
|
966
|
-
* can't be specified together.</p>
|
|
967
|
-
* @public
|
|
968
|
-
*/
|
|
969
|
-
TargetMaps?: Record<string, string[]>[] | undefined;
|
|
970
|
-
/**
|
|
971
|
-
* <p>The maximum number of targets allowed to run this task in parallel. You can specify a
|
|
972
|
-
* number, such as 10, or a percentage, such as 10%. The default value is <code>10</code>.</p>
|
|
973
|
-
* <p>If both this parameter and the <code>TargetLocation:TargetsMaxConcurrency</code> are
|
|
974
|
-
* supplied, <code>TargetLocation:TargetsMaxConcurrency</code> takes precedence.</p>
|
|
975
|
-
* @public
|
|
976
|
-
*/
|
|
977
|
-
MaxConcurrency?: string | undefined;
|
|
978
|
-
/**
|
|
979
|
-
* <p>The number of errors that are allowed before the system stops running the automation on
|
|
980
|
-
* additional targets. You can specify either an absolute number of errors, for example 10, or a
|
|
981
|
-
* percentage of the target set, for example 10%. If you specify 3, for example, the system stops
|
|
982
|
-
* running the automation when the fourth error is received. If you specify 0, then the system stops
|
|
983
|
-
* running the automation on additional targets after the first error result is returned. If you run
|
|
984
|
-
* an automation on 50 resources and set max-errors to 10%, then the system stops running the
|
|
985
|
-
* automation on additional targets when the sixth error is received.</p>
|
|
986
|
-
* <p>Executions that are already running an automation when max-errors is reached are allowed to
|
|
987
|
-
* complete, but some of these executions may fail as well. If you need to ensure that there won't
|
|
988
|
-
* be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one
|
|
989
|
-
* at a time.</p>
|
|
990
|
-
* <p>If this parameter and the <code>TargetLocation:TargetsMaxErrors</code> parameter are both
|
|
991
|
-
* supplied, <code>TargetLocation:TargetsMaxErrors</code> takes precedence.</p>
|
|
992
|
-
* @public
|
|
993
|
-
*/
|
|
994
|
-
MaxErrors?: string | undefined;
|
|
995
|
-
/**
|
|
996
|
-
* <p>A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the
|
|
997
|
-
* automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple
|
|
998
|
-
* Amazon Web Services accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html">Running automations in multiple Amazon Web Services Regions and accounts</a> in the
|
|
999
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>. </p>
|
|
1000
|
-
* @public
|
|
1001
|
-
*/
|
|
1002
|
-
TargetLocations?: TargetLocation[] | undefined;
|
|
1003
|
-
/**
|
|
1004
|
-
* <p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for
|
|
1005
|
-
* an automation. Tags enable you to categorize a resource in different ways, such as by purpose,
|
|
1006
|
-
* owner, or environment. For example, you might want to tag an automation to identify an
|
|
1007
|
-
* environment or operating system. In this case, you could specify the following key-value
|
|
1008
|
-
* pairs:</p>
|
|
1009
|
-
* <ul>
|
|
1010
|
-
* <li>
|
|
1011
|
-
* <p>
|
|
1012
|
-
* <code>Key=environment,Value=test</code>
|
|
1013
|
-
* </p>
|
|
1014
|
-
* </li>
|
|
1015
|
-
* <li>
|
|
1016
|
-
* <p>
|
|
1017
|
-
* <code>Key=OS,Value=Windows</code>
|
|
1018
|
-
* </p>
|
|
1019
|
-
* </li>
|
|
1020
|
-
* </ul>
|
|
1021
|
-
* <note>
|
|
1022
|
-
* <p>The <code>Array Members</code> maximum value is reported as 1000. This number includes
|
|
1023
|
-
* capacity reserved for internal operations. When calling the
|
|
1024
|
-
* <code>StartAutomationExecution</code> action, you can specify a maximum of 5 tags. You can,
|
|
1025
|
-
* however, use the <a>AddTagsToResource</a> action to add up to a total of 50 tags to
|
|
1026
|
-
* an existing automation configuration.</p>
|
|
1027
|
-
* </note>
|
|
1028
|
-
* @public
|
|
1029
|
-
*/
|
|
1030
|
-
Tags?: Tag[] | undefined;
|
|
1031
|
-
/**
|
|
1032
|
-
* <p>The CloudWatch alarm you want to apply to your automation.</p>
|
|
1033
|
-
* @public
|
|
1034
|
-
*/
|
|
1035
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
1036
|
-
/**
|
|
1037
|
-
* <p>Specify a publicly accessible URL for a file that contains the <code>TargetLocations</code>
|
|
1038
|
-
* body. Currently, only files in presigned Amazon S3 buckets are supported. </p>
|
|
1039
|
-
* @public
|
|
1040
|
-
*/
|
|
1041
|
-
TargetLocationsURL?: string | undefined;
|
|
1042
|
-
}
|
|
1043
|
-
/**
|
|
1044
|
-
* @public
|
|
1045
|
-
*/
|
|
1046
|
-
export interface StartAutomationExecutionResult {
|
|
1047
|
-
/**
|
|
1048
|
-
* <p>The unique ID of a newly scheduled automation execution.</p>
|
|
1049
|
-
* @public
|
|
1050
|
-
*/
|
|
1051
|
-
AutomationExecutionId?: string | undefined;
|
|
1052
|
-
}
|
|
1053
|
-
/**
|
|
1054
|
-
* <p>Indicates that the Change Manager change template used in the change request was rejected or is
|
|
1055
|
-
* still in a pending state.</p>
|
|
1056
|
-
* @public
|
|
1057
|
-
*/
|
|
1058
|
-
export declare class AutomationDefinitionNotApprovedException extends __BaseException {
|
|
1059
|
-
readonly name: "AutomationDefinitionNotApprovedException";
|
|
1060
|
-
readonly $fault: "client";
|
|
1061
|
-
Message?: string | undefined;
|
|
1062
|
-
/**
|
|
1063
|
-
* @internal
|
|
1064
|
-
*/
|
|
1065
|
-
constructor(opts: __ExceptionOptionType<AutomationDefinitionNotApprovedException, __BaseException>);
|
|
1066
|
-
}
|
|
1067
|
-
/**
|
|
1068
|
-
* @public
|
|
1069
|
-
*/
|
|
1070
|
-
export interface StartChangeRequestExecutionRequest {
|
|
1071
|
-
/**
|
|
1072
|
-
* <p>The date and time specified in the change request to run the Automation runbooks.</p>
|
|
1073
|
-
* <note>
|
|
1074
|
-
* <p>The Automation runbooks specified for the runbook workflow can't run until all required
|
|
1075
|
-
* approvals for the change request have been received.</p>
|
|
1076
|
-
* </note>
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
ScheduledTime?: Date | undefined;
|
|
1080
|
-
/**
|
|
1081
|
-
* <p>The name of the change template document to run during the runbook workflow.</p>
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
DocumentName: string | undefined;
|
|
1085
|
-
/**
|
|
1086
|
-
* <p>The version of the change template document to run during the runbook workflow.</p>
|
|
1087
|
-
* @public
|
|
1088
|
-
*/
|
|
1089
|
-
DocumentVersion?: string | undefined;
|
|
1090
|
-
/**
|
|
1091
|
-
* <p>A key-value map of parameters that match the declared parameters in the change template
|
|
1092
|
-
* document.</p>
|
|
1093
|
-
* @public
|
|
1094
|
-
*/
|
|
1095
|
-
Parameters?: Record<string, string[]> | undefined;
|
|
1096
|
-
/**
|
|
1097
|
-
* <p>The name of the change request associated with the runbook workflow to be run.</p>
|
|
1098
|
-
* @public
|
|
1099
|
-
*/
|
|
1100
|
-
ChangeRequestName?: string | undefined;
|
|
1101
|
-
/**
|
|
1102
|
-
* <p>The user-provided idempotency token. The token must be unique, is case insensitive, enforces
|
|
1103
|
-
* the UUID format, and can't be reused.</p>
|
|
1104
|
-
* @public
|
|
1105
|
-
*/
|
|
1106
|
-
ClientToken?: string | undefined;
|
|
1107
|
-
/**
|
|
1108
|
-
* <p>Indicates whether the change request can be approved automatically without the need for
|
|
1109
|
-
* manual approvals.</p>
|
|
1110
|
-
* <p>If <code>AutoApprovable</code> is enabled in a change template, then setting
|
|
1111
|
-
* <code>AutoApprove</code> to <code>true</code> in <code>StartChangeRequestExecution</code>
|
|
1112
|
-
* creates a change request that bypasses approver review.</p>
|
|
1113
|
-
* <note>
|
|
1114
|
-
* <p>Change Calendar restrictions are not bypassed in this scenario. If the state of an
|
|
1115
|
-
* associated calendar is <code>CLOSED</code>, change freeze approvers must still grant permission
|
|
1116
|
-
* for this change request to run. If they don't, the change won't be processed until the calendar
|
|
1117
|
-
* state is again <code>OPEN</code>. </p>
|
|
1118
|
-
* </note>
|
|
1119
|
-
* @public
|
|
1120
|
-
*/
|
|
1121
|
-
AutoApprove?: boolean | undefined;
|
|
1122
|
-
/**
|
|
1123
|
-
* <p>Information about the Automation runbooks that are run during the runbook workflow.</p>
|
|
1124
|
-
* <note>
|
|
1125
|
-
* <p>The Automation runbooks specified for the runbook workflow can't run until all required
|
|
1126
|
-
* approvals for the change request have been received.</p>
|
|
1127
|
-
* </note>
|
|
1128
|
-
* @public
|
|
1129
|
-
*/
|
|
1130
|
-
Runbooks: Runbook[] | undefined;
|
|
1131
|
-
/**
|
|
1132
|
-
* <p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for
|
|
1133
|
-
* a change request. Tags enable you to categorize a resource in different ways, such as by
|
|
1134
|
-
* purpose, owner, or environment. For example, you might want to tag a change request to identify
|
|
1135
|
-
* an environment or target Amazon Web Services Region. In this case, you could specify the following key-value
|
|
1136
|
-
* pairs:</p>
|
|
1137
|
-
* <ul>
|
|
1138
|
-
* <li>
|
|
1139
|
-
* <p>
|
|
1140
|
-
* <code>Key=Environment,Value=Production</code>
|
|
1141
|
-
* </p>
|
|
1142
|
-
* </li>
|
|
1143
|
-
* <li>
|
|
1144
|
-
* <p>
|
|
1145
|
-
* <code>Key=Region,Value=us-east-2</code>
|
|
1146
|
-
* </p>
|
|
1147
|
-
* </li>
|
|
1148
|
-
* </ul>
|
|
1149
|
-
* <note>
|
|
1150
|
-
* <p>The <code>Array Members</code> maximum value is reported as 1000. This number includes
|
|
1151
|
-
* capacity reserved for internal operations. When calling the
|
|
1152
|
-
* <code>StartChangeRequestExecution</code> action, you can specify a maximum of 5 tags. You can,
|
|
1153
|
-
* however, use the <a>AddTagsToResource</a> action to add up to a total of 50 tags to
|
|
1154
|
-
* an existing change request configuration.</p>
|
|
1155
|
-
* </note>
|
|
1156
|
-
* @public
|
|
1157
|
-
*/
|
|
1158
|
-
Tags?: Tag[] | undefined;
|
|
1159
|
-
/**
|
|
1160
|
-
* <p>The time that the requester expects the runbook workflow related to the change request to
|
|
1161
|
-
* complete. The time is an estimate only that the requester provides for reviewers.</p>
|
|
1162
|
-
* @public
|
|
1163
|
-
*/
|
|
1164
|
-
ScheduledEndTime?: Date | undefined;
|
|
1165
|
-
/**
|
|
1166
|
-
* <p>User-provided details about the change. If no details are provided, content specified in the
|
|
1167
|
-
* <b>Template information</b> section of the associated change template
|
|
1168
|
-
* is added.</p>
|
|
1169
|
-
* @public
|
|
1170
|
-
*/
|
|
1171
|
-
ChangeDetails?: string | undefined;
|
|
1172
|
-
}
|
|
1173
|
-
/**
|
|
1174
|
-
* @public
|
|
1175
|
-
*/
|
|
1176
|
-
export interface StartChangeRequestExecutionResult {
|
|
1177
|
-
/**
|
|
1178
|
-
* <p>The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation
|
|
1179
|
-
* operation.) </p>
|
|
1180
|
-
* @public
|
|
1181
|
-
*/
|
|
1182
|
-
AutomationExecutionId?: string | undefined;
|
|
1183
|
-
}
|
|
1184
|
-
/**
|
|
1185
|
-
* <p>Information about the optional inputs that can be specified for an automation execution
|
|
1186
|
-
* preview.</p>
|
|
1187
|
-
* @public
|
|
1188
|
-
*/
|
|
1189
|
-
export interface AutomationExecutionInputs {
|
|
1190
|
-
/**
|
|
1191
|
-
* <p>Information about parameters that can be specified for the preview operation.
|
|
1192
|
-
* </p>
|
|
1193
|
-
* @public
|
|
1194
|
-
*/
|
|
1195
|
-
Parameters?: Record<string, string[]> | undefined;
|
|
1196
|
-
/**
|
|
1197
|
-
* <p>The name of the parameter used as the target resource for the rate-controlled execution.
|
|
1198
|
-
* Required if you specify targets.</p>
|
|
1199
|
-
* @public
|
|
1200
|
-
*/
|
|
1201
|
-
TargetParameterName?: string | undefined;
|
|
1202
|
-
/**
|
|
1203
|
-
* <p>Information about the resources that would be included in the actual runbook execution, if
|
|
1204
|
-
* it were to be run. Both Targets and TargetMaps can't be specified together.</p>
|
|
1205
|
-
* @public
|
|
1206
|
-
*/
|
|
1207
|
-
Targets?: Target[] | undefined;
|
|
1208
|
-
/**
|
|
1209
|
-
* <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
|
|
1210
|
-
* can't be specified together.</p>
|
|
1211
|
-
* @public
|
|
1212
|
-
*/
|
|
1213
|
-
TargetMaps?: Record<string, string[]>[] | undefined;
|
|
1214
|
-
/**
|
|
1215
|
-
* <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the Automation execution
|
|
1216
|
-
* preview operation.</p>
|
|
1217
|
-
* @public
|
|
1218
|
-
*/
|
|
1219
|
-
TargetLocations?: TargetLocation[] | undefined;
|
|
1220
|
-
/**
|
|
1221
|
-
* <p>A publicly accessible URL for a file that contains the <code>TargetLocations</code> body.
|
|
1222
|
-
* Currently, only files in presigned Amazon S3 buckets are supported.</p>
|
|
1223
|
-
* @public
|
|
1224
|
-
*/
|
|
1225
|
-
TargetLocationsURL?: string | undefined;
|
|
1226
|
-
}
|
|
1227
|
-
/**
|
|
1228
|
-
* <p>Information about the inputs for an execution preview.</p>
|
|
1229
|
-
* @public
|
|
1230
|
-
*/
|
|
1231
|
-
export type ExecutionInputs = ExecutionInputs.AutomationMember | ExecutionInputs.$UnknownMember;
|
|
1232
|
-
/**
|
|
1233
|
-
* @public
|
|
1234
|
-
*/
|
|
1235
|
-
export declare namespace ExecutionInputs {
|
|
1236
|
-
/**
|
|
1237
|
-
* <p>Information about the optional inputs that can be specified for an automation execution
|
|
1238
|
-
* preview.</p>
|
|
1239
|
-
* @public
|
|
1240
|
-
*/
|
|
1241
|
-
interface AutomationMember {
|
|
1242
|
-
Automation: AutomationExecutionInputs;
|
|
1243
|
-
$unknown?: never;
|
|
1244
|
-
}
|
|
1245
|
-
/**
|
|
1246
|
-
* @public
|
|
1247
|
-
*/
|
|
1248
|
-
interface $UnknownMember {
|
|
1249
|
-
Automation?: never;
|
|
1250
|
-
$unknown: [string, any];
|
|
1251
|
-
}
|
|
1252
|
-
/**
|
|
1253
|
-
* @deprecated unused in schema-serde mode.
|
|
1254
|
-
*
|
|
1255
|
-
*/
|
|
1256
|
-
interface Visitor<T> {
|
|
1257
|
-
Automation: (value: AutomationExecutionInputs) => T;
|
|
1258
|
-
_: (name: string, value: any) => T;
|
|
1259
|
-
}
|
|
1260
|
-
}
|
|
1261
|
-
/**
|
|
1262
|
-
* @public
|
|
1263
|
-
*/
|
|
1264
|
-
export interface StartExecutionPreviewRequest {
|
|
1265
|
-
/**
|
|
1266
|
-
* <p>The name of the Automation runbook to run. The result of the execution preview indicates
|
|
1267
|
-
* what the impact would be of running this runbook.</p>
|
|
1268
|
-
* @public
|
|
1269
|
-
*/
|
|
1270
|
-
DocumentName: string | undefined;
|
|
1271
|
-
/**
|
|
1272
|
-
* <p>The version of the Automation runbook to run. The default value is
|
|
1273
|
-
* <code>$DEFAULT</code>.</p>
|
|
1274
|
-
* @public
|
|
1275
|
-
*/
|
|
1276
|
-
DocumentVersion?: string | undefined;
|
|
1277
|
-
/**
|
|
1278
|
-
* <p>Information about the inputs that can be specified for the preview operation.
|
|
1279
|
-
* </p>
|
|
1280
|
-
* @public
|
|
1281
|
-
*/
|
|
1282
|
-
ExecutionInputs?: ExecutionInputs | undefined;
|
|
1283
|
-
}
|
|
1284
|
-
/**
|
|
1285
|
-
* @public
|
|
1286
|
-
*/
|
|
1287
|
-
export interface StartExecutionPreviewResponse {
|
|
1288
|
-
/**
|
|
1289
|
-
* <p>The ID of the execution preview generated by the system.</p>
|
|
1290
|
-
* @public
|
|
1291
|
-
*/
|
|
1292
|
-
ExecutionPreviewId?: string | undefined;
|
|
1293
|
-
}
|
|
1294
|
-
/**
|
|
1295
|
-
* @public
|
|
1296
|
-
*/
|
|
1297
|
-
export interface StartSessionRequest {
|
|
1298
|
-
/**
|
|
1299
|
-
* <p>The managed node to connect to for the session.</p>
|
|
1300
|
-
* @public
|
|
1301
|
-
*/
|
|
1302
|
-
Target: string | undefined;
|
|
1303
|
-
/**
|
|
1304
|
-
* <p>The name of the SSM document you want to use to define the type of session, input
|
|
1305
|
-
* parameters, or preferences for the session. For example, <code>SSM-SessionManagerRunShell</code>.
|
|
1306
|
-
* You can call the <a>GetDocument</a> API to verify the document exists before
|
|
1307
|
-
* attempting to start a session. If no document name is provided, a shell to the managed node is
|
|
1308
|
-
* launched by default. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html">Start a
|
|
1309
|
-
* session</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
1310
|
-
* @public
|
|
1311
|
-
*/
|
|
1312
|
-
DocumentName?: string | undefined;
|
|
1313
|
-
/**
|
|
1314
|
-
* <p>The reason for connecting to the instance. This value is included in the details for the
|
|
1315
|
-
* Amazon CloudWatch Events event created when you start the session.</p>
|
|
1316
|
-
* @public
|
|
1317
|
-
*/
|
|
1318
|
-
Reason?: string | undefined;
|
|
1319
|
-
/**
|
|
1320
|
-
* <p>The values you want to specify for the parameters defined in the Session document.
|
|
1321
|
-
* For more information about these parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/getting-started-create-preferences-cli.html">Create a
|
|
1322
|
-
* Session Manager preferences document</a> in the
|
|
1323
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
1324
|
-
* @public
|
|
1325
|
-
*/
|
|
1326
|
-
Parameters?: Record<string, string[]> | undefined;
|
|
1327
|
-
}
|
|
1328
|
-
/**
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
export interface StartSessionResponse {
|
|
1332
|
-
/**
|
|
1333
|
-
* <p>The ID of the session.</p>
|
|
1334
|
-
* @public
|
|
1335
|
-
*/
|
|
1336
|
-
SessionId?: string | undefined;
|
|
1337
|
-
/**
|
|
1338
|
-
* <p>An encrypted token value containing session and caller information. This token is used to
|
|
1339
|
-
* authenticate the connection to the managed node, and is valid only long enough to ensure the
|
|
1340
|
-
* connection is successful. Never share your session's token.</p>
|
|
1341
|
-
* @public
|
|
1342
|
-
*/
|
|
1343
|
-
TokenValue?: string | undefined;
|
|
1344
|
-
/**
|
|
1345
|
-
* <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
|
|
1346
|
-
* receive output from the node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|
1347
|
-
* </p>
|
|
1348
|
-
* <p>
|
|
1349
|
-
* <b>region</b> represents the Region identifier for an
|
|
1350
|
-
* Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.
|
|
1351
|
-
* For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems Manager service endpoints</a> in the
|
|
1352
|
-
* <i>Amazon Web Services General Reference</i>.</p>
|
|
1353
|
-
* <p>
|
|
1354
|
-
* <b>session-id</b> represents the ID of a Session Manager session, such as
|
|
1355
|
-
* <code>1a2b3c4dEXAMPLE</code>.</p>
|
|
1356
|
-
* @public
|
|
1357
|
-
*/
|
|
1358
|
-
StreamUrl?: string | undefined;
|
|
1359
|
-
}
|
|
1360
|
-
/**
|
|
1361
|
-
* <p>The specified target managed node for the session isn't fully configured for use with Session Manager.
|
|
1362
|
-
* For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html">Setting up
|
|
1363
|
-
* Session Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. This error is also returned if you
|
|
1364
|
-
* attempt to start a session on a managed node that is located in a different account or
|
|
1365
|
-
* Region</p>
|
|
1366
|
-
* @public
|
|
1367
|
-
*/
|
|
1368
|
-
export declare class TargetNotConnected extends __BaseException {
|
|
1369
|
-
readonly name: "TargetNotConnected";
|
|
1370
|
-
readonly $fault: "client";
|
|
1371
|
-
Message?: string | undefined;
|
|
1372
|
-
/**
|
|
1373
|
-
* @internal
|
|
1374
|
-
*/
|
|
1375
|
-
constructor(opts: __ExceptionOptionType<TargetNotConnected, __BaseException>);
|
|
1376
|
-
}
|
|
1377
|
-
/**
|
|
1378
|
-
* <p>The specified update status operation isn't valid.</p>
|
|
1379
|
-
* @public
|
|
1380
|
-
*/
|
|
1381
|
-
export declare class InvalidAutomationStatusUpdateException extends __BaseException {
|
|
1382
|
-
readonly name: "InvalidAutomationStatusUpdateException";
|
|
1383
|
-
readonly $fault: "client";
|
|
1384
|
-
Message?: string | undefined;
|
|
1385
|
-
/**
|
|
1386
|
-
* @internal
|
|
1387
|
-
*/
|
|
1388
|
-
constructor(opts: __ExceptionOptionType<InvalidAutomationStatusUpdateException, __BaseException>);
|
|
1389
|
-
}
|
|
1390
|
-
/**
|
|
1391
|
-
* @public
|
|
1392
|
-
* @enum
|
|
1393
|
-
*/
|
|
1394
|
-
export declare const StopType: {
|
|
1395
|
-
readonly CANCEL: "Cancel";
|
|
1396
|
-
readonly COMPLETE: "Complete";
|
|
1397
|
-
};
|
|
1398
|
-
/**
|
|
1399
|
-
* @public
|
|
1400
|
-
*/
|
|
1401
|
-
export type StopType = (typeof StopType)[keyof typeof StopType];
|
|
1402
|
-
/**
|
|
1403
|
-
* @public
|
|
1404
|
-
*/
|
|
1405
|
-
export interface StopAutomationExecutionRequest {
|
|
1406
|
-
/**
|
|
1407
|
-
* <p>The execution ID of the Automation to stop.</p>
|
|
1408
|
-
* @public
|
|
1409
|
-
*/
|
|
1410
|
-
AutomationExecutionId: string | undefined;
|
|
1411
|
-
/**
|
|
1412
|
-
* <p>The stop request type. Valid types include the following: Cancel and Complete. The default
|
|
1413
|
-
* type is Cancel.</p>
|
|
1414
|
-
* @public
|
|
1415
|
-
*/
|
|
1416
|
-
Type?: StopType | undefined;
|
|
1417
|
-
}
|
|
1418
|
-
/**
|
|
1419
|
-
* @public
|
|
1420
|
-
*/
|
|
1421
|
-
export interface StopAutomationExecutionResult {
|
|
1422
|
-
}
|
|
1423
|
-
/**
|
|
1424
|
-
* @public
|
|
1425
|
-
*/
|
|
1426
|
-
export interface TerminateSessionRequest {
|
|
1427
|
-
/**
|
|
1428
|
-
* <p>The ID of the session to terminate.</p>
|
|
1429
|
-
* @public
|
|
1430
|
-
*/
|
|
1431
|
-
SessionId: string | undefined;
|
|
1432
|
-
}
|
|
1433
|
-
/**
|
|
1434
|
-
* @public
|
|
1435
|
-
*/
|
|
1436
|
-
export interface TerminateSessionResponse {
|
|
1437
|
-
/**
|
|
1438
|
-
* <p>The ID of the session that has been terminated.</p>
|
|
1439
|
-
* @public
|
|
1440
|
-
*/
|
|
1441
|
-
SessionId?: string | undefined;
|
|
1442
|
-
}
|
|
1443
|
-
/**
|
|
1444
|
-
* @public
|
|
1445
|
-
*/
|
|
1446
|
-
export interface UnlabelParameterVersionRequest {
|
|
1447
|
-
/**
|
|
1448
|
-
* <p>The name of the parameter from which you want to delete one or more labels.</p>
|
|
1449
|
-
* <note>
|
|
1450
|
-
* <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name
|
|
1451
|
-
* itself.</p>
|
|
1452
|
-
* </note>
|
|
1453
|
-
* @public
|
|
1454
|
-
*/
|
|
1455
|
-
Name: string | undefined;
|
|
1456
|
-
/**
|
|
1457
|
-
* <p>The specific version of the parameter which you want to delete one or more labels from. If
|
|
1458
|
-
* it isn't present, the call will fail.</p>
|
|
1459
|
-
* @public
|
|
1460
|
-
*/
|
|
1461
|
-
ParameterVersion: number | undefined;
|
|
1462
|
-
/**
|
|
1463
|
-
* <p>One or more labels to delete from the specified parameter version.</p>
|
|
1464
|
-
* @public
|
|
1465
|
-
*/
|
|
1466
|
-
Labels: string[] | undefined;
|
|
1467
|
-
}
|
|
1468
|
-
/**
|
|
1469
|
-
* @public
|
|
1470
|
-
*/
|
|
1471
|
-
export interface UnlabelParameterVersionResult {
|
|
1472
|
-
/**
|
|
1473
|
-
* <p>A list of all labels deleted from the parameter.</p>
|
|
1474
|
-
* @public
|
|
1475
|
-
*/
|
|
1476
|
-
RemovedLabels?: string[] | undefined;
|
|
1477
|
-
/**
|
|
1478
|
-
* <p>The labels that aren't attached to the given parameter version.</p>
|
|
1479
|
-
* @public
|
|
1480
|
-
*/
|
|
1481
|
-
InvalidLabels?: string[] | undefined;
|
|
1482
|
-
}
|
|
1483
|
-
/**
|
|
1484
|
-
* <p>You have reached the maximum number versions allowed for an association. Each association
|
|
1485
|
-
* has a limit of 1,000 versions. </p>
|
|
1486
|
-
* @public
|
|
1487
|
-
*/
|
|
1488
|
-
export declare class AssociationVersionLimitExceeded extends __BaseException {
|
|
1489
|
-
readonly name: "AssociationVersionLimitExceeded";
|
|
1490
|
-
readonly $fault: "client";
|
|
1491
|
-
Message?: string | undefined;
|
|
1492
|
-
/**
|
|
1493
|
-
* @internal
|
|
1494
|
-
*/
|
|
1495
|
-
constructor(opts: __ExceptionOptionType<AssociationVersionLimitExceeded, __BaseException>);
|
|
1496
|
-
}
|
|
1497
|
-
/**
|
|
1498
|
-
* <p>The update isn't valid.</p>
|
|
1499
|
-
* @public
|
|
1500
|
-
*/
|
|
1501
|
-
export declare class InvalidUpdate extends __BaseException {
|
|
1502
|
-
readonly name: "InvalidUpdate";
|
|
1503
|
-
readonly $fault: "client";
|
|
1504
|
-
Message?: string | undefined;
|
|
1505
|
-
/**
|
|
1506
|
-
* @internal
|
|
1507
|
-
*/
|
|
1508
|
-
constructor(opts: __ExceptionOptionType<InvalidUpdate, __BaseException>);
|
|
1509
|
-
}
|
|
1510
|
-
/**
|
|
1511
|
-
* @public
|
|
1512
|
-
*/
|
|
1513
|
-
export interface UpdateAssociationRequest {
|
|
1514
|
-
/**
|
|
1515
|
-
* <p>The ID of the association you want to update. </p>
|
|
1516
|
-
* @public
|
|
1517
|
-
*/
|
|
1518
|
-
AssociationId: string | undefined;
|
|
1519
|
-
/**
|
|
1520
|
-
* <p>The parameters you want to update for the association. If you create a parameter using
|
|
1521
|
-
* Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using
|
|
1522
|
-
* <code>\{\{ssm:parameter-name\}\}</code>.</p>
|
|
1523
|
-
* @public
|
|
1524
|
-
*/
|
|
1525
|
-
Parameters?: Record<string, string[]> | undefined;
|
|
1526
|
-
/**
|
|
1527
|
-
* <p>The document version you want update for the association. </p>
|
|
1528
|
-
* <important>
|
|
1529
|
-
* <p>State Manager doesn't support running associations that use a new version of a document if
|
|
1530
|
-
* that document is shared from another account. State Manager always runs the <code>default</code>
|
|
1531
|
-
* version of a document if shared from another account, even though the Systems Manager console shows that a
|
|
1532
|
-
* new version was processed. If you want to run an association using a new version of a document
|
|
1533
|
-
* shared form another account, you must set the document version to <code>default</code>.</p>
|
|
1534
|
-
* </important>
|
|
1535
|
-
* @public
|
|
1536
|
-
*/
|
|
1537
|
-
DocumentVersion?: string | undefined;
|
|
1538
|
-
/**
|
|
1539
|
-
* <p>The cron expression used to schedule the association that you want to update.</p>
|
|
1540
|
-
* @public
|
|
1541
|
-
*/
|
|
1542
|
-
ScheduleExpression?: string | undefined;
|
|
1543
|
-
/**
|
|
1544
|
-
* <p>An S3 bucket where you want to store the results of this request.</p>
|
|
1545
|
-
* @public
|
|
1546
|
-
*/
|
|
1547
|
-
OutputLocation?: InstanceAssociationOutputLocation | undefined;
|
|
1548
|
-
/**
|
|
1549
|
-
* <p>The name of the SSM Command document or Automation runbook that contains the configuration
|
|
1550
|
-
* information for the managed node.</p>
|
|
1551
|
-
* <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is
|
|
1552
|
-
* shared with you from another account.</p>
|
|
1553
|
-
* <p>For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you
|
|
1554
|
-
* must specify the complete SSM document ARN, in the following format:</p>
|
|
1555
|
-
* <p>
|
|
1556
|
-
* <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>
|
|
1557
|
-
* </code>
|
|
1558
|
-
* </p>
|
|
1559
|
-
* <p>For example:</p>
|
|
1560
|
-
* <p>
|
|
1561
|
-
* <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code>
|
|
1562
|
-
* </p>
|
|
1563
|
-
* <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need
|
|
1564
|
-
* to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or
|
|
1565
|
-
* <code>My-Document</code>.</p>
|
|
1566
|
-
* @public
|
|
1567
|
-
*/
|
|
1568
|
-
Name?: string | undefined;
|
|
1569
|
-
/**
|
|
1570
|
-
* <p>The targets of the association.</p>
|
|
1571
|
-
* @public
|
|
1572
|
-
*/
|
|
1573
|
-
Targets?: Target[] | undefined;
|
|
1574
|
-
/**
|
|
1575
|
-
* <p>The name of the association that you want to update.</p>
|
|
1576
|
-
* @public
|
|
1577
|
-
*/
|
|
1578
|
-
AssociationName?: string | undefined;
|
|
1579
|
-
/**
|
|
1580
|
-
* <p>This parameter is provided for concurrency control purposes. You must specify the latest
|
|
1581
|
-
* association version in the service. If you want to ensure that this request succeeds, either
|
|
1582
|
-
* specify <code>$LATEST</code>, or omit this parameter.</p>
|
|
1583
|
-
* @public
|
|
1584
|
-
*/
|
|
1585
|
-
AssociationVersion?: string | undefined;
|
|
1586
|
-
/**
|
|
1587
|
-
* <p>Choose the parameter that will define how your automation will branch out. This target is
|
|
1588
|
-
* required for associations that use an Automation runbook and target resources by using rate
|
|
1589
|
-
* controls. Automation is a tool in Amazon Web Services Systems Manager.</p>
|
|
1590
|
-
* @public
|
|
1591
|
-
*/
|
|
1592
|
-
AutomationTargetParameterName?: string | undefined;
|
|
1593
|
-
/**
|
|
1594
|
-
* <p>The number of errors that are allowed before the system stops sending requests to run the
|
|
1595
|
-
* association on additional targets. You can specify either an absolute number of errors, for
|
|
1596
|
-
* example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,
|
|
1597
|
-
* the system stops sending requests when the fourth error is received. If you specify 0, then the
|
|
1598
|
-
* system stops sending requests after the first error is returned. If you run an association on 50
|
|
1599
|
-
* managed nodes and set <code>MaxError</code> to 10%, then the system stops sending the request
|
|
1600
|
-
* when the sixth error is received.</p>
|
|
1601
|
-
* <p>Executions that are already running an association when <code>MaxErrors</code> is reached
|
|
1602
|
-
* are allowed to complete, but some of these executions may fail as well. If you need to ensure
|
|
1603
|
-
* that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1
|
|
1604
|
-
* so that executions proceed one at a time.</p>
|
|
1605
|
-
* @public
|
|
1606
|
-
*/
|
|
1607
|
-
MaxErrors?: string | undefined;
|
|
1608
|
-
/**
|
|
1609
|
-
* <p>The maximum number of targets allowed to run the association at the same time. You can
|
|
1610
|
-
* specify a number, for example 10, or a percentage of the target set, for example 10%. The default
|
|
1611
|
-
* value is 100%, which means all targets run the association at the same time.</p>
|
|
1612
|
-
* <p>If a new managed node starts and attempts to run an association while Systems Manager is running
|
|
1613
|
-
* <code>MaxConcurrency</code> associations, the association is allowed to run. During the next
|
|
1614
|
-
* association interval, the new managed node will process its association within the limit
|
|
1615
|
-
* specified for <code>MaxConcurrency</code>.</p>
|
|
1616
|
-
* @public
|
|
1617
|
-
*/
|
|
1618
|
-
MaxConcurrency?: string | undefined;
|
|
1619
|
-
/**
|
|
1620
|
-
* <p>The severity level to assign to the association.</p>
|
|
1621
|
-
* @public
|
|
1622
|
-
*/
|
|
1623
|
-
ComplianceSeverity?: AssociationComplianceSeverity | undefined;
|
|
1624
|
-
/**
|
|
1625
|
-
* <p>The mode for generating association compliance. You can specify <code>AUTO</code> or
|
|
1626
|
-
* <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association
|
|
1627
|
-
* execution to determine the compliance status. If the association execution runs successfully,
|
|
1628
|
-
* then the association is <code>COMPLIANT</code>. If the association execution doesn't run
|
|
1629
|
-
* successfully, the association is <code>NON-COMPLIANT</code>.</p>
|
|
1630
|
-
* <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter
|
|
1631
|
-
* for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't
|
|
1632
|
-
* managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p>
|
|
1633
|
-
* <p>By default, all associations use <code>AUTO</code> mode.</p>
|
|
1634
|
-
* @public
|
|
1635
|
-
*/
|
|
1636
|
-
SyncCompliance?: AssociationSyncCompliance | undefined;
|
|
1637
|
-
/**
|
|
1638
|
-
* <p>By default, when you update an association, the system runs it immediately after it is
|
|
1639
|
-
* updated and then according to the schedule you specified. Specify <code>true</code> for
|
|
1640
|
-
* <code>ApplyOnlyAtCronInterval</code> if you want the association to run only according to the
|
|
1641
|
-
* schedule you specified.</p>
|
|
1642
|
-
* <p>If you chose this option when you created an association and later you edit that association
|
|
1643
|
-
* or you make changes to the Automation runbook or SSM document on which that association is based,
|
|
1644
|
-
* State Manager applies the association at the next specified cron interval. For example, if you
|
|
1645
|
-
* chose the <code>Latest</code> version of an SSM document when you created an association and you
|
|
1646
|
-
* edit the association by choosing a different document version on the Documents page, State
|
|
1647
|
-
* Manager applies the association at the next specified cron interval if you previously set
|
|
1648
|
-
* <code>ApplyOnlyAtCronInterval</code> to <code>true</code>. If this option wasn't selected, State
|
|
1649
|
-
* Manager immediately runs the association.</p>
|
|
1650
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling">Understanding when associations are applied to resources</a> and <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates">About
|
|
1651
|
-
* target updates with Automation runbooks</a> in the
|
|
1652
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
1653
|
-
* <p>This parameter isn't supported for rate expressions.</p>
|
|
1654
|
-
* <p>You can reset this parameter. To do so, specify the
|
|
1655
|
-
* <code>no-apply-only-at-cron-interval</code> parameter when you update the association from the
|
|
1656
|
-
* command line. This parameter forces the association to run immediately after updating it and
|
|
1657
|
-
* according to the interval specified.</p>
|
|
1658
|
-
* @public
|
|
1659
|
-
*/
|
|
1660
|
-
ApplyOnlyAtCronInterval?: boolean | undefined;
|
|
1661
|
-
/**
|
|
1662
|
-
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to
|
|
1663
|
-
* gate your associations under. The associations only run when that change calendar is open. For
|
|
1664
|
-
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
|
|
1665
|
-
* Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
1666
|
-
* @public
|
|
1667
|
-
*/
|
|
1668
|
-
CalendarNames?: string[] | undefined;
|
|
1669
|
-
/**
|
|
1670
|
-
* <p>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
|
|
1671
|
-
* association. Use this action to update an association in multiple Regions and multiple
|
|
1672
|
-
* accounts.</p>
|
|
1673
|
-
* <note>
|
|
1674
|
-
* <p>The <code>IncludeChildOrganizationUnits</code> parameter is not supported by State
|
|
1675
|
-
* Manager.</p>
|
|
1676
|
-
* </note>
|
|
1677
|
-
* @public
|
|
1678
|
-
*/
|
|
1679
|
-
TargetLocations?: TargetLocation[] | undefined;
|
|
1680
|
-
/**
|
|
1681
|
-
* <p>Number of days to wait after the scheduled day to run an association. For example, if you
|
|
1682
|
-
* specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3
|
|
1683
|
-
* to run the association each Sunday after the second Thursday of the month. For more information
|
|
1684
|
-
* 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
|
|
1685
|
-
* and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
|
|
1686
|
-
* <note>
|
|
1687
|
-
* <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This
|
|
1688
|
-
* option tells the system not to run an association immediately after you create it. </p>
|
|
1689
|
-
* </note>
|
|
1690
|
-
* @public
|
|
1691
|
-
*/
|
|
1692
|
-
ScheduleOffset?: number | undefined;
|
|
1693
|
-
/**
|
|
1694
|
-
* <p>The number of hours the association can run before it is canceled. Duration applies to
|
|
1695
|
-
* associations that are currently running, and any pending and in progress commands on all targets.
|
|
1696
|
-
* If a target was taken offline for the association to run, it is made available again immediately,
|
|
1697
|
-
* without a reboot. </p>
|
|
1698
|
-
* <p>The <code>Duration</code> parameter applies only when both these conditions are true:</p>
|
|
1699
|
-
* <ul>
|
|
1700
|
-
* <li>
|
|
1701
|
-
* <p>The association for which you specify a duration is cancelable according to the parameters
|
|
1702
|
-
* of the SSM command document or Automation runbook associated with this execution. </p>
|
|
1703
|
-
* </li>
|
|
1704
|
-
* <li>
|
|
1705
|
-
* <p>The command specifies the <code>
|
|
1706
|
-
* <a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_UpdateAssociation.html#systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval">ApplyOnlyAtCronInterval</a>
|
|
1707
|
-
* </code> parameter, which means that the association doesn't
|
|
1708
|
-
* run immediately after it is updated, but only according to the specified schedule.</p>
|
|
1709
|
-
* </li>
|
|
1710
|
-
* </ul>
|
|
1711
|
-
* @public
|
|
1712
|
-
*/
|
|
1713
|
-
Duration?: number | undefined;
|
|
1714
|
-
/**
|
|
1715
|
-
* <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
|
|
1716
|
-
* can't be specified together.</p>
|
|
1717
|
-
* @public
|
|
1718
|
-
*/
|
|
1719
|
-
TargetMaps?: Record<string, string[]>[] | undefined;
|
|
1720
|
-
/**
|
|
1721
|
-
* <p>The details for the CloudWatch alarm you want to apply to an automation or
|
|
1722
|
-
* command.</p>
|
|
1723
|
-
* @public
|
|
1724
|
-
*/
|
|
1725
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
1726
|
-
}
|
|
1727
|
-
/**
|
|
1728
|
-
* @public
|
|
1729
|
-
*/
|
|
1730
|
-
export interface UpdateAssociationResult {
|
|
1731
|
-
/**
|
|
1732
|
-
* <p>The description of the association that was updated.</p>
|
|
1733
|
-
* @public
|
|
1734
|
-
*/
|
|
1735
|
-
AssociationDescription?: AssociationDescription | undefined;
|
|
1736
|
-
}
|
|
1737
|
-
/**
|
|
1738
|
-
* <p>The updated status is the same as the current status.</p>
|
|
1739
|
-
* @public
|
|
1740
|
-
*/
|
|
1741
|
-
export declare class StatusUnchanged extends __BaseException {
|
|
1742
|
-
readonly name: "StatusUnchanged";
|
|
1743
|
-
readonly $fault: "client";
|
|
1744
|
-
/**
|
|
1745
|
-
* @internal
|
|
1746
|
-
*/
|
|
1747
|
-
constructor(opts: __ExceptionOptionType<StatusUnchanged, __BaseException>);
|
|
1748
|
-
}
|
|
1749
|
-
/**
|
|
1750
|
-
* @public
|
|
1751
|
-
*/
|
|
1752
|
-
export interface UpdateAssociationStatusRequest {
|
|
1753
|
-
/**
|
|
1754
|
-
* <p>The name of the SSM document.</p>
|
|
1755
|
-
* @public
|
|
1756
|
-
*/
|
|
1757
|
-
Name: string | undefined;
|
|
1758
|
-
/**
|
|
1759
|
-
* <p>The managed node ID.</p>
|
|
1760
|
-
* @public
|
|
1761
|
-
*/
|
|
1762
|
-
InstanceId: string | undefined;
|
|
1763
|
-
/**
|
|
1764
|
-
* <p>The association status.</p>
|
|
1765
|
-
* @public
|
|
1766
|
-
*/
|
|
1767
|
-
AssociationStatus: AssociationStatus | undefined;
|
|
1768
|
-
}
|
|
1769
|
-
/**
|
|
1770
|
-
* @public
|
|
1771
|
-
*/
|
|
1772
|
-
export interface UpdateAssociationStatusResult {
|
|
1773
|
-
/**
|
|
1774
|
-
* <p>Information about the association.</p>
|
|
1775
|
-
* @public
|
|
1776
|
-
*/
|
|
1777
|
-
AssociationDescription?: AssociationDescription | undefined;
|
|
1778
|
-
}
|
|
1779
|
-
/**
|
|
1780
|
-
* <p>The document has too many versions. Delete one or more document versions and try
|
|
1781
|
-
* again.</p>
|
|
1782
|
-
* @public
|
|
1783
|
-
*/
|
|
1784
|
-
export declare class DocumentVersionLimitExceeded extends __BaseException {
|
|
1785
|
-
readonly name: "DocumentVersionLimitExceeded";
|
|
1786
|
-
readonly $fault: "client";
|
|
1787
|
-
Message?: string | undefined;
|
|
1788
|
-
/**
|
|
1789
|
-
* @internal
|
|
1790
|
-
*/
|
|
1791
|
-
constructor(opts: __ExceptionOptionType<DocumentVersionLimitExceeded, __BaseException>);
|
|
1792
|
-
}
|
|
1793
|
-
/**
|
|
1794
|
-
* <p>The content of the association document matches another document. Change the content of the
|
|
1795
|
-
* document and try again.</p>
|
|
1796
|
-
* @public
|
|
1797
|
-
*/
|
|
1798
|
-
export declare class DuplicateDocumentContent extends __BaseException {
|
|
1799
|
-
readonly name: "DuplicateDocumentContent";
|
|
1800
|
-
readonly $fault: "client";
|
|
1801
|
-
Message?: string | undefined;
|
|
1802
|
-
/**
|
|
1803
|
-
* @internal
|
|
1804
|
-
*/
|
|
1805
|
-
constructor(opts: __ExceptionOptionType<DuplicateDocumentContent, __BaseException>);
|
|
1806
|
-
}
|
|
1807
|
-
/**
|
|
1808
|
-
* <p>The version name has already been used in this document. Specify a different version name,
|
|
1809
|
-
* and then try again.</p>
|
|
1810
|
-
* @public
|
|
1811
|
-
*/
|
|
1812
|
-
export declare class DuplicateDocumentVersionName extends __BaseException {
|
|
1813
|
-
readonly name: "DuplicateDocumentVersionName";
|
|
1814
|
-
readonly $fault: "client";
|
|
1815
|
-
Message?: string | undefined;
|
|
1816
|
-
/**
|
|
1817
|
-
* @internal
|
|
1818
|
-
*/
|
|
1819
|
-
constructor(opts: __ExceptionOptionType<DuplicateDocumentVersionName, __BaseException>);
|
|
1820
|
-
}
|
|
1821
|
-
/**
|
|
1822
|
-
* @public
|
|
1823
|
-
*/
|
|
1824
|
-
export interface UpdateDocumentRequest {
|
|
1825
|
-
/**
|
|
1826
|
-
* <p>A valid JSON or YAML string.</p>
|
|
1827
|
-
* @public
|
|
1828
|
-
*/
|
|
1829
|
-
Content: string | undefined;
|
|
1830
|
-
/**
|
|
1831
|
-
* <p>A list of key-value pairs that describe attachments to a version of a document.</p>
|
|
1832
|
-
* @public
|
|
1833
|
-
*/
|
|
1834
|
-
Attachments?: AttachmentsSource[] | undefined;
|
|
1835
|
-
/**
|
|
1836
|
-
* <p>The name of the SSM document that you want to update.</p>
|
|
1837
|
-
* @public
|
|
1838
|
-
*/
|
|
1839
|
-
Name: string | undefined;
|
|
1840
|
-
/**
|
|
1841
|
-
* <p>The friendly name of the SSM document that you want to update. This value can differ for
|
|
1842
|
-
* each version of the document. If you don't specify a value for this parameter in your request,
|
|
1843
|
-
* the existing value is applied to the new document version.</p>
|
|
1844
|
-
* @public
|
|
1845
|
-
*/
|
|
1846
|
-
DisplayName?: string | undefined;
|
|
1847
|
-
/**
|
|
1848
|
-
* <p>An optional field specifying the version of the artifact you are updating with the document.
|
|
1849
|
-
* For example, 12.6. This value is unique across all versions of a document, and can't be
|
|
1850
|
-
* changed.</p>
|
|
1851
|
-
* @public
|
|
1852
|
-
*/
|
|
1853
|
-
VersionName?: string | undefined;
|
|
1854
|
-
/**
|
|
1855
|
-
* <p>The version of the document that you want to update. Currently, Systems Manager supports updating only
|
|
1856
|
-
* the latest version of the document. You can specify the version number of the latest version or
|
|
1857
|
-
* use the <code>$LATEST</code> variable.</p>
|
|
1858
|
-
* <note>
|
|
1859
|
-
* <p>If you change a document version for a State Manager association, Systems Manager immediately runs
|
|
1860
|
-
* the association unless you previously specifed the <code>apply-only-at-cron-interval</code>
|
|
1861
|
-
* parameter.</p>
|
|
1862
|
-
* </note>
|
|
1863
|
-
* @public
|
|
1864
|
-
*/
|
|
1865
|
-
DocumentVersion?: string | undefined;
|
|
1866
|
-
/**
|
|
1867
|
-
* <p>Specify the document format for the new document version. Systems Manager supports JSON and YAML
|
|
1868
|
-
* documents. JSON is the default format.</p>
|
|
1869
|
-
* @public
|
|
1870
|
-
*/
|
|
1871
|
-
DocumentFormat?: DocumentFormat | undefined;
|
|
1872
|
-
/**
|
|
1873
|
-
* <p>Specify a new target type for the document.</p>
|
|
1874
|
-
* @public
|
|
1875
|
-
*/
|
|
1876
|
-
TargetType?: string | undefined;
|
|
1877
|
-
}
|
|
1878
|
-
/**
|
|
1879
|
-
* @public
|
|
1880
|
-
*/
|
|
1881
|
-
export interface UpdateDocumentResult {
|
|
1882
|
-
/**
|
|
1883
|
-
* <p>A description of the document that was updated.</p>
|
|
1884
|
-
* @public
|
|
1885
|
-
*/
|
|
1886
|
-
DocumentDescription?: DocumentDescription | undefined;
|
|
1887
|
-
}
|
|
1888
|
-
/**
|
|
1889
|
-
* @public
|
|
1890
|
-
*/
|
|
1891
|
-
export interface UpdateDocumentDefaultVersionRequest {
|
|
1892
|
-
/**
|
|
1893
|
-
* <p>The name of a custom document that you want to set as the default version.</p>
|
|
1894
|
-
* @public
|
|
1895
|
-
*/
|
|
1896
|
-
Name: string | undefined;
|
|
1897
|
-
/**
|
|
1898
|
-
* <p>The version of a custom document that you want to set as the default version.</p>
|
|
1899
|
-
* @public
|
|
1900
|
-
*/
|
|
1901
|
-
DocumentVersion: string | undefined;
|
|
1902
|
-
}
|
|
1903
|
-
/**
|
|
1904
|
-
* <p>A default version of a document.</p>
|
|
1905
|
-
* @public
|
|
1906
|
-
*/
|
|
1907
|
-
export interface DocumentDefaultVersionDescription {
|
|
1908
|
-
/**
|
|
1909
|
-
* <p>The name of the document.</p>
|
|
1910
|
-
* @public
|
|
1911
|
-
*/
|
|
1912
|
-
Name?: string | undefined;
|
|
1913
|
-
/**
|
|
1914
|
-
* <p>The default version of the document.</p>
|
|
1915
|
-
* @public
|
|
1916
|
-
*/
|
|
1917
|
-
DefaultVersion?: string | undefined;
|
|
1918
|
-
/**
|
|
1919
|
-
* <p>The default version of the artifact associated with the document.</p>
|
|
1920
|
-
* @public
|
|
1921
|
-
*/
|
|
1922
|
-
DefaultVersionName?: string | undefined;
|
|
1923
|
-
}
|
|
1924
|
-
/**
|
|
1925
|
-
* @public
|
|
1926
|
-
*/
|
|
1927
|
-
export interface UpdateDocumentDefaultVersionResult {
|
|
1928
|
-
/**
|
|
1929
|
-
* <p>The description of a custom document that you want to set as the default version.</p>
|
|
1930
|
-
* @public
|
|
1931
|
-
*/
|
|
1932
|
-
Description?: DocumentDefaultVersionDescription | undefined;
|
|
1933
|
-
}
|
|
1934
|
-
/**
|
|
1935
|
-
* @public
|
|
1936
|
-
* @enum
|
|
1937
|
-
*/
|
|
1938
|
-
export declare const DocumentReviewAction: {
|
|
1939
|
-
readonly Approve: "Approve";
|
|
1940
|
-
readonly Reject: "Reject";
|
|
1941
|
-
readonly SendForReview: "SendForReview";
|
|
1942
|
-
readonly UpdateReview: "UpdateReview";
|
|
1943
|
-
};
|
|
1944
|
-
/**
|
|
1945
|
-
* @public
|
|
1946
|
-
*/
|
|
1947
|
-
export type DocumentReviewAction = (typeof DocumentReviewAction)[keyof typeof DocumentReviewAction];
|
|
1948
|
-
/**
|
|
1949
|
-
* <p>Information about a document approval review.</p>
|
|
1950
|
-
* @public
|
|
1951
|
-
*/
|
|
1952
|
-
export interface DocumentReviews {
|
|
1953
|
-
/**
|
|
1954
|
-
* <p>The action to take on a document approval review request.</p>
|
|
1955
|
-
* @public
|
|
1956
|
-
*/
|
|
1957
|
-
Action: DocumentReviewAction | undefined;
|
|
1958
|
-
/**
|
|
1959
|
-
* <p>A comment entered by a user in your organization about the document review request.</p>
|
|
1960
|
-
* @public
|
|
1961
|
-
*/
|
|
1962
|
-
Comment?: DocumentReviewCommentSource[] | undefined;
|
|
1963
|
-
}
|
|
1964
|
-
/**
|
|
1965
|
-
* @public
|
|
1966
|
-
*/
|
|
1967
|
-
export interface UpdateDocumentMetadataRequest {
|
|
1968
|
-
/**
|
|
1969
|
-
* <p>The name of the change template for which a version's metadata is to be updated.</p>
|
|
1970
|
-
* @public
|
|
1971
|
-
*/
|
|
1972
|
-
Name: string | undefined;
|
|
1973
|
-
/**
|
|
1974
|
-
* <p>The version of a change template in which to update approval metadata.</p>
|
|
1975
|
-
* @public
|
|
1976
|
-
*/
|
|
1977
|
-
DocumentVersion?: string | undefined;
|
|
1978
|
-
/**
|
|
1979
|
-
* <p>The change template review details to update.</p>
|
|
1980
|
-
* @public
|
|
1981
|
-
*/
|
|
1982
|
-
DocumentReviews: DocumentReviews | undefined;
|
|
1983
|
-
}
|
|
1984
|
-
/**
|
|
1985
|
-
* @public
|
|
1986
|
-
*/
|
|
1987
|
-
export interface UpdateDocumentMetadataResponse {
|
|
1988
|
-
}
|
|
1989
|
-
/**
|
|
1990
|
-
* @public
|
|
1991
|
-
*/
|
|
1992
|
-
export interface UpdateMaintenanceWindowRequest {
|
|
1993
|
-
/**
|
|
1994
|
-
* <p>The ID of the maintenance window to update.</p>
|
|
1995
|
-
* @public
|
|
1996
|
-
*/
|
|
1997
|
-
WindowId: string | undefined;
|
|
1998
|
-
/**
|
|
1999
|
-
* <p>The name of the maintenance window.</p>
|
|
2000
|
-
* @public
|
|
2001
|
-
*/
|
|
2002
|
-
Name?: string | undefined;
|
|
2003
|
-
/**
|
|
2004
|
-
* <p>An optional description for the update request.</p>
|
|
2005
|
-
* @public
|
|
2006
|
-
*/
|
|
2007
|
-
Description?: string | undefined;
|
|
2008
|
-
/**
|
|
2009
|
-
* <p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to
|
|
2010
|
-
* become active. <code>StartDate</code> allows you to delay activation of the maintenance window
|
|
2011
|
-
* until the specified future date.</p>
|
|
2012
|
-
* <note>
|
|
2013
|
-
* <p>When using a rate schedule, if you provide a start date that occurs in the past, the
|
|
2014
|
-
* current date and time are used as the start date. </p>
|
|
2015
|
-
* </note>
|
|
2016
|
-
* @public
|
|
2017
|
-
*/
|
|
2018
|
-
StartDate?: string | undefined;
|
|
2019
|
-
/**
|
|
2020
|
-
* <p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to
|
|
2021
|
-
* become inactive. <code>EndDate</code> allows you to set a date and time in the future when the
|
|
2022
|
-
* maintenance window will no longer run.</p>
|
|
2023
|
-
* @public
|
|
2024
|
-
*/
|
|
2025
|
-
EndDate?: string | undefined;
|
|
2026
|
-
/**
|
|
2027
|
-
* <p>The schedule of the maintenance window in the form of a cron or rate expression.</p>
|
|
2028
|
-
* @public
|
|
2029
|
-
*/
|
|
2030
|
-
Schedule?: string | undefined;
|
|
2031
|
-
/**
|
|
2032
|
-
* <p>The time zone that the scheduled maintenance window executions are based on, in Internet
|
|
2033
|
-
* Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
|
|
2034
|
-
* "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time
|
|
2035
|
-
* Zone Database</a> on the IANA website.</p>
|
|
2036
|
-
* @public
|
|
2037
|
-
*/
|
|
2038
|
-
ScheduleTimezone?: string | undefined;
|
|
2039
|
-
/**
|
|
2040
|
-
* <p>The number of days to wait after the date and time specified by a cron expression before
|
|
2041
|
-
* running the maintenance window.</p>
|
|
2042
|
-
* <p>For example, the following cron expression schedules a maintenance window to run the third
|
|
2043
|
-
* Tuesday of every month at 11:30 PM.</p>
|
|
2044
|
-
* <p>
|
|
2045
|
-
* <code>cron(30 23 ? * TUE#3 *)</code>
|
|
2046
|
-
* </p>
|
|
2047
|
-
* <p>If the schedule offset is <code>2</code>, the maintenance window won't run until two days
|
|
2048
|
-
* later.</p>
|
|
2049
|
-
* @public
|
|
2050
|
-
*/
|
|
2051
|
-
ScheduleOffset?: number | undefined;
|
|
2052
|
-
/**
|
|
2053
|
-
* <p>The duration of the maintenance window in hours.</p>
|
|
2054
|
-
* @public
|
|
2055
|
-
*/
|
|
2056
|
-
Duration?: number | undefined;
|
|
2057
|
-
/**
|
|
2058
|
-
* <p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling
|
|
2059
|
-
* new tasks for execution.</p>
|
|
2060
|
-
* @public
|
|
2061
|
-
*/
|
|
2062
|
-
Cutoff?: number | undefined;
|
|
2063
|
-
/**
|
|
2064
|
-
* <p>Whether targets must be registered with the maintenance window before tasks can be defined
|
|
2065
|
-
* for those targets.</p>
|
|
2066
|
-
* @public
|
|
2067
|
-
*/
|
|
2068
|
-
AllowUnassociatedTargets?: boolean | undefined;
|
|
2069
|
-
/**
|
|
2070
|
-
* <p>Whether the maintenance window is enabled.</p>
|
|
2071
|
-
* @public
|
|
2072
|
-
*/
|
|
2073
|
-
Enabled?: boolean | undefined;
|
|
2074
|
-
/**
|
|
2075
|
-
* <p>If <code>True</code>, then all fields that are required by the <a>CreateMaintenanceWindow</a> operation are also required for this API request. Optional
|
|
2076
|
-
* fields that aren't specified are set to null. </p>
|
|
2077
|
-
* @public
|
|
2078
|
-
*/
|
|
2079
|
-
Replace?: boolean | undefined;
|
|
2080
|
-
}
|
|
2081
|
-
/**
|
|
2082
|
-
* @public
|
|
2083
|
-
*/
|
|
2084
|
-
export interface UpdateMaintenanceWindowResult {
|
|
2085
|
-
/**
|
|
2086
|
-
* <p>The ID of the created maintenance window.</p>
|
|
2087
|
-
* @public
|
|
2088
|
-
*/
|
|
2089
|
-
WindowId?: string | undefined;
|
|
2090
|
-
/**
|
|
2091
|
-
* <p>The name of the maintenance window.</p>
|
|
2092
|
-
* @public
|
|
2093
|
-
*/
|
|
2094
|
-
Name?: string | undefined;
|
|
2095
|
-
/**
|
|
2096
|
-
* <p>An optional description of the update.</p>
|
|
2097
|
-
* @public
|
|
2098
|
-
*/
|
|
2099
|
-
Description?: string | undefined;
|
|
2100
|
-
/**
|
|
2101
|
-
* <p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled
|
|
2102
|
-
* to become active. The maintenance window won't run before this specified time.</p>
|
|
2103
|
-
* @public
|
|
2104
|
-
*/
|
|
2105
|
-
StartDate?: string | undefined;
|
|
2106
|
-
/**
|
|
2107
|
-
* <p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled
|
|
2108
|
-
* to become inactive. The maintenance window won't run after this specified time.</p>
|
|
2109
|
-
* @public
|
|
2110
|
-
*/
|
|
2111
|
-
EndDate?: string | undefined;
|
|
2112
|
-
/**
|
|
2113
|
-
* <p>The schedule of the maintenance window in the form of a cron or rate expression.</p>
|
|
2114
|
-
* @public
|
|
2115
|
-
*/
|
|
2116
|
-
Schedule?: string | undefined;
|
|
2117
|
-
/**
|
|
2118
|
-
* <p>The time zone that the scheduled maintenance window executions are based on, in Internet
|
|
2119
|
-
* Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
|
|
2120
|
-
* "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time
|
|
2121
|
-
* Zone Database</a> on the IANA website.</p>
|
|
2122
|
-
* @public
|
|
2123
|
-
*/
|
|
2124
|
-
ScheduleTimezone?: string | undefined;
|
|
2125
|
-
/**
|
|
2126
|
-
* <p>The number of days to wait to run a maintenance window after the scheduled cron expression
|
|
2127
|
-
* date and time.</p>
|
|
2128
|
-
* @public
|
|
2129
|
-
*/
|
|
2130
|
-
ScheduleOffset?: number | undefined;
|
|
2131
|
-
/**
|
|
2132
|
-
* <p>The duration of the maintenance window in hours.</p>
|
|
2133
|
-
* @public
|
|
2134
|
-
*/
|
|
2135
|
-
Duration?: number | undefined;
|
|
2136
|
-
/**
|
|
2137
|
-
* <p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling
|
|
2138
|
-
* new tasks for execution.</p>
|
|
2139
|
-
* @public
|
|
2140
|
-
*/
|
|
2141
|
-
Cutoff?: number | undefined;
|
|
2142
|
-
/**
|
|
2143
|
-
* <p>Whether targets must be registered with the maintenance window before tasks can be defined
|
|
2144
|
-
* for those targets.</p>
|
|
2145
|
-
* @public
|
|
2146
|
-
*/
|
|
2147
|
-
AllowUnassociatedTargets?: boolean | undefined;
|
|
2148
|
-
/**
|
|
2149
|
-
* <p>Whether the maintenance window is enabled.</p>
|
|
2150
|
-
* @public
|
|
2151
|
-
*/
|
|
2152
|
-
Enabled?: boolean | undefined;
|
|
2153
|
-
}
|
|
2154
|
-
/**
|
|
2155
|
-
* @public
|
|
2156
|
-
*/
|
|
2157
|
-
export interface UpdateMaintenanceWindowTargetRequest {
|
|
2158
|
-
/**
|
|
2159
|
-
* <p>The maintenance window ID with which to modify the target.</p>
|
|
2160
|
-
* @public
|
|
2161
|
-
*/
|
|
2162
|
-
WindowId: string | undefined;
|
|
2163
|
-
/**
|
|
2164
|
-
* <p>The target ID to modify.</p>
|
|
2165
|
-
* @public
|
|
2166
|
-
*/
|
|
2167
|
-
WindowTargetId: string | undefined;
|
|
2168
|
-
/**
|
|
2169
|
-
* <p>The targets to add or replace.</p>
|
|
2170
|
-
* @public
|
|
2171
|
-
*/
|
|
2172
|
-
Targets?: Target[] | undefined;
|
|
2173
|
-
/**
|
|
2174
|
-
* <p>User-provided value that will be included in any Amazon CloudWatch Events events raised while
|
|
2175
|
-
* running tasks for these targets in this maintenance window.</p>
|
|
2176
|
-
* @public
|
|
2177
|
-
*/
|
|
2178
|
-
OwnerInformation?: string | undefined;
|
|
2179
|
-
/**
|
|
2180
|
-
* <p>A name for the update.</p>
|
|
2181
|
-
* @public
|
|
2182
|
-
*/
|
|
2183
|
-
Name?: string | undefined;
|
|
2184
|
-
/**
|
|
2185
|
-
* <p>An optional description for the update.</p>
|
|
2186
|
-
* @public
|
|
2187
|
-
*/
|
|
2188
|
-
Description?: string | undefined;
|
|
2189
|
-
/**
|
|
2190
|
-
* <p>If <code>True</code>, then all fields that are required by the <a>RegisterTargetWithMaintenanceWindow</a> operation are also required for this API
|
|
2191
|
-
* request. Optional fields that aren't specified are set to null.</p>
|
|
2192
|
-
* @public
|
|
2193
|
-
*/
|
|
2194
|
-
Replace?: boolean | undefined;
|
|
2195
|
-
}
|
|
2196
|
-
/**
|
|
2197
|
-
* @public
|
|
2198
|
-
*/
|
|
2199
|
-
export interface UpdateMaintenanceWindowTargetResult {
|
|
2200
|
-
/**
|
|
2201
|
-
* <p>The maintenance window ID specified in the update request.</p>
|
|
2202
|
-
* @public
|
|
2203
|
-
*/
|
|
2204
|
-
WindowId?: string | undefined;
|
|
2205
|
-
/**
|
|
2206
|
-
* <p>The target ID specified in the update request.</p>
|
|
2207
|
-
* @public
|
|
2208
|
-
*/
|
|
2209
|
-
WindowTargetId?: string | undefined;
|
|
2210
|
-
/**
|
|
2211
|
-
* <p>The updated targets.</p>
|
|
2212
|
-
* @public
|
|
2213
|
-
*/
|
|
2214
|
-
Targets?: Target[] | undefined;
|
|
2215
|
-
/**
|
|
2216
|
-
* <p>The updated owner.</p>
|
|
2217
|
-
* @public
|
|
2218
|
-
*/
|
|
2219
|
-
OwnerInformation?: string | undefined;
|
|
2220
|
-
/**
|
|
2221
|
-
* <p>The updated name.</p>
|
|
2222
|
-
* @public
|
|
2223
|
-
*/
|
|
2224
|
-
Name?: string | undefined;
|
|
2225
|
-
/**
|
|
2226
|
-
* <p>The updated description.</p>
|
|
2227
|
-
* @public
|
|
2228
|
-
*/
|
|
2229
|
-
Description?: string | undefined;
|
|
2230
|
-
}
|
|
2231
|
-
/**
|
|
2232
|
-
* @public
|
|
2233
|
-
*/
|
|
2234
|
-
export interface UpdateMaintenanceWindowTaskRequest {
|
|
2235
|
-
/**
|
|
2236
|
-
* <p>The maintenance window ID that contains the task to modify.</p>
|
|
2237
|
-
* @public
|
|
2238
|
-
*/
|
|
2239
|
-
WindowId: string | undefined;
|
|
2240
|
-
/**
|
|
2241
|
-
* <p>The task ID to modify.</p>
|
|
2242
|
-
* @public
|
|
2243
|
-
*/
|
|
2244
|
-
WindowTaskId: string | undefined;
|
|
2245
|
-
/**
|
|
2246
|
-
* <p>The targets (either managed nodes or tags) to modify. Managed nodes are specified using the
|
|
2247
|
-
* format <code>Key=instanceids,Values=instanceID_1,instanceID_2</code>. Tags are specified using
|
|
2248
|
-
* the format <code> Key=tag_name,Values=tag_value</code>. </p>
|
|
2249
|
-
* <note>
|
|
2250
|
-
* <p>One or more targets must be specified for maintenance window Run Command-type tasks.
|
|
2251
|
-
* Depending on the task, targets are optional for other maintenance window task types (Automation,
|
|
2252
|
-
* Lambda, and Step Functions). For more information about running tasks
|
|
2253
|
-
* that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering
|
|
2254
|
-
* maintenance window tasks without targets</a> in the
|
|
2255
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2256
|
-
* </note>
|
|
2257
|
-
* @public
|
|
2258
|
-
*/
|
|
2259
|
-
Targets?: Target[] | undefined;
|
|
2260
|
-
/**
|
|
2261
|
-
* <p>The task ARN to modify.</p>
|
|
2262
|
-
* @public
|
|
2263
|
-
*/
|
|
2264
|
-
TaskArn?: string | undefined;
|
|
2265
|
-
/**
|
|
2266
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role for
|
|
2267
|
-
* Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a
|
|
2268
|
-
* service role ARN, Systems Manager uses a service-linked role in your account. If no
|
|
2269
|
-
* appropriate service-linked role for Systems Manager exists in your account, it is created when
|
|
2270
|
-
* you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
|
|
2271
|
-
* <p>However, for an improved security posture, we strongly recommend creating a custom
|
|
2272
|
-
* policy and custom service role for running your maintenance window tasks. The policy
|
|
2273
|
-
* can be crafted to provide only the permissions needed for your particular
|
|
2274
|
-
* maintenance window tasks. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html">Setting up Maintenance Windows</a> in the in the
|
|
2275
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2276
|
-
* @public
|
|
2277
|
-
*/
|
|
2278
|
-
ServiceRoleArn?: string | undefined;
|
|
2279
|
-
/**
|
|
2280
|
-
* <p>The parameters to modify.</p>
|
|
2281
|
-
* <note>
|
|
2282
|
-
* <p>
|
|
2283
|
-
* <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs,
|
|
2284
|
-
* instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information
|
|
2285
|
-
* about how Systems Manager handles these options for the supported maintenance window task
|
|
2286
|
-
* types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
2287
|
-
* </note>
|
|
2288
|
-
* <p>The map has the following format:</p>
|
|
2289
|
-
* <p>Key: string, between 1 and 255 characters</p>
|
|
2290
|
-
* <p>Value: an array of strings, each string is between 1 and 255 characters</p>
|
|
2291
|
-
* @public
|
|
2292
|
-
*/
|
|
2293
|
-
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression> | undefined;
|
|
2294
|
-
/**
|
|
2295
|
-
* <p>The parameters that the task should use during execution. Populate only the fields that
|
|
2296
|
-
* match the task type. All other fields should be empty.</p>
|
|
2297
|
-
* <important>
|
|
2298
|
-
* <p>When you update a maintenance window task that has options specified in
|
|
2299
|
-
* <code>TaskInvocationParameters</code>, you must provide again all the
|
|
2300
|
-
* <code>TaskInvocationParameters</code> values that you want to retain. The values you don't
|
|
2301
|
-
* specify again are removed. For example, suppose that when you registered a Run Command task, you
|
|
2302
|
-
* specified <code>TaskInvocationParameters</code> values for <code>Comment</code>,
|
|
2303
|
-
* <code>NotificationConfig</code>, and <code>OutputS3BucketName</code>. If you update the
|
|
2304
|
-
* maintenance window task and specify only a different <code>OutputS3BucketName</code> value, the
|
|
2305
|
-
* values for <code>Comment</code> and <code>NotificationConfig</code> are removed.</p>
|
|
2306
|
-
* </important>
|
|
2307
|
-
* @public
|
|
2308
|
-
*/
|
|
2309
|
-
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | undefined;
|
|
2310
|
-
/**
|
|
2311
|
-
* <p>The new task priority to specify. The lower the number, the higher the priority. Tasks that
|
|
2312
|
-
* have the same priority are scheduled in parallel.</p>
|
|
2313
|
-
* @public
|
|
2314
|
-
*/
|
|
2315
|
-
Priority?: number | undefined;
|
|
2316
|
-
/**
|
|
2317
|
-
* <p>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code>
|
|
2318
|
-
* is the number of targets that are allowed to run this task, in parallel.</p>
|
|
2319
|
-
* <note>
|
|
2320
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
2321
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
2322
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
2323
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
2324
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
2325
|
-
* affect the running of your task.</p>
|
|
2326
|
-
* </note>
|
|
2327
|
-
* @public
|
|
2328
|
-
*/
|
|
2329
|
-
MaxConcurrency?: string | undefined;
|
|
2330
|
-
/**
|
|
2331
|
-
* <p>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum
|
|
2332
|
-
* number of errors that are allowed before the task stops being scheduled.</p>
|
|
2333
|
-
* <note>
|
|
2334
|
-
* <p>Although this element is listed as "Required: No", a value can be omitted only when you are
|
|
2335
|
-
* registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless
|
|
2336
|
-
* task</a> You must provide a value in all other cases.</p>
|
|
2337
|
-
* <p>For maintenance window tasks without a target specified, you can't supply a value for this
|
|
2338
|
-
* option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't
|
|
2339
|
-
* affect the running of your task.</p>
|
|
2340
|
-
* </note>
|
|
2341
|
-
* @public
|
|
2342
|
-
*/
|
|
2343
|
-
MaxErrors?: string | undefined;
|
|
2344
|
-
/**
|
|
2345
|
-
* <p>The new logging location in Amazon S3 to specify.</p>
|
|
2346
|
-
* <note>
|
|
2347
|
-
* <p>
|
|
2348
|
-
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
|
|
2349
|
-
* <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure.
|
|
2350
|
-
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
|
|
2351
|
-
* window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
2352
|
-
* </note>
|
|
2353
|
-
* @public
|
|
2354
|
-
*/
|
|
2355
|
-
LoggingInfo?: LoggingInfo | undefined;
|
|
2356
|
-
/**
|
|
2357
|
-
* <p>The new task name to specify.</p>
|
|
2358
|
-
* @public
|
|
2359
|
-
*/
|
|
2360
|
-
Name?: string | undefined;
|
|
2361
|
-
/**
|
|
2362
|
-
* <p>The new task description to specify.</p>
|
|
2363
|
-
* @public
|
|
2364
|
-
*/
|
|
2365
|
-
Description?: string | undefined;
|
|
2366
|
-
/**
|
|
2367
|
-
* <p>If True, then all fields that are required by the <a>RegisterTaskWithMaintenanceWindow</a> operation are also required for this API request.
|
|
2368
|
-
* Optional fields that aren't specified are set to null.</p>
|
|
2369
|
-
* @public
|
|
2370
|
-
*/
|
|
2371
|
-
Replace?: boolean | undefined;
|
|
2372
|
-
/**
|
|
2373
|
-
* <p>Indicates whether tasks should continue to run after the cutoff time specified in the
|
|
2374
|
-
* maintenance windows is reached. </p>
|
|
2375
|
-
* <ul>
|
|
2376
|
-
* <li>
|
|
2377
|
-
* <p>
|
|
2378
|
-
* <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running
|
|
2379
|
-
* continue. The default value.</p>
|
|
2380
|
-
* </li>
|
|
2381
|
-
* <li>
|
|
2382
|
-
* <p>
|
|
2383
|
-
* <code>CANCEL_TASK</code>:</p>
|
|
2384
|
-
* <ul>
|
|
2385
|
-
* <li>
|
|
2386
|
-
* <p>For Automation, Lambda, Step Functions tasks: When the cutoff
|
|
2387
|
-
* time is reached, any task invocations that are already running continue, but no new task
|
|
2388
|
-
* invocations are started.</p>
|
|
2389
|
-
* </li>
|
|
2390
|
-
* <li>
|
|
2391
|
-
* <p>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the
|
|
2392
|
-
* task. However, there is no guarantee that the command will be terminated and the underlying
|
|
2393
|
-
* process stopped.</p>
|
|
2394
|
-
* </li>
|
|
2395
|
-
* </ul>
|
|
2396
|
-
* <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p>
|
|
2397
|
-
* </li>
|
|
2398
|
-
* </ul>
|
|
2399
|
-
* @public
|
|
2400
|
-
*/
|
|
2401
|
-
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | undefined;
|
|
2402
|
-
/**
|
|
2403
|
-
* <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
|
|
2404
|
-
* @public
|
|
2405
|
-
*/
|
|
2406
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
2407
|
-
}
|
|
2408
|
-
/**
|
|
2409
|
-
* @public
|
|
2410
|
-
*/
|
|
2411
|
-
export interface UpdateMaintenanceWindowTaskResult {
|
|
2412
|
-
/**
|
|
2413
|
-
* <p>The ID of the maintenance window that was updated.</p>
|
|
2414
|
-
* @public
|
|
2415
|
-
*/
|
|
2416
|
-
WindowId?: string | undefined;
|
|
2417
|
-
/**
|
|
2418
|
-
* <p>The task ID of the maintenance window that was updated.</p>
|
|
2419
|
-
* @public
|
|
2420
|
-
*/
|
|
2421
|
-
WindowTaskId?: string | undefined;
|
|
2422
|
-
/**
|
|
2423
|
-
* <p>The updated target values.</p>
|
|
2424
|
-
* @public
|
|
2425
|
-
*/
|
|
2426
|
-
Targets?: Target[] | undefined;
|
|
2427
|
-
/**
|
|
2428
|
-
* <p>The updated task ARN value.</p>
|
|
2429
|
-
* @public
|
|
2430
|
-
*/
|
|
2431
|
-
TaskArn?: string | undefined;
|
|
2432
|
-
/**
|
|
2433
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role for
|
|
2434
|
-
* Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a
|
|
2435
|
-
* service role ARN, Systems Manager uses a service-linked role in your account. If no
|
|
2436
|
-
* appropriate service-linked role for Systems Manager exists in your account, it is created when
|
|
2437
|
-
* you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
|
|
2438
|
-
* <p>However, for an improved security posture, we strongly recommend creating a custom
|
|
2439
|
-
* policy and custom service role for running your maintenance window tasks. The policy
|
|
2440
|
-
* can be crafted to provide only the permissions needed for your particular
|
|
2441
|
-
* maintenance window tasks. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html">Setting up Maintenance Windows</a> in the in the
|
|
2442
|
-
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2443
|
-
* @public
|
|
2444
|
-
*/
|
|
2445
|
-
ServiceRoleArn?: string | undefined;
|
|
2446
|
-
/**
|
|
2447
|
-
* <p>The updated parameter values.</p>
|
|
2448
|
-
* <note>
|
|
2449
|
-
* <p>
|
|
2450
|
-
* <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs,
|
|
2451
|
-
* instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information
|
|
2452
|
-
* about how Systems Manager handles these options for the supported maintenance window task
|
|
2453
|
-
* types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
2454
|
-
* </note>
|
|
2455
|
-
* @public
|
|
2456
|
-
*/
|
|
2457
|
-
TaskParameters?: Record<string, MaintenanceWindowTaskParameterValueExpression> | undefined;
|
|
2458
|
-
/**
|
|
2459
|
-
* <p>The updated parameter values.</p>
|
|
2460
|
-
* @public
|
|
2461
|
-
*/
|
|
2462
|
-
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | undefined;
|
|
2463
|
-
/**
|
|
2464
|
-
* <p>The updated priority value.</p>
|
|
2465
|
-
* @public
|
|
2466
|
-
*/
|
|
2467
|
-
Priority?: number | undefined;
|
|
2468
|
-
/**
|
|
2469
|
-
* <p>The updated <code>MaxConcurrency</code> value.</p>
|
|
2470
|
-
* @public
|
|
2471
|
-
*/
|
|
2472
|
-
MaxConcurrency?: string | undefined;
|
|
2473
|
-
/**
|
|
2474
|
-
* <p>The updated <code>MaxErrors</code> value.</p>
|
|
2475
|
-
* @public
|
|
2476
|
-
*/
|
|
2477
|
-
MaxErrors?: string | undefined;
|
|
2478
|
-
/**
|
|
2479
|
-
* <p>The updated logging information in Amazon S3.</p>
|
|
2480
|
-
* <note>
|
|
2481
|
-
* <p>
|
|
2482
|
-
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
|
|
2483
|
-
* <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure.
|
|
2484
|
-
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
|
|
2485
|
-
* window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p>
|
|
2486
|
-
* </note>
|
|
2487
|
-
* @public
|
|
2488
|
-
*/
|
|
2489
|
-
LoggingInfo?: LoggingInfo | undefined;
|
|
2490
|
-
/**
|
|
2491
|
-
* <p>The updated task name.</p>
|
|
2492
|
-
* @public
|
|
2493
|
-
*/
|
|
2494
|
-
Name?: string | undefined;
|
|
2495
|
-
/**
|
|
2496
|
-
* <p>The updated task description.</p>
|
|
2497
|
-
* @public
|
|
2498
|
-
*/
|
|
2499
|
-
Description?: string | undefined;
|
|
2500
|
-
/**
|
|
2501
|
-
* <p>The specification for whether tasks should continue to run after the cutoff time specified
|
|
2502
|
-
* in the maintenance windows is reached. </p>
|
|
2503
|
-
* @public
|
|
2504
|
-
*/
|
|
2505
|
-
CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | undefined;
|
|
2506
|
-
/**
|
|
2507
|
-
* <p>The details for the CloudWatch alarm you applied to your maintenance window
|
|
2508
|
-
* task.</p>
|
|
2509
|
-
* @public
|
|
2510
|
-
*/
|
|
2511
|
-
AlarmConfiguration?: AlarmConfiguration | undefined;
|
|
2512
|
-
}
|
|
2513
|
-
/**
|
|
2514
|
-
* @public
|
|
2515
|
-
*/
|
|
2516
|
-
export interface UpdateManagedInstanceRoleRequest {
|
|
2517
|
-
/**
|
|
2518
|
-
* <p>The ID of the managed node where you want to update the role.</p>
|
|
2519
|
-
* @public
|
|
2520
|
-
*/
|
|
2521
|
-
InstanceId: string | undefined;
|
|
2522
|
-
/**
|
|
2523
|
-
* <p>The name of the Identity and Access Management (IAM) role that you want to assign to
|
|
2524
|
-
* the managed node. This IAM role must provide AssumeRole permissions for the
|
|
2525
|
-
* Amazon Web Services Systems Manager service principal <code>ssm.amazonaws.com</code>. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-service-role.html">Create the IAM service role required for Systems Manager in hybrid and multicloud
|
|
2526
|
-
* environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2527
|
-
* <note>
|
|
2528
|
-
* <p>You can't specify an IAM service-linked role for this parameter. You must
|
|
2529
|
-
* create a unique role.</p>
|
|
2530
|
-
* </note>
|
|
2531
|
-
* @public
|
|
2532
|
-
*/
|
|
2533
|
-
IamRole: string | undefined;
|
|
2534
|
-
}
|
|
2535
|
-
/**
|
|
2536
|
-
* @public
|
|
2537
|
-
*/
|
|
2538
|
-
export interface UpdateManagedInstanceRoleResult {
|
|
2539
|
-
}
|
|
2540
|
-
/**
|
|
2541
|
-
* @public
|
|
2542
|
-
*/
|
|
2543
|
-
export interface UpdateOpsItemRequest {
|
|
2544
|
-
/**
|
|
2545
|
-
* <p>User-defined text that contains information about the OpsItem, in Markdown format. </p>
|
|
2546
|
-
* @public
|
|
2547
|
-
*/
|
|
2548
|
-
Description?: string | undefined;
|
|
2549
|
-
/**
|
|
2550
|
-
* <p>Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem
|
|
2551
|
-
* object.</p>
|
|
2552
|
-
* <p>Operational data is custom data that provides useful reference details about the OpsItem.
|
|
2553
|
-
* For example, you can specify log files, error strings, license keys, troubleshooting tips, or
|
|
2554
|
-
* other relevant data. You enter operational data as key-value pairs. The key has a maximum length
|
|
2555
|
-
* of 128 characters. The value has a maximum size of 20 KB.</p>
|
|
2556
|
-
* <important>
|
|
2557
|
-
* <p>Operational data keys <i>can't</i> begin with the following:
|
|
2558
|
-
* <code>amazon</code>, <code>aws</code>, <code>amzn</code>, <code>ssm</code>,
|
|
2559
|
-
* <code>/amazon</code>, <code>/aws</code>, <code>/amzn</code>, <code>/ssm</code>.</p>
|
|
2560
|
-
* </important>
|
|
2561
|
-
* <p>You can choose to make the data searchable by other users in the account or you can restrict
|
|
2562
|
-
* search access. Searchable data means that all users with access to the OpsItem Overview page (as
|
|
2563
|
-
* provided by the <a>DescribeOpsItems</a> API operation) can view and search on the
|
|
2564
|
-
* specified data. Operational data that isn't searchable is only viewable by users who have access
|
|
2565
|
-
* to the OpsItem (as provided by the <a>GetOpsItem</a> API operation).</p>
|
|
2566
|
-
* <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in
|
|
2567
|
-
* the request. Use the <code>/aws/automations</code> key in OperationalData to associate an
|
|
2568
|
-
* Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see
|
|
2569
|
-
* <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html">Creating OpsItems
|
|
2570
|
-
* manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2571
|
-
* @public
|
|
2572
|
-
*/
|
|
2573
|
-
OperationalData?: Record<string, OpsItemDataValue> | undefined;
|
|
2574
|
-
/**
|
|
2575
|
-
* <p>Keys that you want to remove from the OperationalData map.</p>
|
|
2576
|
-
* @public
|
|
2577
|
-
*/
|
|
2578
|
-
OperationalDataToDelete?: string[] | undefined;
|
|
2579
|
-
/**
|
|
2580
|
-
* <p>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this
|
|
2581
|
-
* OpsItem is edited or changed.</p>
|
|
2582
|
-
* @public
|
|
2583
|
-
*/
|
|
2584
|
-
Notifications?: OpsItemNotification[] | undefined;
|
|
2585
|
-
/**
|
|
2586
|
-
* <p>The importance of this OpsItem in relation to other OpsItems in the system.</p>
|
|
2587
|
-
* @public
|
|
2588
|
-
*/
|
|
2589
|
-
Priority?: number | undefined;
|
|
2590
|
-
/**
|
|
2591
|
-
* <p>One or more OpsItems that share something in common with the current OpsItems. For example,
|
|
2592
|
-
* related OpsItems can include OpsItems with similar error messages, impacted resources, or
|
|
2593
|
-
* statuses for the impacted resource.</p>
|
|
2594
|
-
* @public
|
|
2595
|
-
*/
|
|
2596
|
-
RelatedOpsItems?: RelatedOpsItem[] | undefined;
|
|
2597
|
-
/**
|
|
2598
|
-
* <p>The OpsItem status. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2599
|
-
* @public
|
|
2600
|
-
*/
|
|
2601
|
-
Status?: OpsItemStatus | undefined;
|
|
2602
|
-
/**
|
|
2603
|
-
* <p>The ID of the OpsItem.</p>
|
|
2604
|
-
* @public
|
|
2605
|
-
*/
|
|
2606
|
-
OpsItemId: string | undefined;
|
|
2607
|
-
/**
|
|
2608
|
-
* <p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>
|
|
2609
|
-
* @public
|
|
2610
|
-
*/
|
|
2611
|
-
Title?: string | undefined;
|
|
2612
|
-
/**
|
|
2613
|
-
* <p>Specify a new category for an OpsItem.</p>
|
|
2614
|
-
* @public
|
|
2615
|
-
*/
|
|
2616
|
-
Category?: string | undefined;
|
|
2617
|
-
/**
|
|
2618
|
-
* <p>Specify a new severity for an OpsItem.</p>
|
|
2619
|
-
* @public
|
|
2620
|
-
*/
|
|
2621
|
-
Severity?: string | undefined;
|
|
2622
|
-
/**
|
|
2623
|
-
* <p>The time a runbook workflow started. Currently reported only for the OpsItem type
|
|
2624
|
-
* <code>/aws/changerequest</code>.</p>
|
|
2625
|
-
* @public
|
|
2626
|
-
*/
|
|
2627
|
-
ActualStartTime?: Date | undefined;
|
|
2628
|
-
/**
|
|
2629
|
-
* <p>The time a runbook workflow ended. Currently reported only for the OpsItem type
|
|
2630
|
-
* <code>/aws/changerequest</code>.</p>
|
|
2631
|
-
* @public
|
|
2632
|
-
*/
|
|
2633
|
-
ActualEndTime?: Date | undefined;
|
|
2634
|
-
/**
|
|
2635
|
-
* <p>The time specified in a change request for a runbook workflow to start. Currently supported
|
|
2636
|
-
* only for the OpsItem type <code>/aws/changerequest</code>.</p>
|
|
2637
|
-
* @public
|
|
2638
|
-
*/
|
|
2639
|
-
PlannedStartTime?: Date | undefined;
|
|
2640
|
-
/**
|
|
2641
|
-
* <p>The time specified in a change request for a runbook workflow to end. Currently supported
|
|
2642
|
-
* only for the OpsItem type <code>/aws/changerequest</code>.</p>
|
|
2643
|
-
* @public
|
|
2644
|
-
*/
|
|
2645
|
-
PlannedEndTime?: Date | undefined;
|
|
2646
|
-
/**
|
|
2647
|
-
* <p>The OpsItem Amazon Resource Name (ARN).</p>
|
|
2648
|
-
* @public
|
|
2649
|
-
*/
|
|
2650
|
-
OpsItemArn?: string | undefined;
|
|
2651
|
-
}
|
|
2652
|
-
/**
|
|
2653
|
-
* @public
|
|
2654
|
-
*/
|
|
2655
|
-
export interface UpdateOpsItemResponse {
|
|
2656
|
-
}
|
|
2657
|
-
/**
|
|
2658
|
-
* <p>The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to
|
|
2659
|
-
* an application in Application Manager.</p>
|
|
2660
|
-
* @public
|
|
2661
|
-
*/
|
|
2662
|
-
export declare class OpsMetadataKeyLimitExceededException extends __BaseException {
|
|
2663
|
-
readonly name: "OpsMetadataKeyLimitExceededException";
|
|
2664
|
-
readonly $fault: "client";
|
|
2665
|
-
/**
|
|
2666
|
-
* @internal
|
|
2667
|
-
*/
|
|
2668
|
-
constructor(opts: __ExceptionOptionType<OpsMetadataKeyLimitExceededException, __BaseException>);
|
|
2669
|
-
}
|
|
2670
|
-
/**
|
|
2671
|
-
* @public
|
|
2672
|
-
*/
|
|
2673
|
-
export interface UpdateOpsMetadataRequest {
|
|
2674
|
-
/**
|
|
2675
|
-
* <p>The Amazon Resource Name (ARN) of the OpsMetadata Object to update.</p>
|
|
2676
|
-
* @public
|
|
2677
|
-
*/
|
|
2678
|
-
OpsMetadataArn: string | undefined;
|
|
2679
|
-
/**
|
|
2680
|
-
* <p>Metadata to add to an OpsMetadata object.</p>
|
|
2681
|
-
* @public
|
|
2682
|
-
*/
|
|
2683
|
-
MetadataToUpdate?: Record<string, MetadataValue> | undefined;
|
|
2684
|
-
/**
|
|
2685
|
-
* <p>The metadata keys to delete from the OpsMetadata object. </p>
|
|
2686
|
-
* @public
|
|
2687
|
-
*/
|
|
2688
|
-
KeysToDelete?: string[] | undefined;
|
|
2689
|
-
}
|
|
2690
|
-
/**
|
|
2691
|
-
* @public
|
|
2692
|
-
*/
|
|
2693
|
-
export interface UpdateOpsMetadataResult {
|
|
2694
|
-
/**
|
|
2695
|
-
* <p>The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.</p>
|
|
2696
|
-
* @public
|
|
2697
|
-
*/
|
|
2698
|
-
OpsMetadataArn?: string | undefined;
|
|
2699
|
-
}
|
|
2700
|
-
/**
|
|
2701
|
-
* @public
|
|
2702
|
-
*/
|
|
2703
|
-
export interface UpdatePatchBaselineRequest {
|
|
2704
|
-
/**
|
|
2705
|
-
* <p>The ID of the patch baseline to update.</p>
|
|
2706
|
-
* @public
|
|
2707
|
-
*/
|
|
2708
|
-
BaselineId: string | undefined;
|
|
2709
|
-
/**
|
|
2710
|
-
* <p>The name of the patch baseline.</p>
|
|
2711
|
-
* @public
|
|
2712
|
-
*/
|
|
2713
|
-
Name?: string | undefined;
|
|
2714
|
-
/**
|
|
2715
|
-
* <p>A set of global filters used to include patches in the baseline.</p>
|
|
2716
|
-
* <important>
|
|
2717
|
-
* <p>The <code>GlobalFilters</code> parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager
|
|
2718
|
-
* console, and its value isn't displayed in the console.</p>
|
|
2719
|
-
* </important>
|
|
2720
|
-
* @public
|
|
2721
|
-
*/
|
|
2722
|
-
GlobalFilters?: PatchFilterGroup | undefined;
|
|
2723
|
-
/**
|
|
2724
|
-
* <p>A set of rules used to include patches in the baseline.</p>
|
|
2725
|
-
* @public
|
|
2726
|
-
*/
|
|
2727
|
-
ApprovalRules?: PatchRuleGroup | undefined;
|
|
2728
|
-
/**
|
|
2729
|
-
* <p>A list of explicitly approved patches for the baseline.</p>
|
|
2730
|
-
* <p>For information about accepted formats for lists of approved patches and rejected patches,
|
|
2731
|
-
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">Package
|
|
2732
|
-
* name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2733
|
-
* @public
|
|
2734
|
-
*/
|
|
2735
|
-
ApprovedPatches?: string[] | undefined;
|
|
2736
|
-
/**
|
|
2737
|
-
* <p>Assigns a new compliance severity level to an existing patch baseline.</p>
|
|
2738
|
-
* @public
|
|
2739
|
-
*/
|
|
2740
|
-
ApprovedPatchesComplianceLevel?: PatchComplianceLevel | undefined;
|
|
2741
|
-
/**
|
|
2742
|
-
* <p>Indicates whether the list of approved patches includes non-security updates that should be
|
|
2743
|
-
* applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed
|
|
2744
|
-
* nodes only.</p>
|
|
2745
|
-
* @public
|
|
2746
|
-
*/
|
|
2747
|
-
ApprovedPatchesEnableNonSecurity?: boolean | undefined;
|
|
2748
|
-
/**
|
|
2749
|
-
* <p>A list of explicitly rejected patches for the baseline.</p>
|
|
2750
|
-
* <p>For information about accepted formats for lists of approved patches and rejected patches,
|
|
2751
|
-
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">Package
|
|
2752
|
-
* name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
2753
|
-
* @public
|
|
2754
|
-
*/
|
|
2755
|
-
RejectedPatches?: string[] | undefined;
|
|
2756
|
-
/**
|
|
2757
|
-
* <p>The action for Patch Manager to take on patches included in the
|
|
2758
|
-
* <code>RejectedPackages</code> list.</p>
|
|
2759
|
-
* <dl>
|
|
2760
|
-
* <dt>ALLOW_AS_DEPENDENCY</dt>
|
|
2761
|
-
* <dd>
|
|
2762
|
-
* <p>
|
|
2763
|
-
* <b>Linux and macOS</b>: A package in the rejected patches list
|
|
2764
|
-
* is installed only if it is a dependency of another package. It is considered compliant with
|
|
2765
|
-
* the patch baseline, and its status is reported as <code>INSTALLED_OTHER</code>. This is the
|
|
2766
|
-
* default action if no option is specified.</p>
|
|
2767
|
-
* <p>
|
|
2768
|
-
* <b>Windows Server</b>: Windows Server doesn't support the
|
|
2769
|
-
* concept of package dependencies. If a package in the rejected patches list and already
|
|
2770
|
-
* installed on the node, its status is reported as <code>INSTALLED_OTHER</code>. Any package not
|
|
2771
|
-
* already installed on the node is skipped. This is the default action if no option is
|
|
2772
|
-
* specified.</p>
|
|
2773
|
-
* </dd>
|
|
2774
|
-
* <dt>BLOCK</dt>
|
|
2775
|
-
* <dd>
|
|
2776
|
-
* <p>
|
|
2777
|
-
* <b>All OSs</b>: Packages in the rejected patches list, and
|
|
2778
|
-
* packages that include them as dependencies, aren't installed by Patch Manager under any
|
|
2779
|
-
* circumstances. </p>
|
|
2780
|
-
* <p>State value assignment for patch compliance:</p>
|
|
2781
|
-
* <ul>
|
|
2782
|
-
* <li>
|
|
2783
|
-
* <p>If a package was installed before it was added to the rejected patches list, or is
|
|
2784
|
-
* installed outside of Patch Manager afterward, it's considered noncompliant with the patch
|
|
2785
|
-
* baseline and its status is reported as <code>INSTALLED_REJECTED</code>.</p>
|
|
2786
|
-
* </li>
|
|
2787
|
-
* <li>
|
|
2788
|
-
* <p>If an update attempts to install a dependency package that is now rejected by the
|
|
2789
|
-
* baseline, when previous versions of the package were not rejected, the package being updated
|
|
2790
|
-
* is reported as <code>MISSING</code> for <code>SCAN</code> operations and as
|
|
2791
|
-
* <code>FAILED</code> for <code>INSTALL</code> operations.</p>
|
|
2792
|
-
* </li>
|
|
2793
|
-
* </ul>
|
|
2794
|
-
* </dd>
|
|
2795
|
-
* </dl>
|
|
2796
|
-
* @public
|
|
2797
|
-
*/
|
|
2798
|
-
RejectedPatchesAction?: PatchAction | undefined;
|
|
2799
|
-
/**
|
|
2800
|
-
* <p>A description of the patch baseline.</p>
|
|
2801
|
-
* @public
|
|
2802
|
-
*/
|
|
2803
|
-
Description?: string | undefined;
|
|
2804
|
-
/**
|
|
2805
|
-
* <p>Information about the patches to use to update the managed nodes, including target operating
|
|
2806
|
-
* systems and source repositories. Applies to Linux managed nodes only.</p>
|
|
2807
|
-
* @public
|
|
2808
|
-
*/
|
|
2809
|
-
Sources?: PatchSource[] | undefined;
|
|
2810
|
-
/**
|
|
2811
|
-
* <p>Indicates the status to be assigned to security patches that are available but not approved
|
|
2812
|
-
* because they don't meet the installation criteria specified in the patch baseline.</p>
|
|
2813
|
-
* <p>Example scenario: Security patches that you might want installed can be skipped if you have
|
|
2814
|
-
* specified a long period to wait after a patch is released before installation. If an update to
|
|
2815
|
-
* the patch is released during your specified waiting period, the waiting period for installing the
|
|
2816
|
-
* patch starts over. If the waiting period is too long, multiple versions of the patch could be
|
|
2817
|
-
* released but never installed.</p>
|
|
2818
|
-
* <p>Supported for Windows Server managed nodes only.</p>
|
|
2819
|
-
* @public
|
|
2820
|
-
*/
|
|
2821
|
-
AvailableSecurityUpdatesComplianceStatus?: PatchComplianceStatus | undefined;
|
|
2822
|
-
/**
|
|
2823
|
-
* <p>If True, then all fields that are required by the <a>CreatePatchBaseline</a>
|
|
2824
|
-
* operation are also required for this API request. Optional fields that aren't specified are set
|
|
2825
|
-
* to null.</p>
|
|
2826
|
-
* @public
|
|
2827
|
-
*/
|
|
2828
|
-
Replace?: boolean | undefined;
|
|
2829
|
-
}
|
|
2830
|
-
/**
|
|
2831
|
-
* @public
|
|
2832
|
-
*/
|
|
2833
|
-
export interface UpdatePatchBaselineResult {
|
|
2834
|
-
/**
|
|
2835
|
-
* <p>The ID of the deleted patch baseline.</p>
|
|
2836
|
-
* @public
|
|
2837
|
-
*/
|
|
2838
|
-
BaselineId?: string | undefined;
|
|
2839
|
-
/**
|
|
2840
|
-
* <p>The name of the patch baseline.</p>
|
|
2841
|
-
* @public
|
|
2842
|
-
*/
|
|
2843
|
-
Name?: string | undefined;
|
|
2844
|
-
/**
|
|
2845
|
-
* <p>The operating system rule used by the updated patch baseline.</p>
|
|
2846
|
-
* @public
|
|
2847
|
-
*/
|
|
2848
|
-
OperatingSystem?: OperatingSystem | undefined;
|
|
2849
|
-
/**
|
|
2850
|
-
* <p>A set of global filters used to exclude patches from the baseline.</p>
|
|
2851
|
-
* @public
|
|
2852
|
-
*/
|
|
2853
|
-
GlobalFilters?: PatchFilterGroup | undefined;
|
|
2854
|
-
/**
|
|
2855
|
-
* <p>A set of rules used to include patches in the baseline.</p>
|
|
2856
|
-
* @public
|
|
2857
|
-
*/
|
|
2858
|
-
ApprovalRules?: PatchRuleGroup | undefined;
|
|
2859
|
-
/**
|
|
2860
|
-
* <p>A list of explicitly approved patches for the baseline.</p>
|
|
2861
|
-
* @public
|
|
2862
|
-
*/
|
|
2863
|
-
ApprovedPatches?: string[] | undefined;
|
|
2864
|
-
/**
|
|
2865
|
-
* <p>The compliance severity level assigned to the patch baseline after the update
|
|
2866
|
-
* completed.</p>
|
|
2867
|
-
* @public
|
|
2868
|
-
*/
|
|
2869
|
-
ApprovedPatchesComplianceLevel?: PatchComplianceLevel | undefined;
|
|
2870
|
-
/**
|
|
2871
|
-
* <p>Indicates whether the list of approved patches includes non-security updates that should be
|
|
2872
|
-
* applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed
|
|
2873
|
-
* nodes only.</p>
|
|
2874
|
-
* @public
|
|
2875
|
-
*/
|
|
2876
|
-
ApprovedPatchesEnableNonSecurity?: boolean | undefined;
|
|
2877
|
-
/**
|
|
2878
|
-
* <p>A list of explicitly rejected patches for the baseline.</p>
|
|
2879
|
-
* @public
|
|
2880
|
-
*/
|
|
2881
|
-
RejectedPatches?: string[] | undefined;
|
|
2882
|
-
/**
|
|
2883
|
-
* <p>The action specified to take on patches included in the <code>RejectedPatches</code> list. A
|
|
2884
|
-
* patch can be allowed only if it is a dependency of another package, or blocked entirely along
|
|
2885
|
-
* with packages that include it as a dependency.</p>
|
|
2886
|
-
* @public
|
|
2887
|
-
*/
|
|
2888
|
-
RejectedPatchesAction?: PatchAction | undefined;
|
|
2889
|
-
/**
|
|
2890
|
-
* <p>The date when the patch baseline was created.</p>
|
|
2891
|
-
* @public
|
|
2892
|
-
*/
|
|
2893
|
-
CreatedDate?: Date | undefined;
|
|
2894
|
-
/**
|
|
2895
|
-
* <p>The date when the patch baseline was last modified.</p>
|
|
2896
|
-
* @public
|
|
2897
|
-
*/
|
|
2898
|
-
ModifiedDate?: Date | undefined;
|
|
2899
|
-
/**
|
|
2900
|
-
* <p>A description of the patch baseline.</p>
|
|
2901
|
-
* @public
|
|
2902
|
-
*/
|
|
2903
|
-
Description?: string | undefined;
|
|
2904
|
-
/**
|
|
2905
|
-
* <p>Information about the patches to use to update the managed nodes, including target operating
|
|
2906
|
-
* systems and source repositories. Applies to Linux managed nodes only.</p>
|
|
2907
|
-
* @public
|
|
2908
|
-
*/
|
|
2909
|
-
Sources?: PatchSource[] | undefined;
|
|
2910
|
-
/**
|
|
2911
|
-
* <p>Indicates the compliance status of managed nodes for which security-related patches are
|
|
2912
|
-
* available but were not approved. This preference is specified when the
|
|
2913
|
-
* <code>CreatePatchBaseline</code> or <code>UpdatePatchBaseline</code> commands are run.</p>
|
|
2914
|
-
* <p>Applies to Windows Server managed nodes only.</p>
|
|
2915
|
-
* @public
|
|
2916
|
-
*/
|
|
2917
|
-
AvailableSecurityUpdatesComplianceStatus?: PatchComplianceStatus | undefined;
|
|
2918
|
-
}
|
|
2919
|
-
/**
|
|
2920
|
-
* <p>Another <code>UpdateResourceDataSync</code> request is being processed. Wait a few minutes
|
|
2921
|
-
* and try again.</p>
|
|
2922
|
-
* @public
|
|
2923
|
-
*/
|
|
2924
|
-
export declare class ResourceDataSyncConflictException extends __BaseException {
|
|
2925
|
-
readonly name: "ResourceDataSyncConflictException";
|
|
2926
|
-
readonly $fault: "client";
|
|
2927
|
-
Message?: string | undefined;
|
|
2928
|
-
/**
|
|
2929
|
-
* @internal
|
|
2930
|
-
*/
|
|
2931
|
-
constructor(opts: __ExceptionOptionType<ResourceDataSyncConflictException, __BaseException>);
|
|
2932
|
-
}
|
|
2933
|
-
/**
|
|
2934
|
-
* @public
|
|
2935
|
-
*/
|
|
2936
|
-
export interface UpdateResourceDataSyncRequest {
|
|
2937
|
-
/**
|
|
2938
|
-
* <p>The name of the resource data sync you want to update.</p>
|
|
2939
|
-
* @public
|
|
2940
|
-
*/
|
|
2941
|
-
SyncName: string | undefined;
|
|
2942
|
-
/**
|
|
2943
|
-
* <p>The type of resource data sync. The supported <code>SyncType</code> is
|
|
2944
|
-
* SyncFromSource.</p>
|
|
2945
|
-
* @public
|
|
2946
|
-
*/
|
|
2947
|
-
SyncType: string | undefined;
|
|
2948
|
-
/**
|
|
2949
|
-
* <p>Specify information about the data sources to synchronize.</p>
|
|
2950
|
-
* @public
|
|
2951
|
-
*/
|
|
2952
|
-
SyncSource: ResourceDataSyncSource | undefined;
|
|
2953
|
-
}
|
|
2954
|
-
/**
|
|
2955
|
-
* @public
|
|
2956
|
-
*/
|
|
2957
|
-
export interface UpdateResourceDataSyncResult {
|
|
2958
|
-
}
|
|
2959
|
-
/**
|
|
2960
|
-
* <p>The request body of the UpdateServiceSetting API operation.</p>
|
|
2961
|
-
* @public
|
|
2962
|
-
*/
|
|
2963
|
-
export interface UpdateServiceSettingRequest {
|
|
2964
|
-
/**
|
|
2965
|
-
* <p>The Amazon Resource Name (ARN) of the service setting to update. For example,
|
|
2966
|
-
* <code>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</code>.
|
|
2967
|
-
* The setting ID can be one of the following.</p>
|
|
2968
|
-
* <ul>
|
|
2969
|
-
* <li>
|
|
2970
|
-
* <p>
|
|
2971
|
-
* <code>/ssm/appmanager/appmanager-enabled</code>
|
|
2972
|
-
* </p>
|
|
2973
|
-
* </li>
|
|
2974
|
-
* <li>
|
|
2975
|
-
* <p>
|
|
2976
|
-
* <code>/ssm/automation/customer-script-log-destination</code>
|
|
2977
|
-
* </p>
|
|
2978
|
-
* </li>
|
|
2979
|
-
* <li>
|
|
2980
|
-
* <p>
|
|
2981
|
-
* <code>/ssm/automation/customer-script-log-group-name</code>
|
|
2982
|
-
* </p>
|
|
2983
|
-
* </li>
|
|
2984
|
-
* <li>
|
|
2985
|
-
* <p>/ssm/automation/enable-adaptive-concurrency</p>
|
|
2986
|
-
* </li>
|
|
2987
|
-
* <li>
|
|
2988
|
-
* <p>
|
|
2989
|
-
* <code>/ssm/documents/console/public-sharing-permission</code>
|
|
2990
|
-
* </p>
|
|
2991
|
-
* </li>
|
|
2992
|
-
* <li>
|
|
2993
|
-
* <p>
|
|
2994
|
-
* <code>/ssm/managed-instance/activation-tier</code>
|
|
2995
|
-
* </p>
|
|
2996
|
-
* </li>
|
|
2997
|
-
* <li>
|
|
2998
|
-
* <p>
|
|
2999
|
-
* <code>/ssm/managed-instance/default-ec2-instance-management-role</code>
|
|
3000
|
-
* </p>
|
|
3001
|
-
* </li>
|
|
3002
|
-
* <li>
|
|
3003
|
-
* <p>
|
|
3004
|
-
* <code>/ssm/opsinsights/opscenter</code>
|
|
3005
|
-
* </p>
|
|
3006
|
-
* </li>
|
|
3007
|
-
* <li>
|
|
3008
|
-
* <p>
|
|
3009
|
-
* <code>/ssm/parameter-store/default-parameter-tier</code>
|
|
3010
|
-
* </p>
|
|
3011
|
-
* </li>
|
|
3012
|
-
* <li>
|
|
3013
|
-
* <p>
|
|
3014
|
-
* <code>/ssm/parameter-store/high-throughput-enabled</code>
|
|
3015
|
-
* </p>
|
|
3016
|
-
* </li>
|
|
3017
|
-
* </ul>
|
|
3018
|
-
* <note>
|
|
3019
|
-
* <p>Permissions to update the
|
|
3020
|
-
* <code>/ssm/managed-instance/default-ec2-instance-management-role</code> setting should only be
|
|
3021
|
-
* provided to administrators. Implement least privilege access when allowing individuals to
|
|
3022
|
-
* configure or modify the Default Host Management Configuration.</p>
|
|
3023
|
-
* </note>
|
|
3024
|
-
* @public
|
|
3025
|
-
*/
|
|
3026
|
-
SettingId: string | undefined;
|
|
3027
|
-
/**
|
|
3028
|
-
* <p>The new value to specify for the service setting. The following list specifies the available
|
|
3029
|
-
* values for each setting.</p>
|
|
3030
|
-
* <ul>
|
|
3031
|
-
* <li>
|
|
3032
|
-
* <p>For <code>/ssm/appmanager/appmanager-enabled</code>, enter <code>True</code> or
|
|
3033
|
-
* <code>False</code>.</p>
|
|
3034
|
-
* </li>
|
|
3035
|
-
* <li>
|
|
3036
|
-
* <p>For <code>/ssm/automation/customer-script-log-destination</code>, enter <code>CloudWatch</code>.</p>
|
|
3037
|
-
* </li>
|
|
3038
|
-
* <li>
|
|
3039
|
-
* <p>For <code>/ssm/automation/customer-script-log-group-name</code>, enter the name of an
|
|
3040
|
-
* Amazon CloudWatch Logs log group.</p>
|
|
3041
|
-
* </li>
|
|
3042
|
-
* <li>
|
|
3043
|
-
* <p>For <code>/ssm/documents/console/public-sharing-permission</code>, enter
|
|
3044
|
-
* <code>Enable</code> or <code>Disable</code>.</p>
|
|
3045
|
-
* </li>
|
|
3046
|
-
* <li>
|
|
3047
|
-
* <p>For <code>/ssm/managed-instance/activation-tier</code>, enter <code>standard</code> or
|
|
3048
|
-
* <code>advanced</code>.</p>
|
|
3049
|
-
* </li>
|
|
3050
|
-
* <li>
|
|
3051
|
-
* <p>For <code>/ssm/managed-instance/default-ec2-instance-management-role</code>, enter the
|
|
3052
|
-
* name of an IAM role. </p>
|
|
3053
|
-
* </li>
|
|
3054
|
-
* <li>
|
|
3055
|
-
* <p> For <code>/ssm/opsinsights/opscenter</code>, enter <code>Enabled</code> or
|
|
3056
|
-
* <code>Disabled</code>. </p>
|
|
3057
|
-
* </li>
|
|
3058
|
-
* <li>
|
|
3059
|
-
* <p>For <code>/ssm/parameter-store/default-parameter-tier</code>, enter <code>Standard</code>,
|
|
3060
|
-
* <code>Advanced</code>, or <code>Intelligent-Tiering</code>
|
|
3061
|
-
* </p>
|
|
3062
|
-
* </li>
|
|
3063
|
-
* <li>
|
|
3064
|
-
* <p>For <code>/ssm/parameter-store/high-throughput-enabled</code>, enter <code>true</code> or
|
|
3065
|
-
* <code>false</code>.</p>
|
|
3066
|
-
* </li>
|
|
3067
|
-
* </ul>
|
|
3068
|
-
* @public
|
|
3069
|
-
*/
|
|
3070
|
-
SettingValue: string | undefined;
|
|
3071
|
-
}
|
|
3072
|
-
/**
|
|
3073
|
-
* <p>The result body of the UpdateServiceSetting API operation.</p>
|
|
3074
|
-
* @public
|
|
3075
|
-
*/
|
|
3076
|
-
export interface UpdateServiceSettingResult {
|
|
3077
|
-
}
|
|
3078
|
-
/**
|
|
3079
|
-
* <p>Specifies the inventory type and attribute for the aggregation execution.</p>
|
|
3080
|
-
* @public
|
|
3081
|
-
*/
|
|
3082
|
-
export interface InventoryAggregator {
|
|
3083
|
-
/**
|
|
3084
|
-
* <p>The inventory type and attribute name for aggregation.</p>
|
|
3085
|
-
* @public
|
|
3086
|
-
*/
|
|
3087
|
-
Expression?: string | undefined;
|
|
3088
|
-
/**
|
|
3089
|
-
* <p>Nested aggregators to further refine aggregation for an inventory type.</p>
|
|
3090
|
-
* @public
|
|
3091
|
-
*/
|
|
3092
|
-
Aggregators?: InventoryAggregator[] | undefined;
|
|
3093
|
-
/**
|
|
3094
|
-
* <p>A user-defined set of one or more filters on which to aggregate inventory data. Groups
|
|
3095
|
-
* return a count of resources that match and don't match the specified criteria.</p>
|
|
3096
|
-
* @public
|
|
3097
|
-
*/
|
|
3098
|
-
Groups?: InventoryGroup[] | undefined;
|
|
3099
|
-
}
|
|
3100
|
-
/**
|
|
3101
|
-
* <p>One or more aggregators for viewing counts of nodes using different
|
|
3102
|
-
* dimensions.</p>
|
|
3103
|
-
* @public
|
|
3104
|
-
*/
|
|
3105
|
-
export interface NodeAggregator {
|
|
3106
|
-
/**
|
|
3107
|
-
* <p>The aggregator type for limiting a node summary. Currently, only <code>Count</code> is
|
|
3108
|
-
* supported.</p>
|
|
3109
|
-
* @public
|
|
3110
|
-
*/
|
|
3111
|
-
AggregatorType: NodeAggregatorType | undefined;
|
|
3112
|
-
/**
|
|
3113
|
-
* <p>The data type name to use for viewing counts of nodes. Currently, only <code>Instance</code>
|
|
3114
|
-
* is supported.</p>
|
|
3115
|
-
* @public
|
|
3116
|
-
*/
|
|
3117
|
-
TypeName: NodeTypeName | undefined;
|
|
3118
|
-
/**
|
|
3119
|
-
* <p>The name of a node attribute on which to limit the count of nodes.</p>
|
|
3120
|
-
* @public
|
|
3121
|
-
*/
|
|
3122
|
-
AttributeName: NodeAttributeName | undefined;
|
|
3123
|
-
/**
|
|
3124
|
-
* <p>Information about aggregators used to refine a node summary.</p>
|
|
3125
|
-
* @public
|
|
3126
|
-
*/
|
|
3127
|
-
Aggregators?: NodeAggregator[] | undefined;
|
|
3128
|
-
}
|
|
3129
|
-
/**
|
|
3130
|
-
* <p>One or more aggregators for viewing counts of OpsData using different dimensions such as
|
|
3131
|
-
* <code>Source</code>, <code>CreatedTime</code>, or <code>Source and CreatedTime</code>, to name a
|
|
3132
|
-
* few.</p>
|
|
3133
|
-
* @public
|
|
3134
|
-
*/
|
|
3135
|
-
export interface OpsAggregator {
|
|
3136
|
-
/**
|
|
3137
|
-
* <p>Either a <code>Range</code> or <code>Count</code> aggregator for limiting an OpsData
|
|
3138
|
-
* summary.</p>
|
|
3139
|
-
* @public
|
|
3140
|
-
*/
|
|
3141
|
-
AggregatorType?: string | undefined;
|
|
3142
|
-
/**
|
|
3143
|
-
* <p>The data type name to use for viewing counts of OpsData.</p>
|
|
3144
|
-
* @public
|
|
3145
|
-
*/
|
|
3146
|
-
TypeName?: string | undefined;
|
|
3147
|
-
/**
|
|
3148
|
-
* <p>The name of an OpsData attribute on which to limit the count of OpsData.</p>
|
|
3149
|
-
* @public
|
|
3150
|
-
*/
|
|
3151
|
-
AttributeName?: string | undefined;
|
|
3152
|
-
/**
|
|
3153
|
-
* <p>The aggregator value.</p>
|
|
3154
|
-
* @public
|
|
3155
|
-
*/
|
|
3156
|
-
Values?: Record<string, string> | undefined;
|
|
3157
|
-
/**
|
|
3158
|
-
* <p>The aggregator filters.</p>
|
|
3159
|
-
* @public
|
|
3160
|
-
*/
|
|
3161
|
-
Filters?: OpsFilter[] | undefined;
|
|
3162
|
-
/**
|
|
3163
|
-
* <p>A nested aggregator for viewing counts of OpsData.</p>
|
|
3164
|
-
* @public
|
|
3165
|
-
*/
|
|
3166
|
-
Aggregators?: OpsAggregator[] | undefined;
|
|
3167
|
-
}
|
|
3168
|
-
/**
|
|
3169
|
-
* @public
|
|
3170
|
-
*/
|
|
3171
|
-
export interface GetInventoryRequest {
|
|
3172
|
-
/**
|
|
3173
|
-
* <p>One or more filters. Use a filter to return a more specific list of results.</p>
|
|
3174
|
-
* @public
|
|
3175
|
-
*/
|
|
3176
|
-
Filters?: InventoryFilter[] | undefined;
|
|
3177
|
-
/**
|
|
3178
|
-
* <p>Returns counts of inventory types based on one or more expressions. For example, if you
|
|
3179
|
-
* aggregate by using an expression that uses the <code>AWS:InstanceInformation.PlatformType</code>
|
|
3180
|
-
* type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried
|
|
3181
|
-
* fleet.</p>
|
|
3182
|
-
* @public
|
|
3183
|
-
*/
|
|
3184
|
-
Aggregators?: InventoryAggregator[] | undefined;
|
|
3185
|
-
/**
|
|
3186
|
-
* <p>The list of inventory item types to return.</p>
|
|
3187
|
-
* @public
|
|
3188
|
-
*/
|
|
3189
|
-
ResultAttributes?: ResultAttribute[] | undefined;
|
|
3190
|
-
/**
|
|
3191
|
-
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
3192
|
-
* call.)</p>
|
|
3193
|
-
* @public
|
|
3194
|
-
*/
|
|
3195
|
-
NextToken?: string | undefined;
|
|
3196
|
-
/**
|
|
3197
|
-
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
3198
|
-
* can specify in a subsequent call to get the next set of results.</p>
|
|
3199
|
-
* @public
|
|
3200
|
-
*/
|
|
3201
|
-
MaxResults?: number | undefined;
|
|
3202
|
-
}
|
|
3203
|
-
/**
|
|
3204
|
-
* @public
|
|
3205
|
-
*/
|
|
3206
|
-
export interface GetOpsSummaryRequest {
|
|
3207
|
-
/**
|
|
3208
|
-
* <p>Specify the name of a resource data sync to get.</p>
|
|
3209
|
-
* @public
|
|
3210
|
-
*/
|
|
3211
|
-
SyncName?: string | undefined;
|
|
3212
|
-
/**
|
|
3213
|
-
* <p>Optional filters used to scope down the returned OpsData. </p>
|
|
3214
|
-
* @public
|
|
3215
|
-
*/
|
|
3216
|
-
Filters?: OpsFilter[] | undefined;
|
|
3217
|
-
/**
|
|
3218
|
-
* <p>Optional aggregators that return counts of OpsData based on one or more expressions.</p>
|
|
3219
|
-
* @public
|
|
3220
|
-
*/
|
|
3221
|
-
Aggregators?: OpsAggregator[] | undefined;
|
|
3222
|
-
/**
|
|
3223
|
-
* <p>The OpsData data type to return.</p>
|
|
3224
|
-
* @public
|
|
3225
|
-
*/
|
|
3226
|
-
ResultAttributes?: OpsResultAttribute[] | undefined;
|
|
3227
|
-
/**
|
|
3228
|
-
* <p>A token to start the list. Use this token to get the next set of results. </p>
|
|
3229
|
-
* @public
|
|
3230
|
-
*/
|
|
3231
|
-
NextToken?: string | undefined;
|
|
3232
|
-
/**
|
|
3233
|
-
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
3234
|
-
* can specify in a subsequent call to get the next set of results.</p>
|
|
3235
|
-
* @public
|
|
3236
|
-
*/
|
|
3237
|
-
MaxResults?: number | undefined;
|
|
3238
|
-
}
|
|
3239
|
-
/**
|
|
3240
|
-
* @public
|
|
3241
|
-
*/
|
|
3242
|
-
export interface ListNodesSummaryRequest {
|
|
3243
|
-
/**
|
|
3244
|
-
* <p>The name of the Amazon Web Services managed resource data sync to retrieve information about.</p>
|
|
3245
|
-
* <p>For cross-account/cross-Region configurations, this parameter is required, and the name of
|
|
3246
|
-
* the supported resource data sync is <code>AWS-QuickSetup-ManagedNode</code>.</p>
|
|
3247
|
-
* <p>For single account/single-Region configurations, the parameter is not required.</p>
|
|
3248
|
-
* @public
|
|
3249
|
-
*/
|
|
3250
|
-
SyncName?: string | undefined;
|
|
3251
|
-
/**
|
|
3252
|
-
* <p>One or more filters. Use a filter to generate a summary that matches your specified filter
|
|
3253
|
-
* criteria.</p>
|
|
3254
|
-
* @public
|
|
3255
|
-
*/
|
|
3256
|
-
Filters?: NodeFilter[] | undefined;
|
|
3257
|
-
/**
|
|
3258
|
-
* <p>Specify one or more aggregators to return a count of managed nodes that match that
|
|
3259
|
-
* expression. For example, a count of managed nodes by operating system.</p>
|
|
3260
|
-
* @public
|
|
3261
|
-
*/
|
|
3262
|
-
Aggregators: NodeAggregator[] | undefined;
|
|
3263
|
-
/**
|
|
3264
|
-
* <p>The token for the next set of items to return. (You received this token from a previous
|
|
3265
|
-
* call.) The call also returns a token that you can specify in a subsequent call to get the next
|
|
3266
|
-
* set of results.</p>
|
|
3267
|
-
* @public
|
|
3268
|
-
*/
|
|
3269
|
-
NextToken?: string | undefined;
|
|
3270
|
-
/**
|
|
3271
|
-
* <p>The maximum number of items to return for this call. The call also returns a token that you
|
|
3272
|
-
* can specify in a subsequent call to get the next set of results.</p>
|
|
3273
|
-
* @public
|
|
3274
|
-
*/
|
|
3275
|
-
MaxResults?: number | undefined;
|
|
3276
|
-
}
|