UNPKG

381 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class SSM extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: SSM.Types.ClientConfiguration)
13 config: Config & SSM.Types.ClientConfiguration;
14 /**
15 * Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 50 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
16 */
17 addTagsToResource(params: SSM.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: SSM.Types.AddTagsToResourceResult) => void): Request<SSM.Types.AddTagsToResourceResult, AWSError>;
18 /**
19 * Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 50 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
20 */
21 addTagsToResource(callback?: (err: AWSError, data: SSM.Types.AddTagsToResourceResult) => void): Request<SSM.Types.AddTagsToResourceResult, AWSError>;
22 /**
23 * Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
24 */
25 cancelCommand(params: SSM.Types.CancelCommandRequest, callback?: (err: AWSError, data: SSM.Types.CancelCommandResult) => void): Request<SSM.Types.CancelCommandResult, AWSError>;
26 /**
27 * Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
28 */
29 cancelCommand(callback?: (err: AWSError, data: SSM.Types.CancelCommandResult) => void): Request<SSM.Types.CancelCommandResult, AWSError>;
30 /**
31 * Stops a Maintenance Window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
32 */
33 cancelMaintenanceWindowExecution(params: SSM.Types.CancelMaintenanceWindowExecutionRequest, callback?: (err: AWSError, data: SSM.Types.CancelMaintenanceWindowExecutionResult) => void): Request<SSM.Types.CancelMaintenanceWindowExecutionResult, AWSError>;
34 /**
35 * Stops a Maintenance Window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
36 */
37 cancelMaintenanceWindowExecution(callback?: (err: AWSError, data: SSM.Types.CancelMaintenanceWindowExecutionResult) => void): Request<SSM.Types.CancelMaintenanceWindowExecutionResult, AWSError>;
38 /**
39 * Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.
40 */
41 createActivation(params: SSM.Types.CreateActivationRequest, callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request<SSM.Types.CreateActivationResult, AWSError>;
42 /**
43 * Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.
44 */
45 createActivation(callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request<SSM.Types.CreateActivationResult, AWSError>;
46 /**
47 * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
48 */
49 createAssociation(params: SSM.Types.CreateAssociationRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request<SSM.Types.CreateAssociationResult, AWSError>;
50 /**
51 * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
52 */
53 createAssociation(callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request<SSM.Types.CreateAssociationResult, AWSError>;
54 /**
55 * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
56 */
57 createAssociationBatch(params: SSM.Types.CreateAssociationBatchRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request<SSM.Types.CreateAssociationBatchResult, AWSError>;
58 /**
59 * Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
60 */
61 createAssociationBatch(callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request<SSM.Types.CreateAssociationBatchResult, AWSError>;
62 /**
63 * Creates a Systems Manager document. After you create a document, you can use CreateAssociation to associate it with one or more running instances.
64 */
65 createDocument(params: SSM.Types.CreateDocumentRequest, callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request<SSM.Types.CreateDocumentResult, AWSError>;
66 /**
67 * Creates a Systems Manager document. After you create a document, you can use CreateAssociation to associate it with one or more running instances.
68 */
69 createDocument(callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request<SSM.Types.CreateDocumentResult, AWSError>;
70 /**
71 * Creates a new Maintenance Window.
72 */
73 createMaintenanceWindow(params: SSM.Types.CreateMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.CreateMaintenanceWindowResult) => void): Request<SSM.Types.CreateMaintenanceWindowResult, AWSError>;
74 /**
75 * Creates a new Maintenance Window.
76 */
77 createMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.CreateMaintenanceWindowResult) => void): Request<SSM.Types.CreateMaintenanceWindowResult, AWSError>;
78 /**
79 * Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
80 */
81 createPatchBaseline(params: SSM.Types.CreatePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.CreatePatchBaselineResult) => void): Request<SSM.Types.CreatePatchBaselineResult, AWSError>;
82 /**
83 * Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
84 */
85 createPatchBaseline(callback?: (err: AWSError, data: SSM.Types.CreatePatchBaselineResult) => void): Request<SSM.Types.CreatePatchBaselineResult, AWSError>;
86 /**
87 * Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
88 */
89 createResourceDataSync(params: SSM.Types.CreateResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.CreateResourceDataSyncResult) => void): Request<SSM.Types.CreateResourceDataSyncResult, AWSError>;
90 /**
91 * Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
92 */
93 createResourceDataSync(callback?: (err: AWSError, data: SSM.Types.CreateResourceDataSyncResult) => void): Request<SSM.Types.CreateResourceDataSyncResult, AWSError>;
94 /**
95 * Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
96 */
97 deleteActivation(params: SSM.Types.DeleteActivationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request<SSM.Types.DeleteActivationResult, AWSError>;
98 /**
99 * Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
100 */
101 deleteActivation(callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request<SSM.Types.DeleteActivationResult, AWSError>;
102 /**
103 * Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
104 */
105 deleteAssociation(params: SSM.Types.DeleteAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request<SSM.Types.DeleteAssociationResult, AWSError>;
106 /**
107 * Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
108 */
109 deleteAssociation(callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request<SSM.Types.DeleteAssociationResult, AWSError>;
110 /**
111 * Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
112 */
113 deleteDocument(params: SSM.Types.DeleteDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request<SSM.Types.DeleteDocumentResult, AWSError>;
114 /**
115 * Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
116 */
117 deleteDocument(callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request<SSM.Types.DeleteDocumentResult, AWSError>;
118 /**
119 * Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
120 */
121 deleteInventory(params: SSM.Types.DeleteInventoryRequest, callback?: (err: AWSError, data: SSM.Types.DeleteInventoryResult) => void): Request<SSM.Types.DeleteInventoryResult, AWSError>;
122 /**
123 * Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
124 */
125 deleteInventory(callback?: (err: AWSError, data: SSM.Types.DeleteInventoryResult) => void): Request<SSM.Types.DeleteInventoryResult, AWSError>;
126 /**
127 * Deletes a Maintenance Window.
128 */
129 deleteMaintenanceWindow(params: SSM.Types.DeleteMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeleteMaintenanceWindowResult) => void): Request<SSM.Types.DeleteMaintenanceWindowResult, AWSError>;
130 /**
131 * Deletes a Maintenance Window.
132 */
133 deleteMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeleteMaintenanceWindowResult) => void): Request<SSM.Types.DeleteMaintenanceWindowResult, AWSError>;
134 /**
135 * Delete a parameter from the system.
136 */
137 deleteParameter(params: SSM.Types.DeleteParameterRequest, callback?: (err: AWSError, data: SSM.Types.DeleteParameterResult) => void): Request<SSM.Types.DeleteParameterResult, AWSError>;
138 /**
139 * Delete a parameter from the system.
140 */
141 deleteParameter(callback?: (err: AWSError, data: SSM.Types.DeleteParameterResult) => void): Request<SSM.Types.DeleteParameterResult, AWSError>;
142 /**
143 * Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.
144 */
145 deleteParameters(params: SSM.Types.DeleteParametersRequest, callback?: (err: AWSError, data: SSM.Types.DeleteParametersResult) => void): Request<SSM.Types.DeleteParametersResult, AWSError>;
146 /**
147 * Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.
148 */
149 deleteParameters(callback?: (err: AWSError, data: SSM.Types.DeleteParametersResult) => void): Request<SSM.Types.DeleteParametersResult, AWSError>;
150 /**
151 * Deletes a patch baseline.
152 */
153 deletePatchBaseline(params: SSM.Types.DeletePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.DeletePatchBaselineResult) => void): Request<SSM.Types.DeletePatchBaselineResult, AWSError>;
154 /**
155 * Deletes a patch baseline.
156 */
157 deletePatchBaseline(callback?: (err: AWSError, data: SSM.Types.DeletePatchBaselineResult) => void): Request<SSM.Types.DeletePatchBaselineResult, AWSError>;
158 /**
159 * Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.
160 */
161 deleteResourceDataSync(params: SSM.Types.DeleteResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.DeleteResourceDataSyncResult) => void): Request<SSM.Types.DeleteResourceDataSyncResult, AWSError>;
162 /**
163 * Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.
164 */
165 deleteResourceDataSync(callback?: (err: AWSError, data: SSM.Types.DeleteResourceDataSyncResult) => void): Request<SSM.Types.DeleteResourceDataSyncResult, AWSError>;
166 /**
167 * Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
168 */
169 deregisterManagedInstance(params: SSM.Types.DeregisterManagedInstanceRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request<SSM.Types.DeregisterManagedInstanceResult, AWSError>;
170 /**
171 * Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
172 */
173 deregisterManagedInstance(callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request<SSM.Types.DeregisterManagedInstanceResult, AWSError>;
174 /**
175 * Removes a patch group from a patch baseline.
176 */
177 deregisterPatchBaselineForPatchGroup(params: SSM.Types.DeregisterPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.DeregisterPatchBaselineForPatchGroupResult, AWSError>;
178 /**
179 * Removes a patch group from a patch baseline.
180 */
181 deregisterPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.DeregisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.DeregisterPatchBaselineForPatchGroupResult, AWSError>;
182 /**
183 * Removes a target from a Maintenance Window.
184 */
185 deregisterTargetFromMaintenanceWindow(params: SSM.Types.DeregisterTargetFromMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterTargetFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTargetFromMaintenanceWindowResult, AWSError>;
186 /**
187 * Removes a target from a Maintenance Window.
188 */
189 deregisterTargetFromMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeregisterTargetFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTargetFromMaintenanceWindowResult, AWSError>;
190 /**
191 * Removes a task from a Maintenance Window.
192 */
193 deregisterTaskFromMaintenanceWindow(params: SSM.Types.DeregisterTaskFromMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterTaskFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTaskFromMaintenanceWindowResult, AWSError>;
194 /**
195 * Removes a task from a Maintenance Window.
196 */
197 deregisterTaskFromMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeregisterTaskFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTaskFromMaintenanceWindowResult, AWSError>;
198 /**
199 * Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
200 */
201 describeActivations(params: SSM.Types.DescribeActivationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request<SSM.Types.DescribeActivationsResult, AWSError>;
202 /**
203 * Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
204 */
205 describeActivations(callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request<SSM.Types.DescribeActivationsResult, AWSError>;
206 /**
207 * Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.
208 */
209 describeAssociation(params: SSM.Types.DescribeAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request<SSM.Types.DescribeAssociationResult, AWSError>;
210 /**
211 * Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.
212 */
213 describeAssociation(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request<SSM.Types.DescribeAssociationResult, AWSError>;
214 /**
215 * Use this API action to view information about a specific execution of a specific association.
216 */
217 describeAssociationExecutionTargets(params: SSM.Types.DescribeAssociationExecutionTargetsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionTargetsResult) => void): Request<SSM.Types.DescribeAssociationExecutionTargetsResult, AWSError>;
218 /**
219 * Use this API action to view information about a specific execution of a specific association.
220 */
221 describeAssociationExecutionTargets(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionTargetsResult) => void): Request<SSM.Types.DescribeAssociationExecutionTargetsResult, AWSError>;
222 /**
223 * Use this API action to view all executions for a specific association ID.
224 */
225 describeAssociationExecutions(params: SSM.Types.DescribeAssociationExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionsResult) => void): Request<SSM.Types.DescribeAssociationExecutionsResult, AWSError>;
226 /**
227 * Use this API action to view all executions for a specific association ID.
228 */
229 describeAssociationExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionsResult) => void): Request<SSM.Types.DescribeAssociationExecutionsResult, AWSError>;
230 /**
231 * Provides details about all active and terminated Automation executions.
232 */
233 describeAutomationExecutions(params: SSM.Types.DescribeAutomationExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAutomationExecutionsResult) => void): Request<SSM.Types.DescribeAutomationExecutionsResult, AWSError>;
234 /**
235 * Provides details about all active and terminated Automation executions.
236 */
237 describeAutomationExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAutomationExecutionsResult) => void): Request<SSM.Types.DescribeAutomationExecutionsResult, AWSError>;
238 /**
239 * Information about all active and terminated step executions in an Automation workflow.
240 */
241 describeAutomationStepExecutions(params: SSM.Types.DescribeAutomationStepExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAutomationStepExecutionsResult) => void): Request<SSM.Types.DescribeAutomationStepExecutionsResult, AWSError>;
242 /**
243 * Information about all active and terminated step executions in an Automation workflow.
244 */
245 describeAutomationStepExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAutomationStepExecutionsResult) => void): Request<SSM.Types.DescribeAutomationStepExecutionsResult, AWSError>;
246 /**
247 * Lists all patches that could possibly be included in a patch baseline.
248 */
249 describeAvailablePatches(params: SSM.Types.DescribeAvailablePatchesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAvailablePatchesResult) => void): Request<SSM.Types.DescribeAvailablePatchesResult, AWSError>;
250 /**
251 * Lists all patches that could possibly be included in a patch baseline.
252 */
253 describeAvailablePatches(callback?: (err: AWSError, data: SSM.Types.DescribeAvailablePatchesResult) => void): Request<SSM.Types.DescribeAvailablePatchesResult, AWSError>;
254 /**
255 * Describes the specified Systems Manager document.
256 */
257 describeDocument(params: SSM.Types.DescribeDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request<SSM.Types.DescribeDocumentResult, AWSError>;
258 /**
259 * Describes the specified Systems Manager document.
260 */
261 describeDocument(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request<SSM.Types.DescribeDocumentResult, AWSError>;
262 /**
263 * Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
264 */
265 describeDocumentPermission(params: SSM.Types.DescribeDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request<SSM.Types.DescribeDocumentPermissionResponse, AWSError>;
266 /**
267 * Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
268 */
269 describeDocumentPermission(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request<SSM.Types.DescribeDocumentPermissionResponse, AWSError>;
270 /**
271 * All associations for the instance(s).
272 */
273 describeEffectiveInstanceAssociations(params: SSM.Types.DescribeEffectiveInstanceAssociationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeEffectiveInstanceAssociationsResult) => void): Request<SSM.Types.DescribeEffectiveInstanceAssociationsResult, AWSError>;
274 /**
275 * All associations for the instance(s).
276 */
277 describeEffectiveInstanceAssociations(callback?: (err: AWSError, data: SSM.Types.DescribeEffectiveInstanceAssociationsResult) => void): Request<SSM.Types.DescribeEffectiveInstanceAssociationsResult, AWSError>;
278 /**
279 * Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
280 */
281 describeEffectivePatchesForPatchBaseline(params: SSM.Types.DescribeEffectivePatchesForPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.DescribeEffectivePatchesForPatchBaselineResult) => void): Request<SSM.Types.DescribeEffectivePatchesForPatchBaselineResult, AWSError>;
282 /**
283 * Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
284 */
285 describeEffectivePatchesForPatchBaseline(callback?: (err: AWSError, data: SSM.Types.DescribeEffectivePatchesForPatchBaselineResult) => void): Request<SSM.Types.DescribeEffectivePatchesForPatchBaselineResult, AWSError>;
286 /**
287 * The status of the associations for the instance(s).
288 */
289 describeInstanceAssociationsStatus(params: SSM.Types.DescribeInstanceAssociationsStatusRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstanceAssociationsStatusResult) => void): Request<SSM.Types.DescribeInstanceAssociationsStatusResult, AWSError>;
290 /**
291 * The status of the associations for the instance(s).
292 */
293 describeInstanceAssociationsStatus(callback?: (err: AWSError, data: SSM.Types.DescribeInstanceAssociationsStatusResult) => void): Request<SSM.Types.DescribeInstanceAssociationsStatusResult, AWSError>;
294 /**
295 * Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.
296 */
297 describeInstanceInformation(params: SSM.Types.DescribeInstanceInformationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request<SSM.Types.DescribeInstanceInformationResult, AWSError>;
298 /**
299 * Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.
300 */
301 describeInstanceInformation(callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request<SSM.Types.DescribeInstanceInformationResult, AWSError>;
302 /**
303 * Retrieves the high-level patch state of one or more instances.
304 */
305 describeInstancePatchStates(params: SSM.Types.DescribeInstancePatchStatesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesResult) => void): Request<SSM.Types.DescribeInstancePatchStatesResult, AWSError>;
306 /**
307 * Retrieves the high-level patch state of one or more instances.
308 */
309 describeInstancePatchStates(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesResult) => void): Request<SSM.Types.DescribeInstancePatchStatesResult, AWSError>;
310 /**
311 * Retrieves the high-level patch state for the instances in the specified patch group.
312 */
313 describeInstancePatchStatesForPatchGroup(params: SSM.Types.DescribeInstancePatchStatesForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesForPatchGroupResult) => void): Request<SSM.Types.DescribeInstancePatchStatesForPatchGroupResult, AWSError>;
314 /**
315 * Retrieves the high-level patch state for the instances in the specified patch group.
316 */
317 describeInstancePatchStatesForPatchGroup(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesForPatchGroupResult) => void): Request<SSM.Types.DescribeInstancePatchStatesForPatchGroupResult, AWSError>;
318 /**
319 * Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
320 */
321 describeInstancePatches(params: SSM.Types.DescribeInstancePatchesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchesResult) => void): Request<SSM.Types.DescribeInstancePatchesResult, AWSError>;
322 /**
323 * Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
324 */
325 describeInstancePatches(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchesResult) => void): Request<SSM.Types.DescribeInstancePatchesResult, AWSError>;
326 /**
327 * Describes a specific delete inventory operation.
328 */
329 describeInventoryDeletions(params: SSM.Types.DescribeInventoryDeletionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInventoryDeletionsResult) => void): Request<SSM.Types.DescribeInventoryDeletionsResult, AWSError>;
330 /**
331 * Describes a specific delete inventory operation.
332 */
333 describeInventoryDeletions(callback?: (err: AWSError, data: SSM.Types.DescribeInventoryDeletionsResult) => void): Request<SSM.Types.DescribeInventoryDeletionsResult, AWSError>;
334 /**
335 * Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.
336 */
337 describeMaintenanceWindowExecutionTaskInvocations(params: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult, AWSError>;
338 /**
339 * Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.
340 */
341 describeMaintenanceWindowExecutionTaskInvocations(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult, AWSError>;
342 /**
343 * For a given Maintenance Window execution, lists the tasks that were executed.
344 */
345 describeMaintenanceWindowExecutionTasks(params: SSM.Types.DescribeMaintenanceWindowExecutionTasksRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTasksResult, AWSError>;
346 /**
347 * For a given Maintenance Window execution, lists the tasks that were executed.
348 */
349 describeMaintenanceWindowExecutionTasks(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTasksResult, AWSError>;
350 /**
351 * Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window.
352 */
353 describeMaintenanceWindowExecutions(params: SSM.Types.DescribeMaintenanceWindowExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionsResult, AWSError>;
354 /**
355 * Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window.
356 */
357 describeMaintenanceWindowExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionsResult, AWSError>;
358 /**
359 * Retrieves information about upcoming executions of a Maintenance Window.
360 */
361 describeMaintenanceWindowSchedule(params: SSM.Types.DescribeMaintenanceWindowScheduleRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowScheduleResult) => void): Request<SSM.Types.DescribeMaintenanceWindowScheduleResult, AWSError>;
362 /**
363 * Retrieves information about upcoming executions of a Maintenance Window.
364 */
365 describeMaintenanceWindowSchedule(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowScheduleResult) => void): Request<SSM.Types.DescribeMaintenanceWindowScheduleResult, AWSError>;
366 /**
367 * Lists the targets registered with the Maintenance Window.
368 */
369 describeMaintenanceWindowTargets(params: SSM.Types.DescribeMaintenanceWindowTargetsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTargetsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTargetsResult, AWSError>;
370 /**
371 * Lists the targets registered with the Maintenance Window.
372 */
373 describeMaintenanceWindowTargets(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTargetsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTargetsResult, AWSError>;
374 /**
375 * Lists the tasks in a Maintenance Window.
376 */
377 describeMaintenanceWindowTasks(params: SSM.Types.DescribeMaintenanceWindowTasksRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTasksResult, AWSError>;
378 /**
379 * Lists the tasks in a Maintenance Window.
380 */
381 describeMaintenanceWindowTasks(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTasksResult, AWSError>;
382 /**
383 * Retrieves the Maintenance Windows in an AWS account.
384 */
385 describeMaintenanceWindows(params: SSM.Types.DescribeMaintenanceWindowsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsResult, AWSError>;
386 /**
387 * Retrieves the Maintenance Windows in an AWS account.
388 */
389 describeMaintenanceWindows(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsResult, AWSError>;
390 /**
391 * Retrieves information about the Maintenance Windows targets or tasks that an instance is associated with.
392 */
393 describeMaintenanceWindowsForTarget(params: SSM.Types.DescribeMaintenanceWindowsForTargetRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsForTargetResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsForTargetResult, AWSError>;
394 /**
395 * Retrieves information about the Maintenance Windows targets or tasks that an instance is associated with.
396 */
397 describeMaintenanceWindowsForTarget(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsForTargetResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsForTargetResult, AWSError>;
398 /**
399 * Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
400 */
401 describeParameters(params: SSM.Types.DescribeParametersRequest, callback?: (err: AWSError, data: SSM.Types.DescribeParametersResult) => void): Request<SSM.Types.DescribeParametersResult, AWSError>;
402 /**
403 * Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
404 */
405 describeParameters(callback?: (err: AWSError, data: SSM.Types.DescribeParametersResult) => void): Request<SSM.Types.DescribeParametersResult, AWSError>;
406 /**
407 * Lists the patch baselines in your AWS account.
408 */
409 describePatchBaselines(params: SSM.Types.DescribePatchBaselinesRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchBaselinesResult) => void): Request<SSM.Types.DescribePatchBaselinesResult, AWSError>;
410 /**
411 * Lists the patch baselines in your AWS account.
412 */
413 describePatchBaselines(callback?: (err: AWSError, data: SSM.Types.DescribePatchBaselinesResult) => void): Request<SSM.Types.DescribePatchBaselinesResult, AWSError>;
414 /**
415 * Returns high-level aggregated patch compliance state for a patch group.
416 */
417 describePatchGroupState(params: SSM.Types.DescribePatchGroupStateRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupStateResult) => void): Request<SSM.Types.DescribePatchGroupStateResult, AWSError>;
418 /**
419 * Returns high-level aggregated patch compliance state for a patch group.
420 */
421 describePatchGroupState(callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupStateResult) => void): Request<SSM.Types.DescribePatchGroupStateResult, AWSError>;
422 /**
423 * Lists all patch groups that have been registered with patch baselines.
424 */
425 describePatchGroups(params: SSM.Types.DescribePatchGroupsRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupsResult) => void): Request<SSM.Types.DescribePatchGroupsResult, AWSError>;
426 /**
427 * Lists all patch groups that have been registered with patch baselines.
428 */
429 describePatchGroups(callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupsResult) => void): Request<SSM.Types.DescribePatchGroupsResult, AWSError>;
430 /**
431 * Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
432 */
433 describeSessions(params: SSM.Types.DescribeSessionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeSessionsResponse) => void): Request<SSM.Types.DescribeSessionsResponse, AWSError>;
434 /**
435 * Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
436 */
437 describeSessions(callback?: (err: AWSError, data: SSM.Types.DescribeSessionsResponse) => void): Request<SSM.Types.DescribeSessionsResponse, AWSError>;
438 /**
439 * Get detailed information about a particular Automation execution.
440 */
441 getAutomationExecution(params: SSM.Types.GetAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.GetAutomationExecutionResult) => void): Request<SSM.Types.GetAutomationExecutionResult, AWSError>;
442 /**
443 * Get detailed information about a particular Automation execution.
444 */
445 getAutomationExecution(callback?: (err: AWSError, data: SSM.Types.GetAutomationExecutionResult) => void): Request<SSM.Types.GetAutomationExecutionResult, AWSError>;
446 /**
447 * Returns detailed information about command execution for an invocation or plugin.
448 */
449 getCommandInvocation(params: SSM.Types.GetCommandInvocationRequest, callback?: (err: AWSError, data: SSM.Types.GetCommandInvocationResult) => void): Request<SSM.Types.GetCommandInvocationResult, AWSError>;
450 /**
451 * Returns detailed information about command execution for an invocation or plugin.
452 */
453 getCommandInvocation(callback?: (err: AWSError, data: SSM.Types.GetCommandInvocationResult) => void): Request<SSM.Types.GetCommandInvocationResult, AWSError>;
454 /**
455 * Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
456 */
457 getConnectionStatus(params: SSM.Types.GetConnectionStatusRequest, callback?: (err: AWSError, data: SSM.Types.GetConnectionStatusResponse) => void): Request<SSM.Types.GetConnectionStatusResponse, AWSError>;
458 /**
459 * Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
460 */
461 getConnectionStatus(callback?: (err: AWSError, data: SSM.Types.GetConnectionStatusResponse) => void): Request<SSM.Types.GetConnectionStatusResponse, AWSError>;
462 /**
463 * Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned.
464 */
465 getDefaultPatchBaseline(params: SSM.Types.GetDefaultPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.GetDefaultPatchBaselineResult) => void): Request<SSM.Types.GetDefaultPatchBaselineResult, AWSError>;
466 /**
467 * Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned.
468 */
469 getDefaultPatchBaseline(callback?: (err: AWSError, data: SSM.Types.GetDefaultPatchBaselineResult) => void): Request<SSM.Types.GetDefaultPatchBaselineResult, AWSError>;
470 /**
471 * Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
472 */
473 getDeployablePatchSnapshotForInstance(params: SSM.Types.GetDeployablePatchSnapshotForInstanceRequest, callback?: (err: AWSError, data: SSM.Types.GetDeployablePatchSnapshotForInstanceResult) => void): Request<SSM.Types.GetDeployablePatchSnapshotForInstanceResult, AWSError>;
474 /**
475 * Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
476 */
477 getDeployablePatchSnapshotForInstance(callback?: (err: AWSError, data: SSM.Types.GetDeployablePatchSnapshotForInstanceResult) => void): Request<SSM.Types.GetDeployablePatchSnapshotForInstanceResult, AWSError>;
478 /**
479 * Gets the contents of the specified Systems Manager document.
480 */
481 getDocument(params: SSM.Types.GetDocumentRequest, callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request<SSM.Types.GetDocumentResult, AWSError>;
482 /**
483 * Gets the contents of the specified Systems Manager document.
484 */
485 getDocument(callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request<SSM.Types.GetDocumentResult, AWSError>;
486 /**
487 * Query inventory information.
488 */
489 getInventory(params: SSM.Types.GetInventoryRequest, callback?: (err: AWSError, data: SSM.Types.GetInventoryResult) => void): Request<SSM.Types.GetInventoryResult, AWSError>;
490 /**
491 * Query inventory information.
492 */
493 getInventory(callback?: (err: AWSError, data: SSM.Types.GetInventoryResult) => void): Request<SSM.Types.GetInventoryResult, AWSError>;
494 /**
495 * Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
496 */
497 getInventorySchema(params: SSM.Types.GetInventorySchemaRequest, callback?: (err: AWSError, data: SSM.Types.GetInventorySchemaResult) => void): Request<SSM.Types.GetInventorySchemaResult, AWSError>;
498 /**
499 * Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
500 */
501 getInventorySchema(callback?: (err: AWSError, data: SSM.Types.GetInventorySchemaResult) => void): Request<SSM.Types.GetInventorySchemaResult, AWSError>;
502 /**
503 * Retrieves a Maintenance Window.
504 */
505 getMaintenanceWindow(params: SSM.Types.GetMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowResult) => void): Request<SSM.Types.GetMaintenanceWindowResult, AWSError>;
506 /**
507 * Retrieves a Maintenance Window.
508 */
509 getMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowResult) => void): Request<SSM.Types.GetMaintenanceWindowResult, AWSError>;
510 /**
511 * Retrieves details about a specific task executed as part of a Maintenance Window execution.
512 */
513 getMaintenanceWindowExecution(params: SSM.Types.GetMaintenanceWindowExecutionRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionResult, AWSError>;
514 /**
515 * Retrieves details about a specific task executed as part of a Maintenance Window execution.
516 */
517 getMaintenanceWindowExecution(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionResult, AWSError>;
518 /**
519 * Retrieves the details about a specific task executed as part of a Maintenance Window execution.
520 */
521 getMaintenanceWindowExecutionTask(params: SSM.Types.GetMaintenanceWindowExecutionTaskRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskResult, AWSError>;
522 /**
523 * Retrieves the details about a specific task executed as part of a Maintenance Window execution.
524 */
525 getMaintenanceWindowExecutionTask(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskResult, AWSError>;
526 /**
527 * Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.
528 */
529 getMaintenanceWindowExecutionTaskInvocation(params: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult, AWSError>;
530 /**
531 * Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.
532 */
533 getMaintenanceWindowExecutionTaskInvocation(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult, AWSError>;
534 /**
535 * Lists the tasks in a Maintenance Window.
536 */
537 getMaintenanceWindowTask(params: SSM.Types.GetMaintenanceWindowTaskRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowTaskResult, AWSError>;
538 /**
539 * Lists the tasks in a Maintenance Window.
540 */
541 getMaintenanceWindowTask(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowTaskResult, AWSError>;
542 /**
543 * Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
544 */
545 getParameter(params: SSM.Types.GetParameterRequest, callback?: (err: AWSError, data: SSM.Types.GetParameterResult) => void): Request<SSM.Types.GetParameterResult, AWSError>;
546 /**
547 * Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
548 */
549 getParameter(callback?: (err: AWSError, data: SSM.Types.GetParameterResult) => void): Request<SSM.Types.GetParameterResult, AWSError>;
550 /**
551 * Query a list of all parameters used by the AWS account.
552 */
553 getParameterHistory(params: SSM.Types.GetParameterHistoryRequest, callback?: (err: AWSError, data: SSM.Types.GetParameterHistoryResult) => void): Request<SSM.Types.GetParameterHistoryResult, AWSError>;
554 /**
555 * Query a list of all parameters used by the AWS account.
556 */
557 getParameterHistory(callback?: (err: AWSError, data: SSM.Types.GetParameterHistoryResult) => void): Request<SSM.Types.GetParameterHistoryResult, AWSError>;
558 /**
559 * Get details of a parameter. Don't confuse this API action with the GetParameter API action.
560 */
561 getParameters(params: SSM.Types.GetParametersRequest, callback?: (err: AWSError, data: SSM.Types.GetParametersResult) => void): Request<SSM.Types.GetParametersResult, AWSError>;
562 /**
563 * Get details of a parameter. Don't confuse this API action with the GetParameter API action.
564 */
565 getParameters(callback?: (err: AWSError, data: SSM.Types.GetParametersResult) => void): Request<SSM.Types.GetParametersResult, AWSError>;
566 /**
567 * Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. This API action doesn't support filtering by tags.
568 */
569 getParametersByPath(params: SSM.Types.GetParametersByPathRequest, callback?: (err: AWSError, data: SSM.Types.GetParametersByPathResult) => void): Request<SSM.Types.GetParametersByPathResult, AWSError>;
570 /**
571 * Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. This API action doesn't support filtering by tags.
572 */
573 getParametersByPath(callback?: (err: AWSError, data: SSM.Types.GetParametersByPathResult) => void): Request<SSM.Types.GetParametersByPathResult, AWSError>;
574 /**
575 * Retrieves information about a patch baseline.
576 */
577 getPatchBaseline(params: SSM.Types.GetPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineResult) => void): Request<SSM.Types.GetPatchBaselineResult, AWSError>;
578 /**
579 * Retrieves information about a patch baseline.
580 */
581 getPatchBaseline(callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineResult) => void): Request<SSM.Types.GetPatchBaselineResult, AWSError>;
582 /**
583 * Retrieves the patch baseline that should be used for the specified patch group.
584 */
585 getPatchBaselineForPatchGroup(params: SSM.Types.GetPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.GetPatchBaselineForPatchGroupResult, AWSError>;
586 /**
587 * Retrieves the patch baseline that should be used for the specified patch group.
588 */
589 getPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.GetPatchBaselineForPatchGroupResult, AWSError>;
590 /**
591 * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Query the current service setting for the account.
592 */
593 getServiceSetting(params: SSM.Types.GetServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.GetServiceSettingResult) => void): Request<SSM.Types.GetServiceSettingResult, AWSError>;
594 /**
595 * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Query the current service setting for the account.
596 */
597 getServiceSetting(callback?: (err: AWSError, data: SSM.Types.GetServiceSettingResult) => void): Request<SSM.Types.GetServiceSettingResult, AWSError>;
598 /**
599 * A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
600 */
601 labelParameterVersion(params: SSM.Types.LabelParameterVersionRequest, callback?: (err: AWSError, data: SSM.Types.LabelParameterVersionResult) => void): Request<SSM.Types.LabelParameterVersionResult, AWSError>;
602 /**
603 * A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
604 */
605 labelParameterVersion(callback?: (err: AWSError, data: SSM.Types.LabelParameterVersionResult) => void): Request<SSM.Types.LabelParameterVersionResult, AWSError>;
606 /**
607 * Retrieves all versions of an association for a specific association ID.
608 */
609 listAssociationVersions(params: SSM.Types.ListAssociationVersionsRequest, callback?: (err: AWSError, data: SSM.Types.ListAssociationVersionsResult) => void): Request<SSM.Types.ListAssociationVersionsResult, AWSError>;
610 /**
611 * Retrieves all versions of an association for a specific association ID.
612 */
613 listAssociationVersions(callback?: (err: AWSError, data: SSM.Types.ListAssociationVersionsResult) => void): Request<SSM.Types.ListAssociationVersionsResult, AWSError>;
614 /**
615 * Lists the associations for the specified Systems Manager document or instance.
616 */
617 listAssociations(params: SSM.Types.ListAssociationsRequest, callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request<SSM.Types.ListAssociationsResult, AWSError>;
618 /**
619 * Lists the associations for the specified Systems Manager document or instance.
620 */
621 listAssociations(callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request<SSM.Types.ListAssociationsResult, AWSError>;
622 /**
623 * An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
624 */
625 listCommandInvocations(params: SSM.Types.ListCommandInvocationsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request<SSM.Types.ListCommandInvocationsResult, AWSError>;
626 /**
627 * An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
628 */
629 listCommandInvocations(callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request<SSM.Types.ListCommandInvocationsResult, AWSError>;
630 /**
631 * Lists the commands requested by users of the AWS account.
632 */
633 listCommands(params: SSM.Types.ListCommandsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request<SSM.Types.ListCommandsResult, AWSError>;
634 /**
635 * Lists the commands requested by users of the AWS account.
636 */
637 listCommands(callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request<SSM.Types.ListCommandsResult, AWSError>;
638 /**
639 * For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
640 */
641 listComplianceItems(params: SSM.Types.ListComplianceItemsRequest, callback?: (err: AWSError, data: SSM.Types.ListComplianceItemsResult) => void): Request<SSM.Types.ListComplianceItemsResult, AWSError>;
642 /**
643 * For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
644 */
645 listComplianceItems(callback?: (err: AWSError, data: SSM.Types.ListComplianceItemsResult) => void): Request<SSM.Types.ListComplianceItemsResult, AWSError>;
646 /**
647 * Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
648 */
649 listComplianceSummaries(params: SSM.Types.ListComplianceSummariesRequest, callback?: (err: AWSError, data: SSM.Types.ListComplianceSummariesResult) => void): Request<SSM.Types.ListComplianceSummariesResult, AWSError>;
650 /**
651 * Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
652 */
653 listComplianceSummaries(callback?: (err: AWSError, data: SSM.Types.ListComplianceSummariesResult) => void): Request<SSM.Types.ListComplianceSummariesResult, AWSError>;
654 /**
655 * List all versions for a document.
656 */
657 listDocumentVersions(params: SSM.Types.ListDocumentVersionsRequest, callback?: (err: AWSError, data: SSM.Types.ListDocumentVersionsResult) => void): Request<SSM.Types.ListDocumentVersionsResult, AWSError>;
658 /**
659 * List all versions for a document.
660 */
661 listDocumentVersions(callback?: (err: AWSError, data: SSM.Types.ListDocumentVersionsResult) => void): Request<SSM.Types.ListDocumentVersionsResult, AWSError>;
662 /**
663 * Describes one or more of your Systems Manager documents.
664 */
665 listDocuments(params: SSM.Types.ListDocumentsRequest, callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request<SSM.Types.ListDocumentsResult, AWSError>;
666 /**
667 * Describes one or more of your Systems Manager documents.
668 */
669 listDocuments(callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request<SSM.Types.ListDocumentsResult, AWSError>;
670 /**
671 * A list of inventory items returned by the request.
672 */
673 listInventoryEntries(params: SSM.Types.ListInventoryEntriesRequest, callback?: (err: AWSError, data: SSM.Types.ListInventoryEntriesResult) => void): Request<SSM.Types.ListInventoryEntriesResult, AWSError>;
674 /**
675 * A list of inventory items returned by the request.
676 */
677 listInventoryEntries(callback?: (err: AWSError, data: SSM.Types.ListInventoryEntriesResult) => void): Request<SSM.Types.ListInventoryEntriesResult, AWSError>;
678 /**
679 * Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
680 */
681 listResourceComplianceSummaries(params: SSM.Types.ListResourceComplianceSummariesRequest, callback?: (err: AWSError, data: SSM.Types.ListResourceComplianceSummariesResult) => void): Request<SSM.Types.ListResourceComplianceSummariesResult, AWSError>;
682 /**
683 * Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
684 */
685 listResourceComplianceSummaries(callback?: (err: AWSError, data: SSM.Types.ListResourceComplianceSummariesResult) => void): Request<SSM.Types.ListResourceComplianceSummariesResult, AWSError>;
686 /**
687 * Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.
688 */
689 listResourceDataSync(params: SSM.Types.ListResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.ListResourceDataSyncResult) => void): Request<SSM.Types.ListResourceDataSyncResult, AWSError>;
690 /**
691 * Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.
692 */
693 listResourceDataSync(callback?: (err: AWSError, data: SSM.Types.ListResourceDataSyncResult) => void): Request<SSM.Types.ListResourceDataSyncResult, AWSError>;
694 /**
695 * Returns a list of the tags assigned to the specified resource.
696 */
697 listTagsForResource(params: SSM.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request<SSM.Types.ListTagsForResourceResult, AWSError>;
698 /**
699 * Returns a list of the tags assigned to the specified resource.
700 */
701 listTagsForResource(callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request<SSM.Types.ListTagsForResourceResult, AWSError>;
702 /**
703 * Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
704 */
705 modifyDocumentPermission(params: SSM.Types.ModifyDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request<SSM.Types.ModifyDocumentPermissionResponse, AWSError>;
706 /**
707 * Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
708 */
709 modifyDocumentPermission(callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request<SSM.Types.ModifyDocumentPermissionResponse, AWSError>;
710 /**
711 * Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, critical. DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
712 */
713 putComplianceItems(params: SSM.Types.PutComplianceItemsRequest, callback?: (err: AWSError, data: SSM.Types.PutComplianceItemsResult) => void): Request<SSM.Types.PutComplianceItemsResult, AWSError>;
714 /**
715 * Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, critical. DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
716 */
717 putComplianceItems(callback?: (err: AWSError, data: SSM.Types.PutComplianceItemsResult) => void): Request<SSM.Types.PutComplianceItemsResult, AWSError>;
718 /**
719 * Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
720 */
721 putInventory(params: SSM.Types.PutInventoryRequest, callback?: (err: AWSError, data: SSM.Types.PutInventoryResult) => void): Request<SSM.Types.PutInventoryResult, AWSError>;
722 /**
723 * Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
724 */
725 putInventory(callback?: (err: AWSError, data: SSM.Types.PutInventoryResult) => void): Request<SSM.Types.PutInventoryResult, AWSError>;
726 /**
727 * Add a parameter to the system.
728 */
729 putParameter(params: SSM.Types.PutParameterRequest, callback?: (err: AWSError, data: SSM.Types.PutParameterResult) => void): Request<SSM.Types.PutParameterResult, AWSError>;
730 /**
731 * Add a parameter to the system.
732 */
733 putParameter(callback?: (err: AWSError, data: SSM.Types.PutParameterResult) => void): Request<SSM.Types.PutParameterResult, AWSError>;
734 /**
735 * Defines the default patch baseline.
736 */
737 registerDefaultPatchBaseline(params: SSM.Types.RegisterDefaultPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.RegisterDefaultPatchBaselineResult) => void): Request<SSM.Types.RegisterDefaultPatchBaselineResult, AWSError>;
738 /**
739 * Defines the default patch baseline.
740 */
741 registerDefaultPatchBaseline(callback?: (err: AWSError, data: SSM.Types.RegisterDefaultPatchBaselineResult) => void): Request<SSM.Types.RegisterDefaultPatchBaselineResult, AWSError>;
742 /**
743 * Registers a patch baseline for a patch group.
744 */
745 registerPatchBaselineForPatchGroup(params: SSM.Types.RegisterPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.RegisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.RegisterPatchBaselineForPatchGroupResult, AWSError>;
746 /**
747 * Registers a patch baseline for a patch group.
748 */
749 registerPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.RegisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.RegisterPatchBaselineForPatchGroupResult, AWSError>;
750 /**
751 * Registers a target with a Maintenance Window.
752 */
753 registerTargetWithMaintenanceWindow(params: SSM.Types.RegisterTargetWithMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.RegisterTargetWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTargetWithMaintenanceWindowResult, AWSError>;
754 /**
755 * Registers a target with a Maintenance Window.
756 */
757 registerTargetWithMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.RegisterTargetWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTargetWithMaintenanceWindowResult, AWSError>;
758 /**
759 * Adds a new task to a Maintenance Window.
760 */
761 registerTaskWithMaintenanceWindow(params: SSM.Types.RegisterTaskWithMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.RegisterTaskWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTaskWithMaintenanceWindowResult, AWSError>;
762 /**
763 * Adds a new task to a Maintenance Window.
764 */
765 registerTaskWithMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.RegisterTaskWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTaskWithMaintenanceWindowResult, AWSError>;
766 /**
767 * Removes all tags from the specified resource.
768 */
769 removeTagsFromResource(params: SSM.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request<SSM.Types.RemoveTagsFromResourceResult, AWSError>;
770 /**
771 * Removes all tags from the specified resource.
772 */
773 removeTagsFromResource(callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request<SSM.Types.RemoveTagsFromResourceResult, AWSError>;
774 /**
775 * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting. Reset the service setting for the account to the default value as provisioned by the AWS service team.
776 */
777 resetServiceSetting(params: SSM.Types.ResetServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.ResetServiceSettingResult) => void): Request<SSM.Types.ResetServiceSettingResult, AWSError>;
778 /**
779 * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting. Reset the service setting for the account to the default value as provisioned by the AWS service team.
780 */
781 resetServiceSetting(callback?: (err: AWSError, data: SSM.Types.ResetServiceSettingResult) => void): Request<SSM.Types.ResetServiceSettingResult, AWSError>;
782 /**
783 * Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
784 */
785 resumeSession(params: SSM.Types.ResumeSessionRequest, callback?: (err: AWSError, data: SSM.Types.ResumeSessionResponse) => void): Request<SSM.Types.ResumeSessionResponse, AWSError>;
786 /**
787 * Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
788 */
789 resumeSession(callback?: (err: AWSError, data: SSM.Types.ResumeSessionResponse) => void): Request<SSM.Types.ResumeSessionResponse, AWSError>;
790 /**
791 * Sends a signal to an Automation execution to change the current behavior or status of the execution.
792 */
793 sendAutomationSignal(params: SSM.Types.SendAutomationSignalRequest, callback?: (err: AWSError, data: SSM.Types.SendAutomationSignalResult) => void): Request<SSM.Types.SendAutomationSignalResult, AWSError>;
794 /**
795 * Sends a signal to an Automation execution to change the current behavior or status of the execution.
796 */
797 sendAutomationSignal(callback?: (err: AWSError, data: SSM.Types.SendAutomationSignalResult) => void): Request<SSM.Types.SendAutomationSignalResult, AWSError>;
798 /**
799 * Executes commands on one or more managed instances.
800 */
801 sendCommand(params: SSM.Types.SendCommandRequest, callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request<SSM.Types.SendCommandResult, AWSError>;
802 /**
803 * Executes commands on one or more managed instances.
804 */
805 sendCommand(callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request<SSM.Types.SendCommandResult, AWSError>;
806 /**
807 * Use this API action to execute an association immediately and only one time. This action can be helpful when troubleshooting associations.
808 */
809 startAssociationsOnce(params: SSM.Types.StartAssociationsOnceRequest, callback?: (err: AWSError, data: SSM.Types.StartAssociationsOnceResult) => void): Request<SSM.Types.StartAssociationsOnceResult, AWSError>;
810 /**
811 * Use this API action to execute an association immediately and only one time. This action can be helpful when troubleshooting associations.
812 */
813 startAssociationsOnce(callback?: (err: AWSError, data: SSM.Types.StartAssociationsOnceResult) => void): Request<SSM.Types.StartAssociationsOnceResult, AWSError>;
814 /**
815 * Initiates execution of an Automation document.
816 */
817 startAutomationExecution(params: SSM.Types.StartAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.StartAutomationExecutionResult) => void): Request<SSM.Types.StartAutomationExecutionResult, AWSError>;
818 /**
819 * Initiates execution of an Automation document.
820 */
821 startAutomationExecution(callback?: (err: AWSError, data: SSM.Types.StartAutomationExecutionResult) => void): Request<SSM.Types.StartAutomationExecutionResult, AWSError>;
822 /**
823 * Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.
824 */
825 startSession(params: SSM.Types.StartSessionRequest, callback?: (err: AWSError, data: SSM.Types.StartSessionResponse) => void): Request<SSM.Types.StartSessionResponse, AWSError>;
826 /**
827 * Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.
828 */
829 startSession(callback?: (err: AWSError, data: SSM.Types.StartSessionResponse) => void): Request<SSM.Types.StartSessionResponse, AWSError>;
830 /**
831 * Stop an Automation that is currently executing.
832 */
833 stopAutomationExecution(params: SSM.Types.StopAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.StopAutomationExecutionResult) => void): Request<SSM.Types.StopAutomationExecutionResult, AWSError>;
834 /**
835 * Stop an Automation that is currently executing.
836 */
837 stopAutomationExecution(callback?: (err: AWSError, data: SSM.Types.StopAutomationExecutionResult) => void): Request<SSM.Types.StopAutomationExecutionResult, AWSError>;
838 /**
839 * Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
840 */
841 terminateSession(params: SSM.Types.TerminateSessionRequest, callback?: (err: AWSError, data: SSM.Types.TerminateSessionResponse) => void): Request<SSM.Types.TerminateSessionResponse, AWSError>;
842 /**
843 * Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
844 */
845 terminateSession(callback?: (err: AWSError, data: SSM.Types.TerminateSessionResponse) => void): Request<SSM.Types.TerminateSessionResponse, AWSError>;
846 /**
847 * Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
848 */
849 updateAssociation(params: SSM.Types.UpdateAssociationRequest, callback?: (err: AWSError, data: SSM.Types.UpdateAssociationResult) => void): Request<SSM.Types.UpdateAssociationResult, AWSError>;
850 /**
851 * Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
852 */
853 updateAssociation(callback?: (err: AWSError, data: SSM.Types.UpdateAssociationResult) => void): Request<SSM.Types.UpdateAssociationResult, AWSError>;
854 /**
855 * Updates the status of the Systems Manager document associated with the specified instance.
856 */
857 updateAssociationStatus(params: SSM.Types.UpdateAssociationStatusRequest, callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request<SSM.Types.UpdateAssociationStatusResult, AWSError>;
858 /**
859 * Updates the status of the Systems Manager document associated with the specified instance.
860 */
861 updateAssociationStatus(callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request<SSM.Types.UpdateAssociationStatusResult, AWSError>;
862 /**
863 * The document you want to update.
864 */
865 updateDocument(params: SSM.Types.UpdateDocumentRequest, callback?: (err: AWSError, data: SSM.Types.UpdateDocumentResult) => void): Request<SSM.Types.UpdateDocumentResult, AWSError>;
866 /**
867 * The document you want to update.
868 */
869 updateDocument(callback?: (err: AWSError, data: SSM.Types.UpdateDocumentResult) => void): Request<SSM.Types.UpdateDocumentResult, AWSError>;
870 /**
871 * Set the default version of a document.
872 */
873 updateDocumentDefaultVersion(params: SSM.Types.UpdateDocumentDefaultVersionRequest, callback?: (err: AWSError, data: SSM.Types.UpdateDocumentDefaultVersionResult) => void): Request<SSM.Types.UpdateDocumentDefaultVersionResult, AWSError>;
874 /**
875 * Set the default version of a document.
876 */
877 updateDocumentDefaultVersion(callback?: (err: AWSError, data: SSM.Types.UpdateDocumentDefaultVersionResult) => void): Request<SSM.Types.UpdateDocumentDefaultVersionResult, AWSError>;
878 /**
879 * Updates an existing Maintenance Window. Only specified parameters are modified.
880 */
881 updateMaintenanceWindow(params: SSM.Types.UpdateMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowResult) => void): Request<SSM.Types.UpdateMaintenanceWindowResult, AWSError>;
882 /**
883 * Updates an existing Maintenance Window. Only specified parameters are modified.
884 */
885 updateMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowResult) => void): Request<SSM.Types.UpdateMaintenanceWindowResult, AWSError>;
886 /**
887 * Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following: The target from being an ID target to a Tag target, or a Tag target to an ID target. IDs for an ID target. Tags for a Tag target. Owner. Name. Description. If a parameter is null, then the corresponding field is not modified.
888 */
889 updateMaintenanceWindowTarget(params: SSM.Types.UpdateMaintenanceWindowTargetRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTargetResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTargetResult, AWSError>;
890 /**
891 * Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following: The target from being an ID target to a Tag target, or a Tag target to an ID target. IDs for an ID target. Tags for a Tag target. Owner. Name. Description. If a parameter is null, then the corresponding field is not modified.
892 */
893 updateMaintenanceWindowTarget(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTargetResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTargetResult, AWSError>;
894 /**
895 * Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
896 */
897 updateMaintenanceWindowTask(params: SSM.Types.UpdateMaintenanceWindowTaskRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTaskResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTaskResult, AWSError>;
898 /**
899 * Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
900 */
901 updateMaintenanceWindowTask(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTaskResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTaskResult, AWSError>;
902 /**
903 * Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
904 */
905 updateManagedInstanceRole(params: SSM.Types.UpdateManagedInstanceRoleRequest, callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request<SSM.Types.UpdateManagedInstanceRoleResult, AWSError>;
906 /**
907 * Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
908 */
909 updateManagedInstanceRole(callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request<SSM.Types.UpdateManagedInstanceRoleResult, AWSError>;
910 /**
911 * Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
912 */
913 updatePatchBaseline(params: SSM.Types.UpdatePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.UpdatePatchBaselineResult) => void): Request<SSM.Types.UpdatePatchBaselineResult, AWSError>;
914 /**
915 * Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
916 */
917 updatePatchBaseline(callback?: (err: AWSError, data: SSM.Types.UpdatePatchBaselineResult) => void): Request<SSM.Types.UpdatePatchBaselineResult, AWSError>;
918 /**
919 * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Update the service setting for the account.
920 */
921 updateServiceSetting(params: SSM.Types.UpdateServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.UpdateServiceSettingResult) => void): Request<SSM.Types.UpdateServiceSettingResult, AWSError>;
922 /**
923 * ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Update the service setting for the account.
924 */
925 updateServiceSetting(callback?: (err: AWSError, data: SSM.Types.UpdateServiceSettingResult) => void): Request<SSM.Types.UpdateServiceSettingResult, AWSError>;
926}
927declare namespace SSM {
928 export type Account = string;
929 export type AccountId = string;
930 export type AccountIdList = AccountId[];
931 export type Accounts = Account[];
932 export interface Activation {
933 /**
934 * The ID created by Systems Manager when you submitted the activation.
935 */
936 ActivationId?: ActivationId;
937 /**
938 * A user defined description of the activation.
939 */
940 Description?: ActivationDescription;
941 /**
942 * A name for the managed instance when it is created.
943 */
944 DefaultInstanceName?: DefaultInstanceName;
945 /**
946 * The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
947 */
948 IamRole?: IamRole;
949 /**
950 * The maximum number of managed instances that can be registered using this activation.
951 */
952 RegistrationLimit?: RegistrationLimit;
953 /**
954 * The number of managed instances already registered with this activation.
955 */
956 RegistrationsCount?: RegistrationsCount;
957 /**
958 * The date when this activation can no longer be used to register managed instances.
959 */
960 ExpirationDate?: ExpirationDate;
961 /**
962 * Whether or not the activation is expired.
963 */
964 Expired?: Boolean;
965 /**
966 * The date the activation was created.
967 */
968 CreatedDate?: CreatedDate;
969 /**
970 * Tags assigned to the activation.
971 */
972 Tags?: TagList;
973 }
974 export type ActivationCode = string;
975 export type ActivationDescription = string;
976 export type ActivationId = string;
977 export type ActivationList = Activation[];
978 export interface AddTagsToResourceRequest {
979 /**
980 * Specifies the type of resource you are tagging. The ManagedInstance type for this API action is for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
981 */
982 ResourceType: ResourceTypeForTagging;
983 /**
984 * The resource ID you want to tag. Use the ID of the resource. Here are some examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde For the Document and Parameter values, use the name of the resource. The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
985 */
986 ResourceId: ResourceId;
987 /**
988 * One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. Do not enter personally identifiable information in this field.
989 */
990 Tags: TagList;
991 }
992 export interface AddTagsToResourceResult {
993 }
994 export type AgentErrorCode = string;
995 export type AggregatorSchemaOnly = boolean;
996 export type AllowedPattern = string;
997 export type ApproveAfterDays = number;
998 export interface Association {
999 /**
1000 * The name of the Systems Manager document.
1001 */
1002 Name?: DocumentARN;
1003 /**
1004 * The ID of the instance.
1005 */
1006 InstanceId?: InstanceId;
1007 /**
1008 * The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
1009 */
1010 AssociationId?: AssociationId;
1011 /**
1012 * The association version.
1013 */
1014 AssociationVersion?: AssociationVersion;
1015 /**
1016 * The version of the document used in the association.
1017 */
1018 DocumentVersion?: DocumentVersion;
1019 /**
1020 * The instances targeted by the request to create an association.
1021 */
1022 Targets?: Targets;
1023 /**
1024 * The date on which the association was last run.
1025 */
1026 LastExecutionDate?: DateTime;
1027 /**
1028 * Information about the association.
1029 */
1030 Overview?: AssociationOverview;
1031 /**
1032 * A cron expression that specifies a schedule when the association runs.
1033 */
1034 ScheduleExpression?: ScheduleExpression;
1035 /**
1036 * The association name.
1037 */
1038 AssociationName?: AssociationName;
1039 }
1040 export type AssociationComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"UNSPECIFIED"|string;
1041 export interface AssociationDescription {
1042 /**
1043 * The name of the Systems Manager document.
1044 */
1045 Name?: DocumentARN;
1046 /**
1047 * The ID of the instance.
1048 */
1049 InstanceId?: InstanceId;
1050 /**
1051 * The association version.
1052 */
1053 AssociationVersion?: AssociationVersion;
1054 /**
1055 * The date when the association was made.
1056 */
1057 Date?: DateTime;
1058 /**
1059 * The date when the association was last updated.
1060 */
1061 LastUpdateAssociationDate?: DateTime;
1062 /**
1063 * The association status.
1064 */
1065 Status?: AssociationStatus;
1066 /**
1067 * Information about the association.
1068 */
1069 Overview?: AssociationOverview;
1070 /**
1071 * The document version.
1072 */
1073 DocumentVersion?: DocumentVersion;
1074 /**
1075 * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
1076 */
1077 AutomationTargetParameterName?: AutomationTargetParameterName;
1078 /**
1079 * A description of the parameters for a document.
1080 */
1081 Parameters?: Parameters;
1082 /**
1083 * The association ID.
1084 */
1085 AssociationId?: AssociationId;
1086 /**
1087 * The instances targeted by the request.
1088 */
1089 Targets?: Targets;
1090 /**
1091 * A cron expression that specifies a schedule when the association runs.
1092 */
1093 ScheduleExpression?: ScheduleExpression;
1094 /**
1095 * An Amazon S3 bucket where you want to store the output details of the request.
1096 */
1097 OutputLocation?: InstanceAssociationOutputLocation;
1098 /**
1099 * The date on which the association was last run.
1100 */
1101 LastExecutionDate?: DateTime;
1102 /**
1103 * The last date on which the association was successfully run.
1104 */
1105 LastSuccessfulExecutionDate?: DateTime;
1106 /**
1107 * The association name.
1108 */
1109 AssociationName?: AssociationName;
1110 /**
1111 * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
1112 */
1113 MaxErrors?: MaxErrors;
1114 /**
1115 * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
1116 */
1117 MaxConcurrency?: MaxConcurrency;
1118 /**
1119 * The severity level that is assigned to the association.
1120 */
1121 ComplianceSeverity?: AssociationComplianceSeverity;
1122 }
1123 export type AssociationDescriptionList = AssociationDescription[];
1124 export interface AssociationExecution {
1125 /**
1126 * The association ID.
1127 */
1128 AssociationId?: AssociationId;
1129 /**
1130 * The association version.
1131 */
1132 AssociationVersion?: AssociationVersion;
1133 /**
1134 * The execution ID for the association. If the association does not run at intervals or according to a schedule, then the ExecutionID is the same as the AssociationID.
1135 */
1136 ExecutionId?: AssociationExecutionId;
1137 /**
1138 * The status of the association execution.
1139 */
1140 Status?: StatusName;
1141 /**
1142 * Detailed status information about the execution.
1143 */
1144 DetailedStatus?: StatusName;
1145 /**
1146 * The time the execution started.
1147 */
1148 CreatedTime?: DateTime;
1149 /**
1150 * The date of the last execution.
1151 */
1152 LastExecutionDate?: DateTime;
1153 /**
1154 * An aggregate status of the resources in the execution based on the status type.
1155 */
1156 ResourceCountByStatus?: ResourceCountByStatus;
1157 }
1158 export interface AssociationExecutionFilter {
1159 /**
1160 * The key value used in the request.
1161 */
1162 Key: AssociationExecutionFilterKey;
1163 /**
1164 * The value specified for the key.
1165 */
1166 Value: AssociationExecutionFilterValue;
1167 /**
1168 * The filter type specified in the request.
1169 */
1170 Type: AssociationFilterOperatorType;
1171 }
1172 export type AssociationExecutionFilterKey = "ExecutionId"|"Status"|"CreatedTime"|string;
1173 export type AssociationExecutionFilterList = AssociationExecutionFilter[];
1174 export type AssociationExecutionFilterValue = string;
1175 export type AssociationExecutionId = string;
1176 export interface AssociationExecutionTarget {
1177 /**
1178 * The association ID.
1179 */
1180 AssociationId?: AssociationId;
1181 /**
1182 * The association version.
1183 */
1184 AssociationVersion?: AssociationVersion;
1185 /**
1186 * The execution ID. If the association does not run at intervals or according to a schedule, then the ExecutionID is the same as the AssociationID.
1187 */
1188 ExecutionId?: AssociationExecutionId;
1189 /**
1190 * The resource ID, for example, the instance ID where the association ran.
1191 */
1192 ResourceId?: AssociationResourceId;
1193 /**
1194 * The resource type, for example, instance.
1195 */
1196 ResourceType?: AssociationResourceType;
1197 /**
1198 * The association execution status.
1199 */
1200 Status?: StatusName;
1201 /**
1202 * Detailed information about the execution status.
1203 */
1204 DetailedStatus?: StatusName;
1205 /**
1206 * The date of the last execution.
1207 */
1208 LastExecutionDate?: DateTime;
1209 /**
1210 * The location where the association details are saved.
1211 */
1212 OutputSource?: OutputSource;
1213 }
1214 export interface AssociationExecutionTargetsFilter {
1215 /**
1216 * The key value used in the request.
1217 */
1218 Key: AssociationExecutionTargetsFilterKey;
1219 /**
1220 * The value specified for the key.
1221 */
1222 Value: AssociationExecutionTargetsFilterValue;
1223 }
1224 export type AssociationExecutionTargetsFilterKey = "Status"|"ResourceId"|"ResourceType"|string;
1225 export type AssociationExecutionTargetsFilterList = AssociationExecutionTargetsFilter[];
1226 export type AssociationExecutionTargetsFilterValue = string;
1227 export type AssociationExecutionTargetsList = AssociationExecutionTarget[];
1228 export type AssociationExecutionsList = AssociationExecution[];
1229 export interface AssociationFilter {
1230 /**
1231 * The name of the filter.
1232 */
1233 key: AssociationFilterKey;
1234 /**
1235 * The filter value.
1236 */
1237 value: AssociationFilterValue;
1238 }
1239 export type AssociationFilterKey = "InstanceId"|"Name"|"AssociationId"|"AssociationStatusName"|"LastExecutedBefore"|"LastExecutedAfter"|"AssociationName"|string;
1240 export type AssociationFilterList = AssociationFilter[];
1241 export type AssociationFilterOperatorType = "EQUAL"|"LESS_THAN"|"GREATER_THAN"|string;
1242 export type AssociationFilterValue = string;
1243 export type AssociationId = string;
1244 export type AssociationIdList = AssociationId[];
1245 export type AssociationList = Association[];
1246 export type AssociationName = string;
1247 export interface AssociationOverview {
1248 /**
1249 * The status of the association. Status can be: Pending, Success, or Failed.
1250 */
1251 Status?: StatusName;
1252 /**
1253 * A detailed status of the association.
1254 */
1255 DetailedStatus?: StatusName;
1256 /**
1257 * Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.
1258 */
1259 AssociationStatusAggregatedCount?: AssociationStatusAggregatedCount;
1260 }
1261 export type AssociationResourceId = string;
1262 export type AssociationResourceType = string;
1263 export interface AssociationStatus {
1264 /**
1265 * The date when the status changed.
1266 */
1267 Date: DateTime;
1268 /**
1269 * The status.
1270 */
1271 Name: AssociationStatusName;
1272 /**
1273 * The reason for the status.
1274 */
1275 Message: StatusMessage;
1276 /**
1277 * A user-defined string.
1278 */
1279 AdditionalInfo?: StatusAdditionalInfo;
1280 }
1281 export type AssociationStatusAggregatedCount = {[key: string]: InstanceCount};
1282 export type AssociationStatusName = "Pending"|"Success"|"Failed"|string;
1283 export type AssociationVersion = string;
1284 export interface AssociationVersionInfo {
1285 /**
1286 * The ID created by the system when the association was created.
1287 */
1288 AssociationId?: AssociationId;
1289 /**
1290 * The association version.
1291 */
1292 AssociationVersion?: AssociationVersion;
1293 /**
1294 * The date the association version was created.
1295 */
1296 CreatedDate?: DateTime;
1297 /**
1298 * The name specified when the association was created.
1299 */
1300 Name?: DocumentARN;
1301 /**
1302 * The version of a Systems Manager document used when the association version was created.
1303 */
1304 DocumentVersion?: DocumentVersion;
1305 /**
1306 * Parameters specified when the association version was created.
1307 */
1308 Parameters?: Parameters;
1309 /**
1310 * The targets specified for the association when the association version was created.
1311 */
1312 Targets?: Targets;
1313 /**
1314 * The cron or rate schedule specified for the association when the association version was created.
1315 */
1316 ScheduleExpression?: ScheduleExpression;
1317 /**
1318 * The location in Amazon S3 specified for the association when the association version was created.
1319 */
1320 OutputLocation?: InstanceAssociationOutputLocation;
1321 /**
1322 * The name specified for the association version when the association version was created.
1323 */
1324 AssociationName?: AssociationName;
1325 /**
1326 * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
1327 */
1328 MaxErrors?: MaxErrors;
1329 /**
1330 * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
1331 */
1332 MaxConcurrency?: MaxConcurrency;
1333 /**
1334 * The severity level that is assigned to the association.
1335 */
1336 ComplianceSeverity?: AssociationComplianceSeverity;
1337 }
1338 export type AssociationVersionList = AssociationVersionInfo[];
1339 export interface AttachmentContent {
1340 /**
1341 * The name of an attachment.
1342 */
1343 Name?: AttachmentName;
1344 /**
1345 * The size of an attachment in bytes.
1346 */
1347 Size?: ContentLength;
1348 /**
1349 * The cryptographic hash value of the document content.
1350 */
1351 Hash?: AttachmentHash;
1352 /**
1353 * The hash algorithm used to calculate the hash value.
1354 */
1355 HashType?: AttachmentHashType;
1356 /**
1357 * The URL location of the attachment content.
1358 */
1359 Url?: AttachmentUrl;
1360 }
1361 export type AttachmentContentList = AttachmentContent[];
1362 export type AttachmentHash = string;
1363 export type AttachmentHashType = "Sha256"|string;
1364 export interface AttachmentInformation {
1365 /**
1366 * The name of the attachment.
1367 */
1368 Name?: AttachmentName;
1369 }
1370 export type AttachmentInformationList = AttachmentInformation[];
1371 export type AttachmentName = string;
1372 export type AttachmentUrl = string;
1373 export interface AttachmentsSource {
1374 /**
1375 * The key of a key and value pair that identifies the location of an attachment to a document.
1376 */
1377 Key?: AttachmentsSourceKey;
1378 /**
1379 * The URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.
1380 */
1381 Values?: AttachmentsSourceValues;
1382 }
1383 export type AttachmentsSourceKey = "SourceUrl"|string;
1384 export type AttachmentsSourceList = AttachmentsSource[];
1385 export type AttachmentsSourceValue = string;
1386 export type AttachmentsSourceValues = AttachmentsSourceValue[];
1387 export type AttributeName = string;
1388 export type AttributeValue = string;
1389 export type AutomationActionName = string;
1390 export interface AutomationExecution {
1391 /**
1392 * The execution ID.
1393 */
1394 AutomationExecutionId?: AutomationExecutionId;
1395 /**
1396 * The name of the Automation document used during the execution.
1397 */
1398 DocumentName?: DocumentName;
1399 /**
1400 * The version of the document to use during execution.
1401 */
1402 DocumentVersion?: DocumentVersion;
1403 /**
1404 * The time the execution started.
1405 */
1406 ExecutionStartTime?: DateTime;
1407 /**
1408 * The time the execution finished.
1409 */
1410 ExecutionEndTime?: DateTime;
1411 /**
1412 * The execution status of the Automation.
1413 */
1414 AutomationExecutionStatus?: AutomationExecutionStatus;
1415 /**
1416 * A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.
1417 */
1418 StepExecutions?: StepExecutionList;
1419 /**
1420 * A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.
1421 */
1422 StepExecutionsTruncated?: Boolean;
1423 /**
1424 * The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
1425 */
1426 Parameters?: AutomationParameterMap;
1427 /**
1428 * The list of execution outputs as defined in the automation document.
1429 */
1430 Outputs?: AutomationParameterMap;
1431 /**
1432 * A message describing why an execution has failed, if the status is set to Failed.
1433 */
1434 FailureMessage?: String;
1435 /**
1436 * The automation execution mode.
1437 */
1438 Mode?: ExecutionMode;
1439 /**
1440 * The AutomationExecutionId of the parent automation.
1441 */
1442 ParentAutomationExecutionId?: AutomationExecutionId;
1443 /**
1444 * The Amazon Resource Name (ARN) of the user who executed the automation.
1445 */
1446 ExecutedBy?: String;
1447 /**
1448 * The name of the currently executing step.
1449 */
1450 CurrentStepName?: String;
1451 /**
1452 * The action of the currently executing step.
1453 */
1454 CurrentAction?: String;
1455 /**
1456 * The parameter name.
1457 */
1458 TargetParameterName?: AutomationParameterKey;
1459 /**
1460 * The specified targets.
1461 */
1462 Targets?: Targets;
1463 /**
1464 * The specified key-value mapping of document parameters to target resources.
1465 */
1466 TargetMaps?: TargetMaps;
1467 /**
1468 * A list of resolved targets in the rate control execution.
1469 */
1470 ResolvedTargets?: ResolvedTargets;
1471 /**
1472 * The MaxConcurrency value specified by the user when the execution started.
1473 */
1474 MaxConcurrency?: MaxConcurrency;
1475 /**
1476 * The MaxErrors value specified by the user when the execution started.
1477 */
1478 MaxErrors?: MaxErrors;
1479 /**
1480 * The target of the execution.
1481 */
1482 Target?: String;
1483 /**
1484 * The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.
1485 */
1486 TargetLocations?: TargetLocations;
1487 /**
1488 * An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
1489 */
1490 ProgressCounters?: ProgressCounters;
1491 }
1492 export interface AutomationExecutionFilter {
1493 /**
1494 * One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.
1495 */
1496 Key: AutomationExecutionFilterKey;
1497 /**
1498 * The values used to limit the execution information associated with the filter's key.
1499 */
1500 Values: AutomationExecutionFilterValueList;
1501 }
1502 export type AutomationExecutionFilterKey = "DocumentNamePrefix"|"ExecutionStatus"|"ExecutionId"|"ParentExecutionId"|"CurrentAction"|"StartTimeBefore"|"StartTimeAfter"|"AutomationType"|string;
1503 export type AutomationExecutionFilterList = AutomationExecutionFilter[];
1504 export type AutomationExecutionFilterValue = string;
1505 export type AutomationExecutionFilterValueList = AutomationExecutionFilterValue[];
1506 export type AutomationExecutionId = string;
1507 export interface AutomationExecutionMetadata {
1508 /**
1509 * The execution ID.
1510 */
1511 AutomationExecutionId?: AutomationExecutionId;
1512 /**
1513 * The name of the Automation document used during execution.
1514 */
1515 DocumentName?: DocumentName;
1516 /**
1517 * The document version used during the execution.
1518 */
1519 DocumentVersion?: DocumentVersion;
1520 /**
1521 * The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
1522 */
1523 AutomationExecutionStatus?: AutomationExecutionStatus;
1524 /**
1525 * The time the execution started.&gt;
1526 */
1527 ExecutionStartTime?: DateTime;
1528 /**
1529 * The time the execution finished. This is not populated if the execution is still in progress.
1530 */
1531 ExecutionEndTime?: DateTime;
1532 /**
1533 * The IAM role ARN of the user who executed the Automation.
1534 */
1535 ExecutedBy?: String;
1536 /**
1537 * An Amazon S3 bucket where execution information is stored.
1538 */
1539 LogFile?: String;
1540 /**
1541 * The list of execution outputs as defined in the Automation document.
1542 */
1543 Outputs?: AutomationParameterMap;
1544 /**
1545 * The Automation execution mode.
1546 */
1547 Mode?: ExecutionMode;
1548 /**
1549 * The ExecutionId of the parent Automation.
1550 */
1551 ParentAutomationExecutionId?: AutomationExecutionId;
1552 /**
1553 * The name of the currently executing step.
1554 */
1555 CurrentStepName?: String;
1556 /**
1557 * The action of the currently executing step.
1558 */
1559 CurrentAction?: String;
1560 /**
1561 * The list of execution outputs as defined in the Automation document.
1562 */
1563 FailureMessage?: String;
1564 /**
1565 * The list of execution outputs as defined in the Automation document.
1566 */
1567 TargetParameterName?: AutomationParameterKey;
1568 /**
1569 * The targets defined by the user when starting the Automation.
1570 */
1571 Targets?: Targets;
1572 /**
1573 * The specified key-value mapping of document parameters to target resources.
1574 */
1575 TargetMaps?: TargetMaps;
1576 /**
1577 * A list of targets that resolved during the execution.
1578 */
1579 ResolvedTargets?: ResolvedTargets;
1580 /**
1581 * The MaxConcurrency value specified by the user when starting the Automation.
1582 */
1583 MaxConcurrency?: MaxConcurrency;
1584 /**
1585 * The MaxErrors value specified by the user when starting the Automation.
1586 */
1587 MaxErrors?: MaxErrors;
1588 /**
1589 * The list of execution outputs as defined in the Automation document.
1590 */
1591 Target?: String;
1592 /**
1593 * Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that executes in multiple AWS Regions and accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
1594 */
1595 AutomationType?: AutomationType;
1596 }
1597 export type AutomationExecutionMetadataList = AutomationExecutionMetadata[];
1598 export type AutomationExecutionStatus = "Pending"|"InProgress"|"Waiting"|"Success"|"TimedOut"|"Cancelling"|"Cancelled"|"Failed"|string;
1599 export type AutomationParameterKey = string;
1600 export type AutomationParameterMap = {[key: string]: AutomationParameterValueList};
1601 export type AutomationParameterValue = string;
1602 export type AutomationParameterValueList = AutomationParameterValue[];
1603 export type AutomationTargetParameterName = string;
1604 export type AutomationType = "CrossAccount"|"Local"|string;
1605 export type BaselineDescription = string;
1606 export type BaselineId = string;
1607 export type BaselineName = string;
1608 export type BatchErrorMessage = string;
1609 export type Boolean = boolean;
1610 export interface CancelCommandRequest {
1611 /**
1612 * The ID of the command you want to cancel.
1613 */
1614 CommandId: CommandId;
1615 /**
1616 * (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
1617 */
1618 InstanceIds?: InstanceIdList;
1619 }
1620 export interface CancelCommandResult {
1621 }
1622 export interface CancelMaintenanceWindowExecutionRequest {
1623 /**
1624 * The ID of the Maintenance Window execution to stop.
1625 */
1626 WindowExecutionId: MaintenanceWindowExecutionId;
1627 }
1628 export interface CancelMaintenanceWindowExecutionResult {
1629 /**
1630 * The ID of the Maintenance Window execution that has been stopped.
1631 */
1632 WindowExecutionId?: MaintenanceWindowExecutionId;
1633 }
1634 export type ClientToken = string;
1635 export type CloudWatchLogGroupName = string;
1636 export interface CloudWatchOutputConfig {
1637 /**
1638 * The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
1639 */
1640 CloudWatchLogGroupName?: CloudWatchLogGroupName;
1641 /**
1642 * Enables Systems Manager to send command output to CloudWatch Logs.
1643 */
1644 CloudWatchOutputEnabled?: CloudWatchOutputEnabled;
1645 }
1646 export type CloudWatchOutputEnabled = boolean;
1647 export interface Command {
1648 /**
1649 * A unique identifier for this command.
1650 */
1651 CommandId?: CommandId;
1652 /**
1653 * The name of the document requested for execution.
1654 */
1655 DocumentName?: DocumentName;
1656 /**
1657 * The SSM document version.
1658 */
1659 DocumentVersion?: DocumentVersion;
1660 /**
1661 * User-specified information about the command, such as a brief description of what the command should do.
1662 */
1663 Comment?: Comment;
1664 /**
1665 * If this time is reached and the command has not already started executing, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
1666 */
1667 ExpiresAfter?: DateTime;
1668 /**
1669 * The parameter values to be inserted in the document when executing the command.
1670 */
1671 Parameters?: Parameters;
1672 /**
1673 * The instance IDs against which this command was requested.
1674 */
1675 InstanceIds?: InstanceIdList;
1676 /**
1677 * An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
1678 */
1679 Targets?: Targets;
1680 /**
1681 * The date and time the command was requested.
1682 */
1683 RequestedDateTime?: DateTime;
1684 /**
1685 * The status of the command.
1686 */
1687 Status?: CommandStatus;
1688 /**
1689 * A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to any instances. In Progress: The command has been sent to at least one instance but has not reached a final state on all instances. Success: The command successfully executed on all invocations. This is a terminal state. Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state. Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state. Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
1690 */
1691 StatusDetails?: StatusDetails;
1692 /**
1693 * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
1694 */
1695 OutputS3Region?: S3Region;
1696 /**
1697 * The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
1698 */
1699 OutputS3BucketName?: S3BucketName;
1700 /**
1701 * The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
1702 */
1703 OutputS3KeyPrefix?: S3KeyPrefix;
1704 /**
1705 * The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.
1706 */
1707 MaxConcurrency?: MaxConcurrency;
1708 /**
1709 * The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Executing Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.
1710 */
1711 MaxErrors?: MaxErrors;
1712 /**
1713 * The number of targets for the command.
1714 */
1715 TargetCount?: TargetCount;
1716 /**
1717 * The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
1718 */
1719 CompletedCount?: CompletedCount;
1720 /**
1721 * The number of targets for which the status is Failed or Execution Timed Out.
1722 */
1723 ErrorCount?: ErrorCount;
1724 /**
1725 * The number of targets for which the status is Delivery Timed Out.
1726 */
1727 DeliveryTimedOutCount?: DeliveryTimedOutCount;
1728 /**
1729 * The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
1730 */
1731 ServiceRole?: ServiceRole;
1732 /**
1733 * Configurations for sending notifications about command status changes.
1734 */
1735 NotificationConfig?: NotificationConfig;
1736 /**
1737 * CloudWatch Logs information where you want Systems Manager to send the command output.
1738 */
1739 CloudWatchOutputConfig?: CloudWatchOutputConfig;
1740 }
1741 export interface CommandFilter {
1742 /**
1743 * The name of the filter.
1744 */
1745 key: CommandFilterKey;
1746 /**
1747 * The filter value. Valid values for each filter key are as follows: InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later. InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018. Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include: Pending InProgress Success Cancelled Failed TimedOut Cancelling DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances. ExecutionStage: Specify one of the following values: Executing: Returns a list of command executions that are currently still running. Complete: Returns a list of command executions that have already completed.
1748 */
1749 value: CommandFilterValue;
1750 }
1751 export type CommandFilterKey = "InvokedAfter"|"InvokedBefore"|"Status"|"ExecutionStage"|"DocumentName"|string;
1752 export type CommandFilterList = CommandFilter[];
1753 export type CommandFilterValue = string;
1754 export type CommandId = string;
1755 export interface CommandInvocation {
1756 /**
1757 * The command against which this invocation was requested.
1758 */
1759 CommandId?: CommandId;
1760 /**
1761 * The instance ID in which this invocation was requested.
1762 */
1763 InstanceId?: InstanceId;
1764 /**
1765 * The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.
1766 */
1767 InstanceName?: InstanceTagName;
1768 /**
1769 * User-specified information about the command, such as a brief description of what the command should do.
1770 */
1771 Comment?: Comment;
1772 /**
1773 * The document name that was requested for execution.
1774 */
1775 DocumentName?: DocumentName;
1776 /**
1777 * The SSM document version.
1778 */
1779 DocumentVersion?: DocumentVersion;
1780 /**
1781 * The time and date the request was sent to this instance.
1782 */
1783 RequestedDateTime?: DateTime;
1784 /**
1785 * Whether or not the invocation succeeded, failed, or is pending.
1786 */
1787 Status?: CommandInvocationStatus;
1788 /**
1789 * A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Success: The execution of the command or plugin was successfully completed. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
1790 */
1791 StatusDetails?: StatusDetails;
1792 /**
1793 * Gets the trace output sent by the agent.
1794 */
1795 TraceOutput?: InvocationTraceOutput;
1796 /**
1797 * The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
1798 */
1799 StandardOutputUrl?: Url;
1800 /**
1801 * The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
1802 */
1803 StandardErrorUrl?: Url;
1804 CommandPlugins?: CommandPluginList;
1805 /**
1806 * The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
1807 */
1808 ServiceRole?: ServiceRole;
1809 /**
1810 * Configurations for sending notifications about command status changes on a per instance basis.
1811 */
1812 NotificationConfig?: NotificationConfig;
1813 /**
1814 * CloudWatch Logs information where you want Systems Manager to send the command output.
1815 */
1816 CloudWatchOutputConfig?: CloudWatchOutputConfig;
1817 }
1818 export type CommandInvocationList = CommandInvocation[];
1819 export type CommandInvocationStatus = "Pending"|"InProgress"|"Delayed"|"Success"|"Cancelled"|"TimedOut"|"Failed"|"Cancelling"|string;
1820 export type CommandList = Command[];
1821 export type CommandMaxResults = number;
1822 export interface CommandPlugin {
1823 /**
1824 * The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
1825 */
1826 Name?: CommandPluginName;
1827 /**
1828 * The status of this plugin. You can execute a document with multiple plugins.
1829 */
1830 Status?: CommandPluginStatus;
1831 /**
1832 * A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Success: The execution of the command or plugin was successfully completed. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
1833 */
1834 StatusDetails?: StatusDetails;
1835 /**
1836 * A numeric response code generated after executing the plugin.
1837 */
1838 ResponseCode?: ResponseCode;
1839 /**
1840 * The time the plugin started executing.
1841 */
1842 ResponseStartDateTime?: DateTime;
1843 /**
1844 * The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
1845 */
1846 ResponseFinishDateTime?: DateTime;
1847 /**
1848 * Output of the plugin execution.
1849 */
1850 Output?: CommandPluginOutput;
1851 /**
1852 * The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.
1853 */
1854 StandardOutputUrl?: Url;
1855 /**
1856 * The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.
1857 */
1858 StandardErrorUrl?: Url;
1859 /**
1860 * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
1861 */
1862 OutputS3Region?: S3Region;
1863 /**
1864 * The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript test_folder is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin.
1865 */
1866 OutputS3BucketName?: S3BucketName;
1867 /**
1868 * The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript test_folder is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin.
1869 */
1870 OutputS3KeyPrefix?: S3KeyPrefix;
1871 }
1872 export type CommandPluginList = CommandPlugin[];
1873 export type CommandPluginName = string;
1874 export type CommandPluginOutput = string;
1875 export type CommandPluginStatus = "Pending"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
1876 export type CommandStatus = "Pending"|"InProgress"|"Success"|"Cancelled"|"Failed"|"TimedOut"|"Cancelling"|string;
1877 export type Comment = string;
1878 export type CompletedCount = number;
1879 export type ComplianceExecutionId = string;
1880 export interface ComplianceExecutionSummary {
1881 /**
1882 * The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
1883 */
1884 ExecutionTime: DateTime;
1885 /**
1886 * An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.
1887 */
1888 ExecutionId?: ComplianceExecutionId;
1889 /**
1890 * The type of execution. For example, Command is a valid execution type.
1891 */
1892 ExecutionType?: ComplianceExecutionType;
1893 }
1894 export type ComplianceExecutionType = string;
1895 export type ComplianceFilterValue = string;
1896 export interface ComplianceItem {
1897 /**
1898 * The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.
1899 */
1900 ComplianceType?: ComplianceTypeName;
1901 /**
1902 * The type of resource. ManagedInstance is currently the only supported resource type.
1903 */
1904 ResourceType?: ComplianceResourceType;
1905 /**
1906 * An ID for the resource. For a managed instance, this is the instance ID.
1907 */
1908 ResourceId?: ComplianceResourceId;
1909 /**
1910 * An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.
1911 */
1912 Id?: ComplianceItemId;
1913 /**
1914 * A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.
1915 */
1916 Title?: ComplianceItemTitle;
1917 /**
1918 * The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
1919 */
1920 Status?: ComplianceStatus;
1921 /**
1922 * The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
1923 */
1924 Severity?: ComplianceSeverity;
1925 /**
1926 * A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.
1927 */
1928 ExecutionSummary?: ComplianceExecutionSummary;
1929 /**
1930 * A "Key": "Value" tag combination for the compliance item.
1931 */
1932 Details?: ComplianceItemDetails;
1933 }
1934 export type ComplianceItemContentHash = string;
1935 export type ComplianceItemDetails = {[key: string]: AttributeValue};
1936 export interface ComplianceItemEntry {
1937 /**
1938 * The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.
1939 */
1940 Id?: ComplianceItemId;
1941 /**
1942 * The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.
1943 */
1944 Title?: ComplianceItemTitle;
1945 /**
1946 * The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
1947 */
1948 Severity: ComplianceSeverity;
1949 /**
1950 * The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
1951 */
1952 Status: ComplianceStatus;
1953 /**
1954 * A "Key": "Value" tag combination for the compliance item.
1955 */
1956 Details?: ComplianceItemDetails;
1957 }
1958 export type ComplianceItemEntryList = ComplianceItemEntry[];
1959 export type ComplianceItemId = string;
1960 export type ComplianceItemList = ComplianceItem[];
1961 export type ComplianceItemTitle = string;
1962 export type ComplianceQueryOperatorType = "EQUAL"|"NOT_EQUAL"|"BEGIN_WITH"|"LESS_THAN"|"GREATER_THAN"|string;
1963 export type ComplianceResourceId = string;
1964 export type ComplianceResourceIdList = ComplianceResourceId[];
1965 export type ComplianceResourceType = string;
1966 export type ComplianceResourceTypeList = ComplianceResourceType[];
1967 export type ComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED"|string;
1968 export type ComplianceStatus = "COMPLIANT"|"NON_COMPLIANT"|string;
1969 export interface ComplianceStringFilter {
1970 /**
1971 * The name of the filter.
1972 */
1973 Key?: ComplianceStringFilterKey;
1974 /**
1975 * The value for which to search.
1976 */
1977 Values?: ComplianceStringFilterValueList;
1978 /**
1979 * The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.
1980 */
1981 Type?: ComplianceQueryOperatorType;
1982 }
1983 export type ComplianceStringFilterKey = string;
1984 export type ComplianceStringFilterList = ComplianceStringFilter[];
1985 export type ComplianceStringFilterValueList = ComplianceFilterValue[];
1986 export type ComplianceSummaryCount = number;
1987 export interface ComplianceSummaryItem {
1988 /**
1989 * The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.
1990 */
1991 ComplianceType?: ComplianceTypeName;
1992 /**
1993 * A list of COMPLIANT items for the specified compliance type.
1994 */
1995 CompliantSummary?: CompliantSummary;
1996 /**
1997 * A list of NON_COMPLIANT items for the specified compliance type.
1998 */
1999 NonCompliantSummary?: NonCompliantSummary;
2000 }
2001 export type ComplianceSummaryItemList = ComplianceSummaryItem[];
2002 export type ComplianceTypeName = string;
2003 export interface CompliantSummary {
2004 /**
2005 * The total number of resources that are compliant.
2006 */
2007 CompliantCount?: ComplianceSummaryCount;
2008 /**
2009 * A summary of the compliance severity by compliance type.
2010 */
2011 SeveritySummary?: SeveritySummary;
2012 }
2013 export type ComputerName = string;
2014 export type ConnectionStatus = "Connected"|"NotConnected"|string;
2015 export type ContentLength = number;
2016 export interface CreateActivationRequest {
2017 /**
2018 * A user-defined description of the resource that you want to register with Amazon EC2. Do not enter personally identifiable information in this field.
2019 */
2020 Description?: ActivationDescription;
2021 /**
2022 * The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources. Do not enter personally identifiable information in this field.
2023 */
2024 DefaultInstanceName?: DefaultInstanceName;
2025 /**
2026 * The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.
2027 */
2028 IamRole: IamRole;
2029 /**
2030 * Specify the maximum number of managed instances you want to register. The default value is 1 instance.
2031 */
2032 RegistrationLimit?: RegistrationLimit;
2033 /**
2034 * The date by which this activation request should expire. The default value is 24 hours.
2035 */
2036 ExpirationDate?: ExpirationDate;
2037 /**
2038 * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs: Key=OS,Value=Windows Key=Environment,Value=Production When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs. You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.
2039 */
2040 Tags?: TagList;
2041 }
2042 export interface CreateActivationResult {
2043 /**
2044 * The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
2045 */
2046 ActivationId?: ActivationId;
2047 /**
2048 * The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
2049 */
2050 ActivationCode?: ActivationCode;
2051 }
2052 export interface CreateAssociationBatchRequest {
2053 /**
2054 * One or more associations.
2055 */
2056 Entries: CreateAssociationBatchRequestEntries;
2057 }
2058 export type CreateAssociationBatchRequestEntries = CreateAssociationBatchRequestEntry[];
2059 export interface CreateAssociationBatchRequestEntry {
2060 /**
2061 * The name of the SSM document that contains the configuration information for the instance. You can specify Command, Policy, or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:aws:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
2062 */
2063 Name: DocumentARN;
2064 /**
2065 * The ID of the instance.
2066 */
2067 InstanceId?: InstanceId;
2068 /**
2069 * A description of the parameters for a document.
2070 */
2071 Parameters?: Parameters;
2072 /**
2073 * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
2074 */
2075 AutomationTargetParameterName?: AutomationTargetParameterName;
2076 /**
2077 * The document version.
2078 */
2079 DocumentVersion?: DocumentVersion;
2080 /**
2081 * The instances targeted by the request.
2082 */
2083 Targets?: Targets;
2084 /**
2085 * A cron expression that specifies a schedule when the association runs.
2086 */
2087 ScheduleExpression?: ScheduleExpression;
2088 /**
2089 * An Amazon S3 bucket where you want to store the results of this request.
2090 */
2091 OutputLocation?: InstanceAssociationOutputLocation;
2092 /**
2093 * Specify a descriptive name for the association.
2094 */
2095 AssociationName?: AssociationName;
2096 /**
2097 * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
2098 */
2099 MaxErrors?: MaxErrors;
2100 /**
2101 * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
2102 */
2103 MaxConcurrency?: MaxConcurrency;
2104 /**
2105 * The severity level to assign to the association.
2106 */
2107 ComplianceSeverity?: AssociationComplianceSeverity;
2108 }
2109 export interface CreateAssociationBatchResult {
2110 /**
2111 * Information about the associations that succeeded.
2112 */
2113 Successful?: AssociationDescriptionList;
2114 /**
2115 * Information about the associations that failed.
2116 */
2117 Failed?: FailedCreateAssociationList;
2118 }
2119 export interface CreateAssociationRequest {
2120 /**
2121 * The name of the SSM document that contains the configuration information for the instance. You can specify Command, Policy, or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:partition:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
2122 */
2123 Name: DocumentARN;
2124 /**
2125 * The document version you want to associate with the target(s). Can be a specific version or the default version.
2126 */
2127 DocumentVersion?: DocumentVersion;
2128 /**
2129 * The instance ID.
2130 */
2131 InstanceId?: InstanceId;
2132 /**
2133 * The parameters for the documents runtime configuration.
2134 */
2135 Parameters?: Parameters;
2136 /**
2137 * The targets (either instances or tags) for the association.
2138 */
2139 Targets?: Targets;
2140 /**
2141 * A cron expression when the association will be applied to the target(s).
2142 */
2143 ScheduleExpression?: ScheduleExpression;
2144 /**
2145 * An Amazon S3 bucket where you want to store the output details of the request.
2146 */
2147 OutputLocation?: InstanceAssociationOutputLocation;
2148 /**
2149 * Specify a descriptive name for the association.
2150 */
2151 AssociationName?: AssociationName;
2152 /**
2153 * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
2154 */
2155 AutomationTargetParameterName?: AutomationTargetParameterName;
2156 /**
2157 * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
2158 */
2159 MaxErrors?: MaxErrors;
2160 /**
2161 * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
2162 */
2163 MaxConcurrency?: MaxConcurrency;
2164 /**
2165 * The severity level to assign to the association.
2166 */
2167 ComplianceSeverity?: AssociationComplianceSeverity;
2168 }
2169 export interface CreateAssociationResult {
2170 /**
2171 * Information about the association.
2172 */
2173 AssociationDescription?: AssociationDescription;
2174 }
2175 export interface CreateDocumentRequest {
2176 /**
2177 * A valid JSON or YAML string.
2178 */
2179 Content: DocumentContent;
2180 /**
2181 * A list of key and value pairs that describe attachments to a version of a document.
2182 */
2183 Attachments?: AttachmentsSourceList;
2184 /**
2185 * A name for the Systems Manager document. Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes: aws amazon amzn
2186 */
2187 Name: DocumentName;
2188 /**
2189 * An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
2190 */
2191 VersionName?: DocumentVersionName;
2192 /**
2193 * The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.
2194 */
2195 DocumentType?: DocumentType;
2196 /**
2197 * Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
2198 */
2199 DocumentFormat?: DocumentFormat;
2200 /**
2201 * Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
2202 */
2203 TargetType?: TargetType;
2204 /**
2205 * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs: Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing SSM document, use the AddTagsToResource action.
2206 */
2207 Tags?: TagList;
2208 }
2209 export interface CreateDocumentResult {
2210 /**
2211 * Information about the Systems Manager document.
2212 */
2213 DocumentDescription?: DocumentDescription;
2214 }
2215 export interface CreateMaintenanceWindowRequest {
2216 /**
2217 * The name of the Maintenance Window.
2218 */
2219 Name: MaintenanceWindowName;
2220 /**
2221 * An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows.
2222 */
2223 Description?: MaintenanceWindowDescription;
2224 /**
2225 * The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date.
2226 */
2227 StartDate?: MaintenanceWindowStringDateTime;
2228 /**
2229 * The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive. EndDate allows you to set a date and time in the future when the Maintenance Window will no longer run.
2230 */
2231 EndDate?: MaintenanceWindowStringDateTime;
2232 /**
2233 * The schedule of the Maintenance Window in the form of a cron or rate expression.
2234 */
2235 Schedule: MaintenanceWindowSchedule;
2236 /**
2237 * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
2238 */
2239 ScheduleTimezone?: MaintenanceWindowTimezone;
2240 /**
2241 * The duration of the Maintenance Window in hours.
2242 */
2243 Duration: MaintenanceWindowDurationHours;
2244 /**
2245 * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
2246 */
2247 Cutoff: MaintenanceWindowCutoff;
2248 /**
2249 * Enables a Maintenance Window task to execute on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window.
2250 */
2251 AllowUnassociatedTargets: MaintenanceWindowAllowUnassociatedTargets;
2252 /**
2253 * User-provided idempotency token.
2254 */
2255 ClientToken?: ClientToken;
2256 /**
2257 * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Maintenance Window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs: Key=TaskType,Value=AgentUpdate Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing Maintenance Window, use the AddTagsToResource action.
2258 */
2259 Tags?: TagList;
2260 }
2261 export interface CreateMaintenanceWindowResult {
2262 /**
2263 * The ID of the created Maintenance Window.
2264 */
2265 WindowId?: MaintenanceWindowId;
2266 }
2267 export interface CreatePatchBaselineRequest {
2268 /**
2269 * Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
2270 */
2271 OperatingSystem?: OperatingSystem;
2272 /**
2273 * The name of the patch baseline.
2274 */
2275 Name: BaselineName;
2276 /**
2277 * A set of global filters used to include patches in the baseline.
2278 */
2279 GlobalFilters?: PatchFilterGroup;
2280 /**
2281 * A set of rules used to include patches in the baseline.
2282 */
2283 ApprovalRules?: PatchRuleGroup;
2284 /**
2285 * A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
2286 */
2287 ApprovedPatches?: PatchIdList;
2288 /**
2289 * Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.
2290 */
2291 ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
2292 /**
2293 * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
2294 */
2295 ApprovedPatchesEnableNonSecurity?: Boolean;
2296 /**
2297 * A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
2298 */
2299 RejectedPatches?: PatchIdList;
2300 /**
2301 * The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
2302 */
2303 RejectedPatchesAction?: PatchAction;
2304 /**
2305 * A description of the patch baseline.
2306 */
2307 Description?: BaselineDescription;
2308 /**
2309 * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
2310 */
2311 Sources?: PatchSourceList;
2312 /**
2313 * User-provided idempotency token.
2314 */
2315 ClientToken?: ClientToken;
2316 /**
2317 * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs: Key=PatchSeverity,Value=Critical Key=OS,Value=Windows To add tags to an existing patch baseline, use the AddTagsToResource action.
2318 */
2319 Tags?: TagList;
2320 }
2321 export interface CreatePatchBaselineResult {
2322 /**
2323 * The ID of the created patch baseline.
2324 */
2325 BaselineId?: BaselineId;
2326 }
2327 export interface CreateResourceDataSyncRequest {
2328 /**
2329 * A name for the configuration.
2330 */
2331 SyncName: ResourceDataSyncName;
2332 /**
2333 * Amazon S3 configuration details for the sync.
2334 */
2335 S3Destination: ResourceDataSyncS3Destination;
2336 }
2337 export interface CreateResourceDataSyncResult {
2338 }
2339 export type CreatedDate = Date;
2340 export type DateTime = Date;
2341 export type DefaultBaseline = boolean;
2342 export type DefaultInstanceName = string;
2343 export interface DeleteActivationRequest {
2344 /**
2345 * The ID of the activation that you want to delete.
2346 */
2347 ActivationId: ActivationId;
2348 }
2349 export interface DeleteActivationResult {
2350 }
2351 export interface DeleteAssociationRequest {
2352 /**
2353 * The name of the Systems Manager document.
2354 */
2355 Name?: DocumentARN;
2356 /**
2357 * The ID of the instance.
2358 */
2359 InstanceId?: InstanceId;
2360 /**
2361 * The association ID that you want to delete.
2362 */
2363 AssociationId?: AssociationId;
2364 }
2365 export interface DeleteAssociationResult {
2366 }
2367 export interface DeleteDocumentRequest {
2368 /**
2369 * The name of the document.
2370 */
2371 Name: DocumentName;
2372 }
2373 export interface DeleteDocumentResult {
2374 }
2375 export interface DeleteInventoryRequest {
2376 /**
2377 * The name of the custom inventory type for which you want to delete either all previously collected data, or the inventory type itself.
2378 */
2379 TypeName: InventoryItemTypeName;
2380 /**
2381 * Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options: DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disbled version. DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
2382 */
2383 SchemaDeleteOption?: InventorySchemaDeleteOption;
2384 /**
2385 * Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.
2386 */
2387 DryRun?: DryRun;
2388 /**
2389 * User-provided idempotency token.
2390 */
2391 ClientToken?: ClientToken;
2392 }
2393 export interface DeleteInventoryResult {
2394 /**
2395 * Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.
2396 */
2397 DeletionId?: InventoryDeletionId;
2398 /**
2399 * The name of the inventory data type specified in the request.
2400 */
2401 TypeName?: InventoryItemTypeName;
2402 /**
2403 * A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.
2404 */
2405 DeletionSummary?: InventoryDeletionSummary;
2406 }
2407 export interface DeleteMaintenanceWindowRequest {
2408 /**
2409 * The ID of the Maintenance Window to delete.
2410 */
2411 WindowId: MaintenanceWindowId;
2412 }
2413 export interface DeleteMaintenanceWindowResult {
2414 /**
2415 * The ID of the deleted Maintenance Window.
2416 */
2417 WindowId?: MaintenanceWindowId;
2418 }
2419 export interface DeleteParameterRequest {
2420 /**
2421 * The name of the parameter to delete.
2422 */
2423 Name: PSParameterName;
2424 }
2425 export interface DeleteParameterResult {
2426 }
2427 export interface DeleteParametersRequest {
2428 /**
2429 * The names of the parameters to delete.
2430 */
2431 Names: ParameterNameList;
2432 }
2433 export interface DeleteParametersResult {
2434 /**
2435 * The names of the deleted parameters.
2436 */
2437 DeletedParameters?: ParameterNameList;
2438 /**
2439 * The names of parameters that weren't deleted because the parameters are not valid.
2440 */
2441 InvalidParameters?: ParameterNameList;
2442 }
2443 export interface DeletePatchBaselineRequest {
2444 /**
2445 * The ID of the patch baseline to delete.
2446 */
2447 BaselineId: BaselineId;
2448 }
2449 export interface DeletePatchBaselineResult {
2450 /**
2451 * The ID of the deleted patch baseline.
2452 */
2453 BaselineId?: BaselineId;
2454 }
2455 export interface DeleteResourceDataSyncRequest {
2456 /**
2457 * The name of the configuration to delete.
2458 */
2459 SyncName: ResourceDataSyncName;
2460 }
2461 export interface DeleteResourceDataSyncResult {
2462 }
2463 export type DeliveryTimedOutCount = number;
2464 export interface DeregisterManagedInstanceRequest {
2465 /**
2466 * The ID assigned to the managed instance when you registered it using the activation process.
2467 */
2468 InstanceId: ManagedInstanceId;
2469 }
2470 export interface DeregisterManagedInstanceResult {
2471 }
2472 export interface DeregisterPatchBaselineForPatchGroupRequest {
2473 /**
2474 * The ID of the patch baseline to deregister the patch group from.
2475 */
2476 BaselineId: BaselineId;
2477 /**
2478 * The name of the patch group that should be deregistered from the patch baseline.
2479 */
2480 PatchGroup: PatchGroup;
2481 }
2482 export interface DeregisterPatchBaselineForPatchGroupResult {
2483 /**
2484 * The ID of the patch baseline the patch group was deregistered from.
2485 */
2486 BaselineId?: BaselineId;
2487 /**
2488 * The name of the patch group deregistered from the patch baseline.
2489 */
2490 PatchGroup?: PatchGroup;
2491 }
2492 export interface DeregisterTargetFromMaintenanceWindowRequest {
2493 /**
2494 * The ID of the Maintenance Window the target should be removed from.
2495 */
2496 WindowId: MaintenanceWindowId;
2497 /**
2498 * The ID of the target definition to remove.
2499 */
2500 WindowTargetId: MaintenanceWindowTargetId;
2501 /**
2502 * The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the Maintenance Window.
2503 */
2504 Safe?: Boolean;
2505 }
2506 export interface DeregisterTargetFromMaintenanceWindowResult {
2507 /**
2508 * The ID of the Maintenance Window the target was removed from.
2509 */
2510 WindowId?: MaintenanceWindowId;
2511 /**
2512 * The ID of the removed target definition.
2513 */
2514 WindowTargetId?: MaintenanceWindowTargetId;
2515 }
2516 export interface DeregisterTaskFromMaintenanceWindowRequest {
2517 /**
2518 * The ID of the Maintenance Window the task should be removed from.
2519 */
2520 WindowId: MaintenanceWindowId;
2521 /**
2522 * The ID of the task to remove from the Maintenance Window.
2523 */
2524 WindowTaskId: MaintenanceWindowTaskId;
2525 }
2526 export interface DeregisterTaskFromMaintenanceWindowResult {
2527 /**
2528 * The ID of the Maintenance Window the task was removed from.
2529 */
2530 WindowId?: MaintenanceWindowId;
2531 /**
2532 * The ID of the task removed from the Maintenance Window.
2533 */
2534 WindowTaskId?: MaintenanceWindowTaskId;
2535 }
2536 export interface DescribeActivationsFilter {
2537 /**
2538 * The name of the filter.
2539 */
2540 FilterKey?: DescribeActivationsFilterKeys;
2541 /**
2542 * The filter values.
2543 */
2544 FilterValues?: StringList;
2545 }
2546 export type DescribeActivationsFilterKeys = "ActivationIds"|"DefaultInstanceName"|"IamRole"|string;
2547 export type DescribeActivationsFilterList = DescribeActivationsFilter[];
2548 export interface DescribeActivationsRequest {
2549 /**
2550 * A filter to view information about your activations.
2551 */
2552 Filters?: DescribeActivationsFilterList;
2553 /**
2554 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2555 */
2556 MaxResults?: MaxResults;
2557 /**
2558 * A token to start the list. Use this token to get the next set of results.
2559 */
2560 NextToken?: NextToken;
2561 }
2562 export interface DescribeActivationsResult {
2563 /**
2564 * A list of activations for your AWS account.
2565 */
2566 ActivationList?: ActivationList;
2567 /**
2568 * The token for the next set of items to return. Use this token to get the next set of results.
2569 */
2570 NextToken?: NextToken;
2571 }
2572 export interface DescribeAssociationExecutionTargetsRequest {
2573 /**
2574 * The association ID that includes the execution for which you want to view details.
2575 */
2576 AssociationId: AssociationId;
2577 /**
2578 * The execution ID for which you want to view details.
2579 */
2580 ExecutionId: AssociationExecutionId;
2581 /**
2582 * Filters for the request. You can specify the following filters and values. Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL)
2583 */
2584 Filters?: AssociationExecutionTargetsFilterList;
2585 /**
2586 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2587 */
2588 MaxResults?: MaxResults;
2589 /**
2590 * A token to start the list. Use this token to get the next set of results.
2591 */
2592 NextToken?: NextToken;
2593 }
2594 export interface DescribeAssociationExecutionTargetsResult {
2595 /**
2596 * Information about the execution.
2597 */
2598 AssociationExecutionTargets?: AssociationExecutionTargetsList;
2599 /**
2600 * The token for the next set of items to return. Use this token to get the next set of results.
2601 */
2602 NextToken?: NextToken;
2603 }
2604 export interface DescribeAssociationExecutionsRequest {
2605 /**
2606 * The association ID for which you want to view execution history details.
2607 */
2608 AssociationId: AssociationId;
2609 /**
2610 * Filters for the request. You can specify the following filters and values. ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
2611 */
2612 Filters?: AssociationExecutionFilterList;
2613 /**
2614 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2615 */
2616 MaxResults?: MaxResults;
2617 /**
2618 * A token to start the list. Use this token to get the next set of results.
2619 */
2620 NextToken?: NextToken;
2621 }
2622 export interface DescribeAssociationExecutionsResult {
2623 /**
2624 * A list of the executions for the specified association ID.
2625 */
2626 AssociationExecutions?: AssociationExecutionsList;
2627 /**
2628 * The token for the next set of items to return. Use this token to get the next set of results.
2629 */
2630 NextToken?: NextToken;
2631 }
2632 export interface DescribeAssociationRequest {
2633 /**
2634 * The name of the Systems Manager document.
2635 */
2636 Name?: DocumentARN;
2637 /**
2638 * The instance ID.
2639 */
2640 InstanceId?: InstanceId;
2641 /**
2642 * The association ID for which you want information.
2643 */
2644 AssociationId?: AssociationId;
2645 /**
2646 * Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.
2647 */
2648 AssociationVersion?: AssociationVersion;
2649 }
2650 export interface DescribeAssociationResult {
2651 /**
2652 * Information about the association.
2653 */
2654 AssociationDescription?: AssociationDescription;
2655 }
2656 export interface DescribeAutomationExecutionsRequest {
2657 /**
2658 * Filters used to limit the scope of executions that are requested.
2659 */
2660 Filters?: AutomationExecutionFilterList;
2661 /**
2662 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2663 */
2664 MaxResults?: MaxResults;
2665 /**
2666 * The token for the next set of items to return. (You received this token from a previous call.)
2667 */
2668 NextToken?: NextToken;
2669 }
2670 export interface DescribeAutomationExecutionsResult {
2671 /**
2672 * The list of details about each automation execution which has occurred which matches the filter specification, if any.
2673 */
2674 AutomationExecutionMetadataList?: AutomationExecutionMetadataList;
2675 /**
2676 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2677 */
2678 NextToken?: NextToken;
2679 }
2680 export interface DescribeAutomationStepExecutionsRequest {
2681 /**
2682 * The Automation execution ID for which you want step execution descriptions.
2683 */
2684 AutomationExecutionId: AutomationExecutionId;
2685 /**
2686 * One or more filters to limit the number of step executions returned by the request.
2687 */
2688 Filters?: StepExecutionFilterList;
2689 /**
2690 * The token for the next set of items to return. (You received this token from a previous call.)
2691 */
2692 NextToken?: NextToken;
2693 /**
2694 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2695 */
2696 MaxResults?: MaxResults;
2697 /**
2698 * A boolean that indicates whether to list step executions in reverse order by start time. The default value is false.
2699 */
2700 ReverseOrder?: Boolean;
2701 }
2702 export interface DescribeAutomationStepExecutionsResult {
2703 /**
2704 * A list of details about the current state of all steps that make up an execution.
2705 */
2706 StepExecutions?: StepExecutionList;
2707 /**
2708 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2709 */
2710 NextToken?: NextToken;
2711 }
2712 export interface DescribeAvailablePatchesRequest {
2713 /**
2714 * Filters used to scope down the returned patches.
2715 */
2716 Filters?: PatchOrchestratorFilterList;
2717 /**
2718 * The maximum number of patches to return (per page).
2719 */
2720 MaxResults?: PatchBaselineMaxResults;
2721 /**
2722 * The token for the next set of items to return. (You received this token from a previous call.)
2723 */
2724 NextToken?: NextToken;
2725 }
2726 export interface DescribeAvailablePatchesResult {
2727 /**
2728 * An array of patches. Each entry in the array is a patch structure.
2729 */
2730 Patches?: PatchList;
2731 /**
2732 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2733 */
2734 NextToken?: NextToken;
2735 }
2736 export interface DescribeDocumentPermissionRequest {
2737 /**
2738 * The name of the document for which you are the owner.
2739 */
2740 Name: DocumentName;
2741 /**
2742 * The permission type for the document. The permission type can be Share.
2743 */
2744 PermissionType: DocumentPermissionType;
2745 }
2746 export interface DescribeDocumentPermissionResponse {
2747 /**
2748 * The account IDs that have permission to use this document. The ID can be either an AWS account or All.
2749 */
2750 AccountIds?: AccountIdList;
2751 }
2752 export interface DescribeDocumentRequest {
2753 /**
2754 * The name of the Systems Manager document.
2755 */
2756 Name: DocumentARN;
2757 /**
2758 * The document version for which you want information. Can be a specific version or the default version.
2759 */
2760 DocumentVersion?: DocumentVersion;
2761 /**
2762 * An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
2763 */
2764 VersionName?: DocumentVersionName;
2765 }
2766 export interface DescribeDocumentResult {
2767 /**
2768 * Information about the Systems Manager document.
2769 */
2770 Document?: DocumentDescription;
2771 }
2772 export interface DescribeEffectiveInstanceAssociationsRequest {
2773 /**
2774 * The instance ID for which you want to view all associations.
2775 */
2776 InstanceId: InstanceId;
2777 /**
2778 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2779 */
2780 MaxResults?: EffectiveInstanceAssociationMaxResults;
2781 /**
2782 * The token for the next set of items to return. (You received this token from a previous call.)
2783 */
2784 NextToken?: NextToken;
2785 }
2786 export interface DescribeEffectiveInstanceAssociationsResult {
2787 /**
2788 * The associations for the requested instance.
2789 */
2790 Associations?: InstanceAssociationList;
2791 /**
2792 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2793 */
2794 NextToken?: NextToken;
2795 }
2796 export interface DescribeEffectivePatchesForPatchBaselineRequest {
2797 /**
2798 * The ID of the patch baseline to retrieve the effective patches for.
2799 */
2800 BaselineId: BaselineId;
2801 /**
2802 * The maximum number of patches to return (per page).
2803 */
2804 MaxResults?: PatchBaselineMaxResults;
2805 /**
2806 * The token for the next set of items to return. (You received this token from a previous call.)
2807 */
2808 NextToken?: NextToken;
2809 }
2810 export interface DescribeEffectivePatchesForPatchBaselineResult {
2811 /**
2812 * An array of patches and patch status.
2813 */
2814 EffectivePatches?: EffectivePatchList;
2815 /**
2816 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2817 */
2818 NextToken?: NextToken;
2819 }
2820 export interface DescribeInstanceAssociationsStatusRequest {
2821 /**
2822 * The instance IDs for which you want association status information.
2823 */
2824 InstanceId: InstanceId;
2825 /**
2826 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2827 */
2828 MaxResults?: MaxResults;
2829 /**
2830 * The token for the next set of items to return. (You received this token from a previous call.)
2831 */
2832 NextToken?: NextToken;
2833 }
2834 export interface DescribeInstanceAssociationsStatusResult {
2835 /**
2836 * Status information about the association.
2837 */
2838 InstanceAssociationStatusInfos?: InstanceAssociationStatusInfos;
2839 /**
2840 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2841 */
2842 NextToken?: NextToken;
2843 }
2844 export interface DescribeInstanceInformationRequest {
2845 /**
2846 * This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping. If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes an exception error.
2847 */
2848 InstanceInformationFilterList?: InstanceInformationFilterList;
2849 /**
2850 * One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.
2851 */
2852 Filters?: InstanceInformationStringFilterList;
2853 /**
2854 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2855 */
2856 MaxResults?: MaxResultsEC2Compatible;
2857 /**
2858 * The token for the next set of items to return. (You received this token from a previous call.)
2859 */
2860 NextToken?: NextToken;
2861 }
2862 export interface DescribeInstanceInformationResult {
2863 /**
2864 * The instance information list.
2865 */
2866 InstanceInformationList?: InstanceInformationList;
2867 /**
2868 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2869 */
2870 NextToken?: NextToken;
2871 }
2872 export interface DescribeInstancePatchStatesForPatchGroupRequest {
2873 /**
2874 * The name of the patch group for which the patch state information should be retrieved.
2875 */
2876 PatchGroup: PatchGroup;
2877 /**
2878 * Each entry in the array is a structure containing: Key (string between 1 and 200 characters) Values (array containing a single string) Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
2879 */
2880 Filters?: InstancePatchStateFilterList;
2881 /**
2882 * The token for the next set of items to return. (You received this token from a previous call.)
2883 */
2884 NextToken?: NextToken;
2885 /**
2886 * The maximum number of patches to return (per page).
2887 */
2888 MaxResults?: PatchComplianceMaxResults;
2889 }
2890 export interface DescribeInstancePatchStatesForPatchGroupResult {
2891 /**
2892 * The high-level patch state for the requested instances.
2893 */
2894 InstancePatchStates?: InstancePatchStatesList;
2895 /**
2896 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2897 */
2898 NextToken?: NextToken;
2899 }
2900 export interface DescribeInstancePatchStatesRequest {
2901 /**
2902 * The ID of the instance whose patch state information should be retrieved.
2903 */
2904 InstanceIds: InstanceIdList;
2905 /**
2906 * The token for the next set of items to return. (You received this token from a previous call.)
2907 */
2908 NextToken?: NextToken;
2909 /**
2910 * The maximum number of instances to return (per page).
2911 */
2912 MaxResults?: PatchComplianceMaxResults;
2913 }
2914 export interface DescribeInstancePatchStatesResult {
2915 /**
2916 * The high-level patch state for the requested instances.
2917 */
2918 InstancePatchStates?: InstancePatchStateList;
2919 /**
2920 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2921 */
2922 NextToken?: NextToken;
2923 }
2924 export interface DescribeInstancePatchesRequest {
2925 /**
2926 * The ID of the instance whose patch state information should be retrieved.
2927 */
2928 InstanceId: InstanceId;
2929 /**
2930 * Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string between 1 and 256 characters)
2931 */
2932 Filters?: PatchOrchestratorFilterList;
2933 /**
2934 * The token for the next set of items to return. (You received this token from a previous call.)
2935 */
2936 NextToken?: NextToken;
2937 /**
2938 * The maximum number of patches to return (per page).
2939 */
2940 MaxResults?: PatchComplianceMaxResults;
2941 }
2942 export interface DescribeInstancePatchesResult {
2943 /**
2944 * Each entry in the array is a structure containing: Title (string) KBId (string) Classification (string) Severity (string) State (string, such as "INSTALLED" or "FAILED") InstalledTime (DateTime) InstalledBy (string)
2945 */
2946 Patches?: PatchComplianceDataList;
2947 /**
2948 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
2949 */
2950 NextToken?: NextToken;
2951 }
2952 export interface DescribeInventoryDeletionsRequest {
2953 /**
2954 * Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.
2955 */
2956 DeletionId?: InventoryDeletionId;
2957 /**
2958 * A token to start the list. Use this token to get the next set of results.
2959 */
2960 NextToken?: NextToken;
2961 /**
2962 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2963 */
2964 MaxResults?: MaxResults;
2965 }
2966 export interface DescribeInventoryDeletionsResult {
2967 /**
2968 * A list of status items for deleted inventory.
2969 */
2970 InventoryDeletions?: InventoryDeletionsList;
2971 /**
2972 * The token for the next set of items to return. Use this token to get the next set of results.
2973 */
2974 NextToken?: NextToken;
2975 }
2976 export interface DescribeMaintenanceWindowExecutionTaskInvocationsRequest {
2977 /**
2978 * The ID of the Maintenance Window execution the task is part of.
2979 */
2980 WindowExecutionId: MaintenanceWindowExecutionId;
2981 /**
2982 * The ID of the specific task in the Maintenance Window task that should be retrieved.
2983 */
2984 TaskId: MaintenanceWindowExecutionTaskId;
2985 /**
2986 * Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
2987 */
2988 Filters?: MaintenanceWindowFilterList;
2989 /**
2990 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
2991 */
2992 MaxResults?: MaintenanceWindowMaxResults;
2993 /**
2994 * The token for the next set of items to return. (You received this token from a previous call.)
2995 */
2996 NextToken?: NextToken;
2997 }
2998 export interface DescribeMaintenanceWindowExecutionTaskInvocationsResult {
2999 /**
3000 * Information about the task invocation results per invocation.
3001 */
3002 WindowExecutionTaskInvocationIdentities?: MaintenanceWindowExecutionTaskInvocationIdentityList;
3003 /**
3004 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3005 */
3006 NextToken?: NextToken;
3007 }
3008 export interface DescribeMaintenanceWindowExecutionTasksRequest {
3009 /**
3010 * The ID of the Maintenance Window execution whose task executions should be retrieved.
3011 */
3012 WindowExecutionId: MaintenanceWindowExecutionId;
3013 /**
3014 * Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
3015 */
3016 Filters?: MaintenanceWindowFilterList;
3017 /**
3018 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3019 */
3020 MaxResults?: MaintenanceWindowMaxResults;
3021 /**
3022 * The token for the next set of items to return. (You received this token from a previous call.)
3023 */
3024 NextToken?: NextToken;
3025 }
3026 export interface DescribeMaintenanceWindowExecutionTasksResult {
3027 /**
3028 * Information about the task executions.
3029 */
3030 WindowExecutionTaskIdentities?: MaintenanceWindowExecutionTaskIdentityList;
3031 /**
3032 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3033 */
3034 NextToken?: NextToken;
3035 }
3036 export interface DescribeMaintenanceWindowExecutionsRequest {
3037 /**
3038 * The ID of the Maintenance Window whose executions should be retrieved.
3039 */
3040 WindowId: MaintenanceWindowId;
3041 /**
3042 * Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string is between 1 and 256 characters) The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.
3043 */
3044 Filters?: MaintenanceWindowFilterList;
3045 /**
3046 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3047 */
3048 MaxResults?: MaintenanceWindowMaxResults;
3049 /**
3050 * The token for the next set of items to return. (You received this token from a previous call.)
3051 */
3052 NextToken?: NextToken;
3053 }
3054 export interface DescribeMaintenanceWindowExecutionsResult {
3055 /**
3056 * Information about the Maintenance Windows execution.
3057 */
3058 WindowExecutions?: MaintenanceWindowExecutionList;
3059 /**
3060 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3061 */
3062 NextToken?: NextToken;
3063 }
3064 export interface DescribeMaintenanceWindowScheduleRequest {
3065 /**
3066 * The ID of the Maintenance Window to retrieve information about.
3067 */
3068 WindowId?: MaintenanceWindowId;
3069 /**
3070 * The instance ID or key/value pair to retrieve information about.
3071 */
3072 Targets?: Targets;
3073 /**
3074 * The type of resource you want to retrieve information about. For example, "INSTANCE".
3075 */
3076 ResourceType?: MaintenanceWindowResourceType;
3077 /**
3078 * Filters used to limit the range of results. For example, you can limit Maintenance Window executions to only those scheduled before or after a certain date and time.
3079 */
3080 Filters?: PatchOrchestratorFilterList;
3081 /**
3082 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3083 */
3084 MaxResults?: MaintenanceWindowSearchMaxResults;
3085 /**
3086 * The token for the next set of items to return. (You received this token from a previous call.)
3087 */
3088 NextToken?: NextToken;
3089 }
3090 export interface DescribeMaintenanceWindowScheduleResult {
3091 /**
3092 * Information about Maintenance Window executions scheduled for the specified time range.
3093 */
3094 ScheduledWindowExecutions?: ScheduledWindowExecutionList;
3095 /**
3096 * The token for the next set of items to return. (You use this token in the next call.)
3097 */
3098 NextToken?: NextToken;
3099 }
3100 export interface DescribeMaintenanceWindowTargetsRequest {
3101 /**
3102 * The ID of the Maintenance Window whose targets should be retrieved.
3103 */
3104 WindowId: MaintenanceWindowId;
3105 /**
3106 * Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.
3107 */
3108 Filters?: MaintenanceWindowFilterList;
3109 /**
3110 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3111 */
3112 MaxResults?: MaintenanceWindowMaxResults;
3113 /**
3114 * The token for the next set of items to return. (You received this token from a previous call.)
3115 */
3116 NextToken?: NextToken;
3117 }
3118 export interface DescribeMaintenanceWindowTargetsResult {
3119 /**
3120 * Information about the targets in the Maintenance Window.
3121 */
3122 Targets?: MaintenanceWindowTargetList;
3123 /**
3124 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3125 */
3126 NextToken?: NextToken;
3127 }
3128 export interface DescribeMaintenanceWindowTasksRequest {
3129 /**
3130 * The ID of the Maintenance Window whose tasks should be retrieved.
3131 */
3132 WindowId: MaintenanceWindowId;
3133 /**
3134 * Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
3135 */
3136 Filters?: MaintenanceWindowFilterList;
3137 /**
3138 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3139 */
3140 MaxResults?: MaintenanceWindowMaxResults;
3141 /**
3142 * The token for the next set of items to return. (You received this token from a previous call.)
3143 */
3144 NextToken?: NextToken;
3145 }
3146 export interface DescribeMaintenanceWindowTasksResult {
3147 /**
3148 * Information about the tasks in the Maintenance Window.
3149 */
3150 Tasks?: MaintenanceWindowTaskList;
3151 /**
3152 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3153 */
3154 NextToken?: NextToken;
3155 }
3156 export interface DescribeMaintenanceWindowsForTargetRequest {
3157 /**
3158 * The instance ID or key/value pair to retrieve information about.
3159 */
3160 Targets: Targets;
3161 /**
3162 * The type of resource you want to retrieve information about. For example, "INSTANCE".
3163 */
3164 ResourceType: MaintenanceWindowResourceType;
3165 /**
3166 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3167 */
3168 MaxResults?: MaintenanceWindowSearchMaxResults;
3169 /**
3170 * The token for the next set of items to return. (You received this token from a previous call.)
3171 */
3172 NextToken?: NextToken;
3173 }
3174 export interface DescribeMaintenanceWindowsForTargetResult {
3175 /**
3176 * Information about the Maintenance Window targets and tasks an instance is associated with.
3177 */
3178 WindowIdentities?: MaintenanceWindowsForTargetList;
3179 /**
3180 * The token for the next set of items to return. (You use this token in the next call.)
3181 */
3182 NextToken?: NextToken;
3183 }
3184 export interface DescribeMaintenanceWindowsRequest {
3185 /**
3186 * Optional filters used to narrow down the scope of the returned Maintenance Windows. Supported filter keys are Name and Enabled.
3187 */
3188 Filters?: MaintenanceWindowFilterList;
3189 /**
3190 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3191 */
3192 MaxResults?: MaintenanceWindowMaxResults;
3193 /**
3194 * The token for the next set of items to return. (You received this token from a previous call.)
3195 */
3196 NextToken?: NextToken;
3197 }
3198 export interface DescribeMaintenanceWindowsResult {
3199 /**
3200 * Information about the Maintenance Windows.
3201 */
3202 WindowIdentities?: MaintenanceWindowIdentityList;
3203 /**
3204 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3205 */
3206 NextToken?: NextToken;
3207 }
3208 export interface DescribeParametersRequest {
3209 /**
3210 * One or more filters. Use a filter to return a more specific list of results.
3211 */
3212 Filters?: ParametersFilterList;
3213 /**
3214 * Filters to limit the request results.
3215 */
3216 ParameterFilters?: ParameterStringFilterList;
3217 /**
3218 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3219 */
3220 MaxResults?: MaxResults;
3221 /**
3222 * The token for the next set of items to return. (You received this token from a previous call.)
3223 */
3224 NextToken?: NextToken;
3225 }
3226 export interface DescribeParametersResult {
3227 /**
3228 * Parameters returned by the request.
3229 */
3230 Parameters?: ParameterMetadataList;
3231 /**
3232 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3233 */
3234 NextToken?: NextToken;
3235 }
3236 export interface DescribePatchBaselinesRequest {
3237 /**
3238 * Each element in the array is a structure containing: Key: (string, "NAME_PREFIX" or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255 characters)
3239 */
3240 Filters?: PatchOrchestratorFilterList;
3241 /**
3242 * The maximum number of patch baselines to return (per page).
3243 */
3244 MaxResults?: PatchBaselineMaxResults;
3245 /**
3246 * The token for the next set of items to return. (You received this token from a previous call.)
3247 */
3248 NextToken?: NextToken;
3249 }
3250 export interface DescribePatchBaselinesResult {
3251 /**
3252 * An array of PatchBaselineIdentity elements.
3253 */
3254 BaselineIdentities?: PatchBaselineIdentityList;
3255 /**
3256 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3257 */
3258 NextToken?: NextToken;
3259 }
3260 export interface DescribePatchGroupStateRequest {
3261 /**
3262 * The name of the patch group whose patch snapshot should be retrieved.
3263 */
3264 PatchGroup: PatchGroup;
3265 }
3266 export interface DescribePatchGroupStateResult {
3267 /**
3268 * The number of instances in the patch group.
3269 */
3270 Instances?: Integer;
3271 /**
3272 * The number of instances with installed patches.
3273 */
3274 InstancesWithInstalledPatches?: Integer;
3275 /**
3276 * The number of instances with patches installed that aren't defined in the patch baseline.
3277 */
3278 InstancesWithInstalledOtherPatches?: Integer;
3279 /**
3280 * The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list. If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).
3281 */
3282 InstancesWithInstalledRejectedPatches?: InstancesCount;
3283 /**
3284 * The number of instances with missing patches from the patch baseline.
3285 */
3286 InstancesWithMissingPatches?: Integer;
3287 /**
3288 * The number of instances with patches from the patch baseline that failed to install.
3289 */
3290 InstancesWithFailedPatches?: Integer;
3291 /**
3292 * The number of instances with patches that aren't applicable.
3293 */
3294 InstancesWithNotApplicablePatches?: Integer;
3295 }
3296 export interface DescribePatchGroupsRequest {
3297 /**
3298 * The maximum number of patch groups to return (per page).
3299 */
3300 MaxResults?: PatchBaselineMaxResults;
3301 /**
3302 * One or more filters. Use a filter to return a more specific list of results.
3303 */
3304 Filters?: PatchOrchestratorFilterList;
3305 /**
3306 * The token for the next set of items to return. (You received this token from a previous call.)
3307 */
3308 NextToken?: NextToken;
3309 }
3310 export interface DescribePatchGroupsResult {
3311 /**
3312 * Each entry in the array contains: PatchGroup: string (between 1 and 256 characters, Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$) PatchBaselineIdentity: A PatchBaselineIdentity element.
3313 */
3314 Mappings?: PatchGroupPatchBaselineMappingList;
3315 /**
3316 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3317 */
3318 NextToken?: NextToken;
3319 }
3320 export interface DescribeSessionsRequest {
3321 /**
3322 * The session status to retrieve a list of sessions for. For example, "Active".
3323 */
3324 State: SessionState;
3325 /**
3326 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3327 */
3328 MaxResults?: SessionMaxResults;
3329 /**
3330 * The token for the next set of items to return. (You received this token from a previous call.)
3331 */
3332 NextToken?: NextToken;
3333 /**
3334 * One or more filters to limit the type of sessions returned by the request.
3335 */
3336 Filters?: SessionFilterList;
3337 }
3338 export interface DescribeSessionsResponse {
3339 /**
3340 * A list of sessions meeting the request parameters.
3341 */
3342 Sessions?: SessionList;
3343 /**
3344 * The token for the next set of items to return. (You received this token from a previous call.)
3345 */
3346 NextToken?: NextToken;
3347 }
3348 export type DescriptionInDocument = string;
3349 export type DocumentARN = string;
3350 export type DocumentContent = string;
3351 export interface DocumentDefaultVersionDescription {
3352 /**
3353 * The name of the document.
3354 */
3355 Name?: DocumentName;
3356 /**
3357 * The default version of the document.
3358 */
3359 DefaultVersion?: DocumentVersion;
3360 /**
3361 * The default version of the artifact associated with the document.
3362 */
3363 DefaultVersionName?: DocumentVersionName;
3364 }
3365 export interface DocumentDescription {
3366 /**
3367 * The SHA1 hash of the document, which you can use for verification.
3368 */
3369 Sha1?: DocumentSha1;
3370 /**
3371 * The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
3372 */
3373 Hash?: DocumentHash;
3374 /**
3375 * The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes have been deprecated.
3376 */
3377 HashType?: DocumentHashType;
3378 /**
3379 * The name of the Systems Manager document.
3380 */
3381 Name?: DocumentARN;
3382 /**
3383 * The version of the artifact associated with the document.
3384 */
3385 VersionName?: DocumentVersionName;
3386 /**
3387 * The AWS user account that created the document.
3388 */
3389 Owner?: DocumentOwner;
3390 /**
3391 * The date when the document was created.
3392 */
3393 CreatedDate?: DateTime;
3394 /**
3395 * The status of the Systems Manager document.
3396 */
3397 Status?: DocumentStatus;
3398 /**
3399 * A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
3400 */
3401 StatusInformation?: DocumentStatusInformation;
3402 /**
3403 * The document version.
3404 */
3405 DocumentVersion?: DocumentVersion;
3406 /**
3407 * A description of the document.
3408 */
3409 Description?: DescriptionInDocument;
3410 /**
3411 * A description of the parameters for a document.
3412 */
3413 Parameters?: DocumentParameterList;
3414 /**
3415 * The list of OS platforms compatible with this Systems Manager document.
3416 */
3417 PlatformTypes?: PlatformTypeList;
3418 /**
3419 * The type of document.
3420 */
3421 DocumentType?: DocumentType;
3422 /**
3423 * The schema version.
3424 */
3425 SchemaVersion?: DocumentSchemaVersion;
3426 /**
3427 * The latest version of the document.
3428 */
3429 LatestVersion?: DocumentVersion;
3430 /**
3431 * The default version.
3432 */
3433 DefaultVersion?: DocumentVersion;
3434 /**
3435 * The document format, either JSON or YAML.
3436 */
3437 DocumentFormat?: DocumentFormat;
3438 /**
3439 * The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
3440 */
3441 TargetType?: TargetType;
3442 /**
3443 * The tags, or metadata, that have been applied to the document.
3444 */
3445 Tags?: TagList;
3446 /**
3447 * Details about the document attachments, including names, locations, sizes, etc.
3448 */
3449 AttachmentsInformation?: AttachmentInformationList;
3450 }
3451 export interface DocumentFilter {
3452 /**
3453 * The name of the filter.
3454 */
3455 key: DocumentFilterKey;
3456 /**
3457 * The value of the filter.
3458 */
3459 value: DocumentFilterValue;
3460 }
3461 export type DocumentFilterKey = "Name"|"Owner"|"PlatformTypes"|"DocumentType"|string;
3462 export type DocumentFilterList = DocumentFilter[];
3463 export type DocumentFilterValue = string;
3464 export type DocumentFormat = "YAML"|"JSON"|string;
3465 export type DocumentHash = string;
3466 export type DocumentHashType = "Sha256"|"Sha1"|string;
3467 export interface DocumentIdentifier {
3468 /**
3469 * The name of the Systems Manager document.
3470 */
3471 Name?: DocumentARN;
3472 /**
3473 * The AWS user account that created the document.
3474 */
3475 Owner?: DocumentOwner;
3476 /**
3477 * An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
3478 */
3479 VersionName?: DocumentVersionName;
3480 /**
3481 * The operating system platform.
3482 */
3483 PlatformTypes?: PlatformTypeList;
3484 /**
3485 * The document version.
3486 */
3487 DocumentVersion?: DocumentVersion;
3488 /**
3489 * The document type.
3490 */
3491 DocumentType?: DocumentType;
3492 /**
3493 * The schema version.
3494 */
3495 SchemaVersion?: DocumentSchemaVersion;
3496 /**
3497 * The document format, either JSON or YAML.
3498 */
3499 DocumentFormat?: DocumentFormat;
3500 /**
3501 * The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
3502 */
3503 TargetType?: TargetType;
3504 /**
3505 * The tags, or metadata, that have been applied to the document.
3506 */
3507 Tags?: TagList;
3508 }
3509 export type DocumentIdentifierList = DocumentIdentifier[];
3510 export interface DocumentKeyValuesFilter {
3511 /**
3512 * The name of the filter key.
3513 */
3514 Key?: DocumentKeyValuesFilterKey;
3515 /**
3516 * The value for the filter key.
3517 */
3518 Values?: DocumentKeyValuesFilterValues;
3519 }
3520 export type DocumentKeyValuesFilterKey = string;
3521 export type DocumentKeyValuesFilterList = DocumentKeyValuesFilter[];
3522 export type DocumentKeyValuesFilterValue = string;
3523 export type DocumentKeyValuesFilterValues = DocumentKeyValuesFilterValue[];
3524 export type DocumentName = string;
3525 export type DocumentOwner = string;
3526 export interface DocumentParameter {
3527 /**
3528 * The name of the parameter.
3529 */
3530 Name?: DocumentParameterName;
3531 /**
3532 * The type of parameter. The type can be either String or StringList.
3533 */
3534 Type?: DocumentParameterType;
3535 /**
3536 * A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
3537 */
3538 Description?: DocumentParameterDescrption;
3539 /**
3540 * If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
3541 */
3542 DefaultValue?: DocumentParameterDefaultValue;
3543 }
3544 export type DocumentParameterDefaultValue = string;
3545 export type DocumentParameterDescrption = string;
3546 export type DocumentParameterList = DocumentParameter[];
3547 export type DocumentParameterName = string;
3548 export type DocumentParameterType = "String"|"StringList"|string;
3549 export type DocumentPermissionType = "Share"|string;
3550 export type DocumentSchemaVersion = string;
3551 export type DocumentSha1 = string;
3552 export type DocumentStatus = "Creating"|"Active"|"Updating"|"Deleting"|"Failed"|string;
3553 export type DocumentStatusInformation = string;
3554 export type DocumentType = "Command"|"Policy"|"Automation"|"Session"|"Package"|string;
3555 export type DocumentVersion = string;
3556 export interface DocumentVersionInfo {
3557 /**
3558 * The document name.
3559 */
3560 Name?: DocumentName;
3561 /**
3562 * The document version.
3563 */
3564 DocumentVersion?: DocumentVersion;
3565 /**
3566 * The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
3567 */
3568 VersionName?: DocumentVersionName;
3569 /**
3570 * The date the document was created.
3571 */
3572 CreatedDate?: DateTime;
3573 /**
3574 * An identifier for the default version of the document.
3575 */
3576 IsDefaultVersion?: Boolean;
3577 /**
3578 * The document format, either JSON or YAML.
3579 */
3580 DocumentFormat?: DocumentFormat;
3581 /**
3582 * The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
3583 */
3584 Status?: DocumentStatus;
3585 /**
3586 * A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
3587 */
3588 StatusInformation?: DocumentStatusInformation;
3589 }
3590 export type DocumentVersionList = DocumentVersionInfo[];
3591 export type DocumentVersionName = string;
3592 export type DocumentVersionNumber = string;
3593 export type DryRun = boolean;
3594 export type EffectiveInstanceAssociationMaxResults = number;
3595 export interface EffectivePatch {
3596 /**
3597 * Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.
3598 */
3599 Patch?: Patch;
3600 /**
3601 * The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.
3602 */
3603 PatchStatus?: PatchStatus;
3604 }
3605 export type EffectivePatchList = EffectivePatch[];
3606 export type ErrorCount = number;
3607 export type ExecutionMode = "Auto"|"Interactive"|string;
3608 export type ExecutionRoleName = string;
3609 export type ExpirationDate = Date;
3610 export interface FailedCreateAssociation {
3611 /**
3612 * The association.
3613 */
3614 Entry?: CreateAssociationBatchRequestEntry;
3615 /**
3616 * A description of the failure.
3617 */
3618 Message?: BatchErrorMessage;
3619 /**
3620 * The source of the failure.
3621 */
3622 Fault?: Fault;
3623 }
3624 export type FailedCreateAssociationList = FailedCreateAssociation[];
3625 export interface FailureDetails {
3626 /**
3627 * The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.
3628 */
3629 FailureStage?: String;
3630 /**
3631 * The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.
3632 */
3633 FailureType?: String;
3634 /**
3635 * Detailed information about the Automation step failure.
3636 */
3637 Details?: AutomationParameterMap;
3638 }
3639 export type Fault = "Client"|"Server"|"Unknown"|string;
3640 export interface GetAutomationExecutionRequest {
3641 /**
3642 * The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.
3643 */
3644 AutomationExecutionId: AutomationExecutionId;
3645 }
3646 export interface GetAutomationExecutionResult {
3647 /**
3648 * Detailed information about the current state of an automation execution.
3649 */
3650 AutomationExecution?: AutomationExecution;
3651 }
3652 export interface GetCommandInvocationRequest {
3653 /**
3654 * (Required) The parent command ID of the invocation plugin.
3655 */
3656 CommandId: CommandId;
3657 /**
3658 * (Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
3659 */
3660 InstanceId: InstanceId;
3661 /**
3662 * (Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.
3663 */
3664 PluginName?: CommandPluginName;
3665 }
3666 export interface GetCommandInvocationResult {
3667 /**
3668 * The parent command ID of the invocation plugin.
3669 */
3670 CommandId?: CommandId;
3671 /**
3672 * The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
3673 */
3674 InstanceId?: InstanceId;
3675 /**
3676 * The comment text for the command.
3677 */
3678 Comment?: Comment;
3679 /**
3680 * The name of the document that was executed. For example, AWS-RunShellScript.
3681 */
3682 DocumentName?: DocumentName;
3683 /**
3684 * The SSM document version used in the request.
3685 */
3686 DocumentVersion?: DocumentVersion;
3687 /**
3688 * The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.
3689 */
3690 PluginName?: CommandPluginName;
3691 /**
3692 * The error level response code for the plugin script. If the response code is -1, then the command has not started executing on the instance, or it was not received by the instance.
3693 */
3694 ResponseCode?: ResponseCode;
3695 /**
3696 * The date and time the plugin started executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter. aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If the plugin has not started to execute, the string is empty.
3697 */
3698 ExecutionStartDateTime?: StringDateTime;
3699 /**
3700 * Duration since ExecutionStartDateTime.
3701 */
3702 ExecutionElapsedTime?: StringDateTime;
3703 /**
3704 * The date and time the plugin was finished executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter. aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If the plugin has not started to execute, the string is empty.
3705 */
3706 ExecutionEndDateTime?: StringDateTime;
3707 /**
3708 * The status of this invocation plugin. This status can be different than StatusDetails.
3709 */
3710 Status?: CommandInvocationStatus;
3711 /**
3712 * A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again. Success: The command or plugin was executed successfully. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: The command started to execute on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command wasn't executed successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
3713 */
3714 StatusDetails?: StatusDetails;
3715 /**
3716 * The first 24,000 characters written by the plugin to stdout. If the command has not finished executing, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
3717 */
3718 StandardOutputContent?: StandardOutputContent;
3719 /**
3720 * The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty.
3721 */
3722 StandardOutputUrl?: Url;
3723 /**
3724 * The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.
3725 */
3726 StandardErrorContent?: StandardErrorContent;
3727 /**
3728 * The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.
3729 */
3730 StandardErrorUrl?: Url;
3731 /**
3732 * CloudWatch Logs information where Systems Manager sent the command output.
3733 */
3734 CloudWatchOutputConfig?: CloudWatchOutputConfig;
3735 }
3736 export interface GetConnectionStatusRequest {
3737 /**
3738 * The ID of the instance.
3739 */
3740 Target: SessionTarget;
3741 }
3742 export interface GetConnectionStatusResponse {
3743 /**
3744 * The ID of the instance to check connection status.
3745 */
3746 Target?: SessionTarget;
3747 /**
3748 * The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.
3749 */
3750 Status?: ConnectionStatus;
3751 }
3752 export interface GetDefaultPatchBaselineRequest {
3753 /**
3754 * Returns the default patch baseline for the specified operating system.
3755 */
3756 OperatingSystem?: OperatingSystem;
3757 }
3758 export interface GetDefaultPatchBaselineResult {
3759 /**
3760 * The ID of the default patch baseline.
3761 */
3762 BaselineId?: BaselineId;
3763 /**
3764 * The operating system for the returned patch baseline.
3765 */
3766 OperatingSystem?: OperatingSystem;
3767 }
3768 export interface GetDeployablePatchSnapshotForInstanceRequest {
3769 /**
3770 * The ID of the instance for which the appropriate patch snapshot should be retrieved.
3771 */
3772 InstanceId: InstanceId;
3773 /**
3774 * The user-defined snapshot ID.
3775 */
3776 SnapshotId: SnapshotId;
3777 }
3778 export interface GetDeployablePatchSnapshotForInstanceResult {
3779 /**
3780 * The ID of the instance.
3781 */
3782 InstanceId?: InstanceId;
3783 /**
3784 * The user-defined snapshot ID.
3785 */
3786 SnapshotId?: SnapshotId;
3787 /**
3788 * A pre-signed Amazon S3 URL that can be used to download the patch snapshot.
3789 */
3790 SnapshotDownloadUrl?: SnapshotDownloadUrl;
3791 /**
3792 * Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.
3793 */
3794 Product?: Product;
3795 }
3796 export interface GetDocumentRequest {
3797 /**
3798 * The name of the Systems Manager document.
3799 */
3800 Name: DocumentARN;
3801 /**
3802 * An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
3803 */
3804 VersionName?: DocumentVersionName;
3805 /**
3806 * The document version for which you want information.
3807 */
3808 DocumentVersion?: DocumentVersion;
3809 /**
3810 * Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.
3811 */
3812 DocumentFormat?: DocumentFormat;
3813 }
3814 export interface GetDocumentResult {
3815 /**
3816 * The name of the Systems Manager document.
3817 */
3818 Name?: DocumentARN;
3819 /**
3820 * The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
3821 */
3822 VersionName?: DocumentVersionName;
3823 /**
3824 * The document version.
3825 */
3826 DocumentVersion?: DocumentVersion;
3827 /**
3828 * The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
3829 */
3830 Status?: DocumentStatus;
3831 /**
3832 * A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
3833 */
3834 StatusInformation?: DocumentStatusInformation;
3835 /**
3836 * The contents of the Systems Manager document.
3837 */
3838 Content?: DocumentContent;
3839 /**
3840 * The document type.
3841 */
3842 DocumentType?: DocumentType;
3843 /**
3844 * The document format, either JSON or YAML.
3845 */
3846 DocumentFormat?: DocumentFormat;
3847 /**
3848 * A description of the document attachments, including names, locations, sizes, etc.
3849 */
3850 AttachmentsContent?: AttachmentContentList;
3851 }
3852 export interface GetInventoryRequest {
3853 /**
3854 * One or more filters. Use a filter to return a more specific list of results.
3855 */
3856 Filters?: InventoryFilterList;
3857 /**
3858 * Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet.
3859 */
3860 Aggregators?: InventoryAggregatorList;
3861 /**
3862 * The list of inventory item types to return.
3863 */
3864 ResultAttributes?: ResultAttributeList;
3865 /**
3866 * The token for the next set of items to return. (You received this token from a previous call.)
3867 */
3868 NextToken?: NextToken;
3869 /**
3870 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3871 */
3872 MaxResults?: MaxResults;
3873 }
3874 export interface GetInventoryResult {
3875 /**
3876 * Collection of inventory entities such as a collection of instance inventory.
3877 */
3878 Entities?: InventoryResultEntityList;
3879 /**
3880 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3881 */
3882 NextToken?: NextToken;
3883 }
3884 export type GetInventorySchemaMaxResults = number;
3885 export interface GetInventorySchemaRequest {
3886 /**
3887 * The type of inventory item to return.
3888 */
3889 TypeName?: InventoryItemTypeNameFilter;
3890 /**
3891 * The token for the next set of items to return. (You received this token from a previous call.)
3892 */
3893 NextToken?: NextToken;
3894 /**
3895 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
3896 */
3897 MaxResults?: GetInventorySchemaMaxResults;
3898 /**
3899 * Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.
3900 */
3901 Aggregator?: AggregatorSchemaOnly;
3902 /**
3903 * Returns the sub-type schema for a specified inventory type.
3904 */
3905 SubType?: IsSubTypeSchema;
3906 }
3907 export interface GetInventorySchemaResult {
3908 /**
3909 * Inventory schemas returned by the request.
3910 */
3911 Schemas?: InventoryItemSchemaResultList;
3912 /**
3913 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
3914 */
3915 NextToken?: NextToken;
3916 }
3917 export interface GetMaintenanceWindowExecutionRequest {
3918 /**
3919 * The ID of the Maintenance Window execution that includes the task.
3920 */
3921 WindowExecutionId: MaintenanceWindowExecutionId;
3922 }
3923 export interface GetMaintenanceWindowExecutionResult {
3924 /**
3925 * The ID of the Maintenance Window execution.
3926 */
3927 WindowExecutionId?: MaintenanceWindowExecutionId;
3928 /**
3929 * The ID of the task executions from the Maintenance Window execution.
3930 */
3931 TaskIds?: MaintenanceWindowExecutionTaskIdList;
3932 /**
3933 * The status of the Maintenance Window execution.
3934 */
3935 Status?: MaintenanceWindowExecutionStatus;
3936 /**
3937 * The details explaining the Status. Only available for certain status values.
3938 */
3939 StatusDetails?: MaintenanceWindowExecutionStatusDetails;
3940 /**
3941 * The time the Maintenance Window started executing.
3942 */
3943 StartTime?: DateTime;
3944 /**
3945 * The time the Maintenance Window finished executing.
3946 */
3947 EndTime?: DateTime;
3948 }
3949 export interface GetMaintenanceWindowExecutionTaskInvocationRequest {
3950 /**
3951 * The ID of the Maintenance Window execution for which the task is a part.
3952 */
3953 WindowExecutionId: MaintenanceWindowExecutionId;
3954 /**
3955 * The ID of the specific task in the Maintenance Window task that should be retrieved.
3956 */
3957 TaskId: MaintenanceWindowExecutionTaskId;
3958 /**
3959 * The invocation ID to retrieve.
3960 */
3961 InvocationId: MaintenanceWindowExecutionTaskInvocationId;
3962 }
3963 export interface GetMaintenanceWindowExecutionTaskInvocationResult {
3964 /**
3965 * The Maintenance Window execution ID.
3966 */
3967 WindowExecutionId?: MaintenanceWindowExecutionId;
3968 /**
3969 * The task execution ID.
3970 */
3971 TaskExecutionId?: MaintenanceWindowExecutionTaskId;
3972 /**
3973 * The invocation ID.
3974 */
3975 InvocationId?: MaintenanceWindowExecutionTaskInvocationId;
3976 /**
3977 * The execution ID.
3978 */
3979 ExecutionId?: MaintenanceWindowExecutionTaskExecutionId;
3980 /**
3981 * Retrieves the task type for a Maintenance Window. Task types include the following: LAMBDA, STEP_FUNCTION, AUTOMATION, RUN_COMMAND.
3982 */
3983 TaskType?: MaintenanceWindowTaskType;
3984 /**
3985 * The parameters used at the time that the task executed.
3986 */
3987 Parameters?: MaintenanceWindowExecutionTaskInvocationParameters;
3988 /**
3989 * The task status for an invocation.
3990 */
3991 Status?: MaintenanceWindowExecutionStatus;
3992 /**
3993 * The details explaining the status. Details are only available for certain status values.
3994 */
3995 StatusDetails?: MaintenanceWindowExecutionStatusDetails;
3996 /**
3997 * The time that the task started executing on the target.
3998 */
3999 StartTime?: DateTime;
4000 /**
4001 * The time that the task finished executing on the target.
4002 */
4003 EndTime?: DateTime;
4004 /**
4005 * User-provided value to be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
4006 */
4007 OwnerInformation?: OwnerInformation;
4008 /**
4009 * The Maintenance Window target ID.
4010 */
4011 WindowTargetId?: MaintenanceWindowTaskTargetId;
4012 }
4013 export interface GetMaintenanceWindowExecutionTaskRequest {
4014 /**
4015 * The ID of the Maintenance Window execution that includes the task.
4016 */
4017 WindowExecutionId: MaintenanceWindowExecutionId;
4018 /**
4019 * The ID of the specific task execution in the Maintenance Window task that should be retrieved.
4020 */
4021 TaskId: MaintenanceWindowExecutionTaskId;
4022 }
4023 export interface GetMaintenanceWindowExecutionTaskResult {
4024 /**
4025 * The ID of the Maintenance Window execution that includes the task.
4026 */
4027 WindowExecutionId?: MaintenanceWindowExecutionId;
4028 /**
4029 * The ID of the specific task execution in the Maintenance Window task that was retrieved.
4030 */
4031 TaskExecutionId?: MaintenanceWindowExecutionTaskId;
4032 /**
4033 * The ARN of the executed task.
4034 */
4035 TaskArn?: MaintenanceWindowTaskArn;
4036 /**
4037 * The role that was assumed when executing the task.
4038 */
4039 ServiceRole?: ServiceRole;
4040 /**
4041 * The type of task executed.
4042 */
4043 Type?: MaintenanceWindowTaskType;
4044 /**
4045 * The parameters passed to the task when it was executed. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters
4046 */
4047 TaskParameters?: MaintenanceWindowTaskParametersList;
4048 /**
4049 * The priority of the task.
4050 */
4051 Priority?: MaintenanceWindowTaskPriority;
4052 /**
4053 * The defined maximum number of task executions that could be run in parallel.
4054 */
4055 MaxConcurrency?: MaxConcurrency;
4056 /**
4057 * The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
4058 */
4059 MaxErrors?: MaxErrors;
4060 /**
4061 * The status of the task.
4062 */
4063 Status?: MaintenanceWindowExecutionStatus;
4064 /**
4065 * The details explaining the Status. Only available for certain status values.
4066 */
4067 StatusDetails?: MaintenanceWindowExecutionStatusDetails;
4068 /**
4069 * The time the task execution started.
4070 */
4071 StartTime?: DateTime;
4072 /**
4073 * The time the task execution completed.
4074 */
4075 EndTime?: DateTime;
4076 }
4077 export interface GetMaintenanceWindowRequest {
4078 /**
4079 * The ID of the desired Maintenance Window.
4080 */
4081 WindowId: MaintenanceWindowId;
4082 }
4083 export interface GetMaintenanceWindowResult {
4084 /**
4085 * The ID of the created Maintenance Window.
4086 */
4087 WindowId?: MaintenanceWindowId;
4088 /**
4089 * The name of the Maintenance Window.
4090 */
4091 Name?: MaintenanceWindowName;
4092 /**
4093 * The description of the Maintenance Window.
4094 */
4095 Description?: MaintenanceWindowDescription;
4096 /**
4097 * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become active. The Maintenance Window will not run before this specified time.
4098 */
4099 StartDate?: MaintenanceWindowStringDateTime;
4100 /**
4101 * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become inactive. The Maintenance Window will not run after this specified time.
4102 */
4103 EndDate?: MaintenanceWindowStringDateTime;
4104 /**
4105 * The schedule of the Maintenance Window in the form of a cron or rate expression.
4106 */
4107 Schedule?: MaintenanceWindowSchedule;
4108 /**
4109 * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
4110 */
4111 ScheduleTimezone?: MaintenanceWindowTimezone;
4112 /**
4113 * The next time the Maintenance Window will actually run, taking into account any specified times for the Maintenance Window to become active or inactive.
4114 */
4115 NextExecutionTime?: MaintenanceWindowStringDateTime;
4116 /**
4117 * The duration of the Maintenance Window in hours.
4118 */
4119 Duration?: MaintenanceWindowDurationHours;
4120 /**
4121 * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
4122 */
4123 Cutoff?: MaintenanceWindowCutoff;
4124 /**
4125 * Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
4126 */
4127 AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets;
4128 /**
4129 * Whether the Maintenance Windows is enabled.
4130 */
4131 Enabled?: MaintenanceWindowEnabled;
4132 /**
4133 * The date the Maintenance Window was created.
4134 */
4135 CreatedDate?: DateTime;
4136 /**
4137 * The date the Maintenance Window was last modified.
4138 */
4139 ModifiedDate?: DateTime;
4140 }
4141 export interface GetMaintenanceWindowTaskRequest {
4142 /**
4143 * The Maintenance Window ID that includes the task to retrieve.
4144 */
4145 WindowId: MaintenanceWindowId;
4146 /**
4147 * The Maintenance Window task ID to retrieve.
4148 */
4149 WindowTaskId: MaintenanceWindowTaskId;
4150 }
4151 export interface GetMaintenanceWindowTaskResult {
4152 /**
4153 * The retrieved Maintenance Window ID.
4154 */
4155 WindowId?: MaintenanceWindowId;
4156 /**
4157 * The retrieved Maintenance Window task ID.
4158 */
4159 WindowTaskId?: MaintenanceWindowTaskId;
4160 /**
4161 * The targets where the task should execute.
4162 */
4163 Targets?: Targets;
4164 /**
4165 * The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
4166 */
4167 TaskArn?: MaintenanceWindowTaskArn;
4168 /**
4169 * The IAM service role to assume during task execution.
4170 */
4171 ServiceRoleArn?: ServiceRole;
4172 /**
4173 * The type of task to execute.
4174 */
4175 TaskType?: MaintenanceWindowTaskType;
4176 /**
4177 * The parameters to pass to the task when it executes. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
4178 */
4179 TaskParameters?: MaintenanceWindowTaskParameters;
4180 /**
4181 * The parameters to pass to the task when it executes.
4182 */
4183 TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
4184 /**
4185 * The priority of the task when it executes. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
4186 */
4187 Priority?: MaintenanceWindowTaskPriority;
4188 /**
4189 * The maximum number of targets allowed to run this task in parallel.
4190 */
4191 MaxConcurrency?: MaxConcurrency;
4192 /**
4193 * The maximum number of errors allowed before the task stops being scheduled.
4194 */
4195 MaxErrors?: MaxErrors;
4196 /**
4197 * The location in Amazon S3 where the task results are logged. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
4198 */
4199 LoggingInfo?: LoggingInfo;
4200 /**
4201 * The retrieved task name.
4202 */
4203 Name?: MaintenanceWindowName;
4204 /**
4205 * The retrieved task description.
4206 */
4207 Description?: MaintenanceWindowDescription;
4208 }
4209 export interface GetParameterHistoryRequest {
4210 /**
4211 * The name of a parameter you want to query.
4212 */
4213 Name: PSParameterName;
4214 /**
4215 * Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
4216 */
4217 WithDecryption?: Boolean;
4218 /**
4219 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
4220 */
4221 MaxResults?: MaxResults;
4222 /**
4223 * The token for the next set of items to return. (You received this token from a previous call.)
4224 */
4225 NextToken?: NextToken;
4226 }
4227 export interface GetParameterHistoryResult {
4228 /**
4229 * A list of parameters returned by the request.
4230 */
4231 Parameters?: ParameterHistoryList;
4232 /**
4233 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
4234 */
4235 NextToken?: NextToken;
4236 }
4237 export interface GetParameterRequest {
4238 /**
4239 * The name of the parameter you want to query.
4240 */
4241 Name: PSParameterName;
4242 /**
4243 * Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
4244 */
4245 WithDecryption?: Boolean;
4246 }
4247 export interface GetParameterResult {
4248 /**
4249 * Information about a parameter.
4250 */
4251 Parameter?: Parameter;
4252 }
4253 export type GetParametersByPathMaxResults = number;
4254 export interface GetParametersByPathRequest {
4255 /**
4256 * The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
4257 */
4258 Path: PSParameterName;
4259 /**
4260 * Retrieve all parameters within a hierarchy. If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a, they can still call the GetParametersByPath API action recursively and view /a/b.
4261 */
4262 Recursive?: Boolean;
4263 /**
4264 * Filters to limit the request results. You can't filter using the parameter name.
4265 */
4266 ParameterFilters?: ParameterStringFilterList;
4267 /**
4268 * Retrieve all parameters in a hierarchy with their value decrypted.
4269 */
4270 WithDecryption?: Boolean;
4271 /**
4272 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
4273 */
4274 MaxResults?: GetParametersByPathMaxResults;
4275 /**
4276 * A token to start the list. Use this token to get the next set of results.
4277 */
4278 NextToken?: NextToken;
4279 }
4280 export interface GetParametersByPathResult {
4281 /**
4282 * A list of parameters found in the specified hierarchy.
4283 */
4284 Parameters?: ParameterList;
4285 /**
4286 * The token for the next set of items to return. Use this token to get the next set of results.
4287 */
4288 NextToken?: NextToken;
4289 }
4290 export interface GetParametersRequest {
4291 /**
4292 * Names of the parameters for which you want to query information.
4293 */
4294 Names: ParameterNameList;
4295 /**
4296 * Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
4297 */
4298 WithDecryption?: Boolean;
4299 }
4300 export interface GetParametersResult {
4301 /**
4302 * A list of details for a parameter.
4303 */
4304 Parameters?: ParameterList;
4305 /**
4306 * A list of parameters that are not formatted correctly or do not run when executed.
4307 */
4308 InvalidParameters?: ParameterNameList;
4309 }
4310 export interface GetPatchBaselineForPatchGroupRequest {
4311 /**
4312 * The name of the patch group whose patch baseline should be retrieved.
4313 */
4314 PatchGroup: PatchGroup;
4315 /**
4316 * Returns he operating system rule specified for patch groups using the patch baseline.
4317 */
4318 OperatingSystem?: OperatingSystem;
4319 }
4320 export interface GetPatchBaselineForPatchGroupResult {
4321 /**
4322 * The ID of the patch baseline that should be used for the patch group.
4323 */
4324 BaselineId?: BaselineId;
4325 /**
4326 * The name of the patch group.
4327 */
4328 PatchGroup?: PatchGroup;
4329 /**
4330 * The operating system rule specified for patch groups using the patch baseline.
4331 */
4332 OperatingSystem?: OperatingSystem;
4333 }
4334 export interface GetPatchBaselineRequest {
4335 /**
4336 * The ID of the patch baseline to retrieve.
4337 */
4338 BaselineId: BaselineId;
4339 }
4340 export interface GetPatchBaselineResult {
4341 /**
4342 * The ID of the retrieved patch baseline.
4343 */
4344 BaselineId?: BaselineId;
4345 /**
4346 * The name of the patch baseline.
4347 */
4348 Name?: BaselineName;
4349 /**
4350 * Returns the operating system specified for the patch baseline.
4351 */
4352 OperatingSystem?: OperatingSystem;
4353 /**
4354 * A set of global filters used to exclude patches from the baseline.
4355 */
4356 GlobalFilters?: PatchFilterGroup;
4357 /**
4358 * A set of rules used to include patches in the baseline.
4359 */
4360 ApprovalRules?: PatchRuleGroup;
4361 /**
4362 * A list of explicitly approved patches for the baseline.
4363 */
4364 ApprovedPatches?: PatchIdList;
4365 /**
4366 * Returns the specified compliance severity level for approved patches in the patch baseline.
4367 */
4368 ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
4369 /**
4370 * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
4371 */
4372 ApprovedPatchesEnableNonSecurity?: Boolean;
4373 /**
4374 * A list of explicitly rejected patches for the baseline.
4375 */
4376 RejectedPatches?: PatchIdList;
4377 /**
4378 * The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
4379 */
4380 RejectedPatchesAction?: PatchAction;
4381 /**
4382 * Patch groups included in the patch baseline.
4383 */
4384 PatchGroups?: PatchGroupList;
4385 /**
4386 * The date the patch baseline was created.
4387 */
4388 CreatedDate?: DateTime;
4389 /**
4390 * The date the patch baseline was last modified.
4391 */
4392 ModifiedDate?: DateTime;
4393 /**
4394 * A description of the patch baseline.
4395 */
4396 Description?: BaselineDescription;
4397 /**
4398 * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
4399 */
4400 Sources?: PatchSourceList;
4401 }
4402 export interface GetServiceSettingRequest {
4403 /**
4404 * The ID of the service setting to get.
4405 */
4406 SettingId: ServiceSettingId;
4407 }
4408 export interface GetServiceSettingResult {
4409 /**
4410 * The query result of the current service setting.
4411 */
4412 ServiceSetting?: ServiceSetting;
4413 }
4414 export type IPAddress = string;
4415 export type IamRole = string;
4416 export type IdempotencyToken = string;
4417 export type InstallOverrideList = string;
4418 export interface InstanceAggregatedAssociationOverview {
4419 /**
4420 * Detailed status information about the aggregated associations.
4421 */
4422 DetailedStatus?: StatusName;
4423 /**
4424 * The number of associations for the instance(s).
4425 */
4426 InstanceAssociationStatusAggregatedCount?: InstanceAssociationStatusAggregatedCount;
4427 }
4428 export interface InstanceAssociation {
4429 /**
4430 * The association ID.
4431 */
4432 AssociationId?: AssociationId;
4433 /**
4434 * The instance ID.
4435 */
4436 InstanceId?: InstanceId;
4437 /**
4438 * The content of the association document for the instance(s).
4439 */
4440 Content?: DocumentContent;
4441 /**
4442 * Version information for the association on the instance.
4443 */
4444 AssociationVersion?: AssociationVersion;
4445 }
4446 export type InstanceAssociationExecutionSummary = string;
4447 export type InstanceAssociationList = InstanceAssociation[];
4448 export interface InstanceAssociationOutputLocation {
4449 /**
4450 * An Amazon S3 bucket where you want to store the results of this request.
4451 */
4452 S3Location?: S3OutputLocation;
4453 }
4454 export interface InstanceAssociationOutputUrl {
4455 /**
4456 * The URL of Amazon S3 bucket where you want to store the results of this request.
4457 */
4458 S3OutputUrl?: S3OutputUrl;
4459 }
4460 export type InstanceAssociationStatusAggregatedCount = {[key: string]: InstanceCount};
4461 export interface InstanceAssociationStatusInfo {
4462 /**
4463 * The association ID.
4464 */
4465 AssociationId?: AssociationId;
4466 /**
4467 * The name of the association.
4468 */
4469 Name?: DocumentARN;
4470 /**
4471 * The association document verions.
4472 */
4473 DocumentVersion?: DocumentVersion;
4474 /**
4475 * The version of the association applied to the instance.
4476 */
4477 AssociationVersion?: AssociationVersion;
4478 /**
4479 * The instance ID where the association was created.
4480 */
4481 InstanceId?: InstanceId;
4482 /**
4483 * The date the instance association executed.
4484 */
4485 ExecutionDate?: DateTime;
4486 /**
4487 * Status information about the instance association.
4488 */
4489 Status?: StatusName;
4490 /**
4491 * Detailed status information about the instance association.
4492 */
4493 DetailedStatus?: StatusName;
4494 /**
4495 * Summary information about association execution.
4496 */
4497 ExecutionSummary?: InstanceAssociationExecutionSummary;
4498 /**
4499 * An error code returned by the request to create the association.
4500 */
4501 ErrorCode?: AgentErrorCode;
4502 /**
4503 * A URL for an Amazon S3 bucket where you want to store the results of this request.
4504 */
4505 OutputUrl?: InstanceAssociationOutputUrl;
4506 /**
4507 * The name of the association applied to the instance.
4508 */
4509 AssociationName?: AssociationName;
4510 }
4511 export type InstanceAssociationStatusInfos = InstanceAssociationStatusInfo[];
4512 export type InstanceCount = number;
4513 export type InstanceId = string;
4514 export type InstanceIdList = InstanceId[];
4515 export interface InstanceInformation {
4516 /**
4517 * The instance ID.
4518 */
4519 InstanceId?: InstanceId;
4520 /**
4521 * Connection status of SSM Agent.
4522 */
4523 PingStatus?: PingStatus;
4524 /**
4525 * The date and time when agent last pinged Systems Manager service.
4526 */
4527 LastPingDateTime?: DateTime;
4528 /**
4529 * The version of SSM Agent running on your Linux instance.
4530 */
4531 AgentVersion?: Version;
4532 /**
4533 * Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.
4534 */
4535 IsLatestVersion?: Boolean;
4536 /**
4537 * The operating system platform type.
4538 */
4539 PlatformType?: PlatformType;
4540 /**
4541 * The name of the operating system platform running on your instance.
4542 */
4543 PlatformName?: String;
4544 /**
4545 * The version of the OS platform running on your instance.
4546 */
4547 PlatformVersion?: String;
4548 /**
4549 * The activation ID created by Systems Manager when the server or VM was registered.
4550 */
4551 ActivationId?: ActivationId;
4552 /**
4553 * The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.
4554 */
4555 IamRole?: IamRole;
4556 /**
4557 * The date the server or VM was registered with AWS as a managed instance.
4558 */
4559 RegistrationDate?: DateTime;
4560 /**
4561 * The type of instance. Instances are either EC2 instances or managed instances.
4562 */
4563 ResourceType?: ResourceType;
4564 /**
4565 * The name of the managed instance.
4566 */
4567 Name?: String;
4568 /**
4569 * The IP address of the managed instance.
4570 */
4571 IPAddress?: IPAddress;
4572 /**
4573 * The fully qualified host name of the managed instance.
4574 */
4575 ComputerName?: ComputerName;
4576 /**
4577 * The status of the association.
4578 */
4579 AssociationStatus?: StatusName;
4580 /**
4581 * The date the association was last executed.
4582 */
4583 LastAssociationExecutionDate?: DateTime;
4584 /**
4585 * The last date the association was successfully run.
4586 */
4587 LastSuccessfulAssociationExecutionDate?: DateTime;
4588 /**
4589 * Information about the association.
4590 */
4591 AssociationOverview?: InstanceAggregatedAssociationOverview;
4592 }
4593 export interface InstanceInformationFilter {
4594 /**
4595 * The name of the filter.
4596 */
4597 key: InstanceInformationFilterKey;
4598 /**
4599 * The filter values.
4600 */
4601 valueSet: InstanceInformationFilterValueSet;
4602 }
4603 export type InstanceInformationFilterKey = "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|string;
4604 export type InstanceInformationFilterList = InstanceInformationFilter[];
4605 export type InstanceInformationFilterValue = string;
4606 export type InstanceInformationFilterValueSet = InstanceInformationFilterValue[];
4607 export type InstanceInformationList = InstanceInformation[];
4608 export interface InstanceInformationStringFilter {
4609 /**
4610 * The filter key name to describe your instances. For example: "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|"Tag Key"
4611 */
4612 Key: InstanceInformationStringFilterKey;
4613 /**
4614 * The filter values.
4615 */
4616 Values: InstanceInformationFilterValueSet;
4617 }
4618 export type InstanceInformationStringFilterKey = string;
4619 export type InstanceInformationStringFilterList = InstanceInformationStringFilter[];
4620 export interface InstancePatchState {
4621 /**
4622 * The ID of the managed instance the high-level patch compliance information was collected for.
4623 */
4624 InstanceId: InstanceId;
4625 /**
4626 * The name of the patch group the managed instance belongs to.
4627 */
4628 PatchGroup: PatchGroup;
4629 /**
4630 * The ID of the patch baseline used to patch the instance.
4631 */
4632 BaselineId: BaselineId;
4633 /**
4634 * The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
4635 */
4636 SnapshotId?: SnapshotId;
4637 /**
4638 * An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline. For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.
4639 */
4640 InstallOverrideList?: InstallOverrideList;
4641 /**
4642 * Placeholder information. This field will always be empty in the current release of the service.
4643 */
4644 OwnerInformation?: OwnerInformation;
4645 /**
4646 * The number of patches from the patch baseline that are installed on the instance.
4647 */
4648 InstalledCount?: PatchInstalledCount;
4649 /**
4650 * The number of patches not specified in the patch baseline that are installed on the instance.
4651 */
4652 InstalledOtherCount?: PatchInstalledOtherCount;
4653 /**
4654 * The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list. If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
4655 */
4656 InstalledRejectedCount?: PatchInstalledRejectedCount;
4657 /**
4658 * The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
4659 */
4660 MissingCount?: PatchMissingCount;
4661 /**
4662 * The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
4663 */
4664 FailedCount?: PatchFailedCount;
4665 /**
4666 * The number of patches from the patch baseline that aren't applicable for the instance and hence aren't installed on the instance.
4667 */
4668 NotApplicableCount?: PatchNotApplicableCount;
4669 /**
4670 * The time the most recent patching operation was started on the instance.
4671 */
4672 OperationStartTime: DateTime;
4673 /**
4674 * The time the most recent patching operation completed on the instance.
4675 */
4676 OperationEndTime: DateTime;
4677 /**
4678 * The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
4679 */
4680 Operation: PatchOperationType;
4681 }
4682 export interface InstancePatchStateFilter {
4683 /**
4684 * The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.
4685 */
4686 Key: InstancePatchStateFilterKey;
4687 /**
4688 * The value for the filter, must be an integer greater than or equal to 0.
4689 */
4690 Values: InstancePatchStateFilterValues;
4691 /**
4692 * The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.
4693 */
4694 Type: InstancePatchStateOperatorType;
4695 }
4696 export type InstancePatchStateFilterKey = string;
4697 export type InstancePatchStateFilterList = InstancePatchStateFilter[];
4698 export type InstancePatchStateFilterValue = string;
4699 export type InstancePatchStateFilterValues = InstancePatchStateFilterValue[];
4700 export type InstancePatchStateList = InstancePatchState[];
4701 export type InstancePatchStateOperatorType = "Equal"|"NotEqual"|"LessThan"|"GreaterThan"|string;
4702 export type InstancePatchStatesList = InstancePatchState[];
4703 export type InstanceTagName = string;
4704 export type InstancesCount = number;
4705 export type Integer = number;
4706 export interface InventoryAggregator {
4707 /**
4708 * The inventory type and attribute name for aggregation.
4709 */
4710 Expression?: InventoryAggregatorExpression;
4711 /**
4712 * Nested aggregators to further refine aggregation for an inventory type.
4713 */
4714 Aggregators?: InventoryAggregatorList;
4715 /**
4716 * A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.
4717 */
4718 Groups?: InventoryGroupList;
4719 }
4720 export type InventoryAggregatorExpression = string;
4721 export type InventoryAggregatorList = InventoryAggregator[];
4722 export type InventoryAttributeDataType = "string"|"number"|string;
4723 export type InventoryDeletionId = string;
4724 export type InventoryDeletionLastStatusMessage = string;
4725 export type InventoryDeletionLastStatusUpdateTime = Date;
4726 export type InventoryDeletionStartTime = Date;
4727 export type InventoryDeletionStatus = "InProgress"|"Complete"|string;
4728 export interface InventoryDeletionStatusItem {
4729 /**
4730 * The deletion ID returned by the DeleteInventory action.
4731 */
4732 DeletionId?: InventoryDeletionId;
4733 /**
4734 * The name of the inventory data type.
4735 */
4736 TypeName?: InventoryItemTypeName;
4737 /**
4738 * The UTC timestamp when the delete operation started.
4739 */
4740 DeletionStartTime?: InventoryDeletionStartTime;
4741 /**
4742 * The status of the operation. Possible values are InProgress and Complete.
4743 */
4744 LastStatus?: InventoryDeletionStatus;
4745 /**
4746 * Information about the status.
4747 */
4748 LastStatusMessage?: InventoryDeletionLastStatusMessage;
4749 /**
4750 * Information about the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.
4751 */
4752 DeletionSummary?: InventoryDeletionSummary;
4753 /**
4754 * The UTC timestamp of when the last status report.
4755 */
4756 LastStatusUpdateTime?: InventoryDeletionLastStatusUpdateTime;
4757 }
4758 export interface InventoryDeletionSummary {
4759 /**
4760 * The total number of items to delete. This count does not change during the delete operation.
4761 */
4762 TotalCount?: TotalCount;
4763 /**
4764 * Remaining number of items to delete.
4765 */
4766 RemainingCount?: RemainingCount;
4767 /**
4768 * A list of counts and versions for deleted items.
4769 */
4770 SummaryItems?: InventoryDeletionSummaryItems;
4771 }
4772 export interface InventoryDeletionSummaryItem {
4773 /**
4774 * The inventory type version.
4775 */
4776 Version?: InventoryItemSchemaVersion;
4777 /**
4778 * A count of the number of deleted items.
4779 */
4780 Count?: ResourceCount;
4781 /**
4782 * The remaining number of items to delete.
4783 */
4784 RemainingCount?: RemainingCount;
4785 }
4786 export type InventoryDeletionSummaryItems = InventoryDeletionSummaryItem[];
4787 export type InventoryDeletionsList = InventoryDeletionStatusItem[];
4788 export interface InventoryFilter {
4789 /**
4790 * The name of the filter key.
4791 */
4792 Key: InventoryFilterKey;
4793 /**
4794 * Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
4795 */
4796 Values: InventoryFilterValueList;
4797 /**
4798 * The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
4799 */
4800 Type?: InventoryQueryOperatorType;
4801 }
4802 export type InventoryFilterKey = string;
4803 export type InventoryFilterList = InventoryFilter[];
4804 export type InventoryFilterValue = string;
4805 export type InventoryFilterValueList = InventoryFilterValue[];
4806 export interface InventoryGroup {
4807 /**
4808 * The name of the group.
4809 */
4810 Name: InventoryGroupName;
4811 /**
4812 * Filters define the criteria for the group. The matchingCount field displays the number of resources that match the criteria. The notMatchingCount field displays the number of resources that don't match the criteria.
4813 */
4814 Filters: InventoryFilterList;
4815 }
4816 export type InventoryGroupList = InventoryGroup[];
4817 export type InventoryGroupName = string;
4818 export interface InventoryItem {
4819 /**
4820 * The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
4821 */
4822 TypeName: InventoryItemTypeName;
4823 /**
4824 * The schema version for the inventory item.
4825 */
4826 SchemaVersion: InventoryItemSchemaVersion;
4827 /**
4828 * The time the inventory information was collected.
4829 */
4830 CaptureTime: InventoryItemCaptureTime;
4831 /**
4832 * MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.
4833 */
4834 ContentHash?: InventoryItemContentHash;
4835 /**
4836 * The inventory data of the inventory type.
4837 */
4838 Content?: InventoryItemEntryList;
4839 /**
4840 * A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem type.
4841 */
4842 Context?: InventoryItemContentContext;
4843 }
4844 export interface InventoryItemAttribute {
4845 /**
4846 * Name of the inventory item attribute.
4847 */
4848 Name: InventoryItemAttributeName;
4849 /**
4850 * The data type of the inventory item attribute.
4851 */
4852 DataType: InventoryAttributeDataType;
4853 }
4854 export type InventoryItemAttributeList = InventoryItemAttribute[];
4855 export type InventoryItemAttributeName = string;
4856 export type InventoryItemCaptureTime = string;
4857 export type InventoryItemContentContext = {[key: string]: AttributeValue};
4858 export type InventoryItemContentHash = string;
4859 export type InventoryItemEntry = {[key: string]: AttributeValue};
4860 export type InventoryItemEntryList = InventoryItemEntry[];
4861 export type InventoryItemList = InventoryItem[];
4862 export interface InventoryItemSchema {
4863 /**
4864 * The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
4865 */
4866 TypeName: InventoryItemTypeName;
4867 /**
4868 * The schema version for the inventory item.
4869 */
4870 Version?: InventoryItemSchemaVersion;
4871 /**
4872 * The schema attributes for inventory. This contains data type and attribute name.
4873 */
4874 Attributes: InventoryItemAttributeList;
4875 /**
4876 * The alias name of the inventory type. The alias name is used for display purposes.
4877 */
4878 DisplayName?: InventoryTypeDisplayName;
4879 }
4880 export type InventoryItemSchemaResultList = InventoryItemSchema[];
4881 export type InventoryItemSchemaVersion = string;
4882 export type InventoryItemTypeName = string;
4883 export type InventoryItemTypeNameFilter = string;
4884 export type InventoryQueryOperatorType = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"|string;
4885 export interface InventoryResultEntity {
4886 /**
4887 * ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.
4888 */
4889 Id?: InventoryResultEntityId;
4890 /**
4891 * The data section in the inventory result entity JSON.
4892 */
4893 Data?: InventoryResultItemMap;
4894 }
4895 export type InventoryResultEntityId = string;
4896 export type InventoryResultEntityList = InventoryResultEntity[];
4897 export interface InventoryResultItem {
4898 /**
4899 * The name of the inventory result item type.
4900 */
4901 TypeName: InventoryItemTypeName;
4902 /**
4903 * The schema version for the inventory result item/
4904 */
4905 SchemaVersion: InventoryItemSchemaVersion;
4906 /**
4907 * The time inventory item data was captured.
4908 */
4909 CaptureTime?: InventoryItemCaptureTime;
4910 /**
4911 * MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.
4912 */
4913 ContentHash?: InventoryItemContentHash;
4914 /**
4915 * Contains all the inventory data of the item type. Results include attribute names and values.
4916 */
4917 Content: InventoryItemEntryList;
4918 }
4919 export type InventoryResultItemKey = string;
4920 export type InventoryResultItemMap = {[key: string]: InventoryResultItem};
4921 export type InventorySchemaDeleteOption = "DisableSchema"|"DeleteSchema"|string;
4922 export type InventoryTypeDisplayName = string;
4923 export type InvocationTraceOutput = string;
4924 export type IsSubTypeSchema = boolean;
4925 export type KeyList = TagKey[];
4926 export interface LabelParameterVersionRequest {
4927 /**
4928 * The parameter name on which you want to attach one or more labels.
4929 */
4930 Name: PSParameterName;
4931 /**
4932 * The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.)
4933 */
4934 ParameterVersion?: PSParameterVersion;
4935 /**
4936 * One or more labels to attach to the specified parameter version.
4937 */
4938 Labels: ParameterLabelList;
4939 }
4940 export interface LabelParameterVersionResult {
4941 /**
4942 * The label does not meet the requirements. For information about parameter label requirements, see Labeling Parameters in the AWS Systems Manager User Guide.
4943 */
4944 InvalidLabels?: ParameterLabelList;
4945 }
4946 export type LastResourceDataSyncMessage = string;
4947 export type LastResourceDataSyncStatus = "Successful"|"Failed"|"InProgress"|string;
4948 export type LastResourceDataSyncTime = Date;
4949 export type LastSuccessfulResourceDataSyncTime = Date;
4950 export interface ListAssociationVersionsRequest {
4951 /**
4952 * The association ID for which you want to view all versions.
4953 */
4954 AssociationId: AssociationId;
4955 /**
4956 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
4957 */
4958 MaxResults?: MaxResults;
4959 /**
4960 * A token to start the list. Use this token to get the next set of results.
4961 */
4962 NextToken?: NextToken;
4963 }
4964 export interface ListAssociationVersionsResult {
4965 /**
4966 * Information about all versions of the association for the specified association ID.
4967 */
4968 AssociationVersions?: AssociationVersionList;
4969 /**
4970 * The token for the next set of items to return. Use this token to get the next set of results.
4971 */
4972 NextToken?: NextToken;
4973 }
4974 export interface ListAssociationsRequest {
4975 /**
4976 * One or more filters. Use a filter to return a more specific list of results.
4977 */
4978 AssociationFilterList?: AssociationFilterList;
4979 /**
4980 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
4981 */
4982 MaxResults?: MaxResults;
4983 /**
4984 * The token for the next set of items to return. (You received this token from a previous call.)
4985 */
4986 NextToken?: NextToken;
4987 }
4988 export interface ListAssociationsResult {
4989 /**
4990 * The associations.
4991 */
4992 Associations?: AssociationList;
4993 /**
4994 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
4995 */
4996 NextToken?: NextToken;
4997 }
4998 export interface ListCommandInvocationsRequest {
4999 /**
5000 * (Optional) The invocations for a specific command ID.
5001 */
5002 CommandId?: CommandId;
5003 /**
5004 * (Optional) The command execution details for a specific instance ID.
5005 */
5006 InstanceId?: InstanceId;
5007 /**
5008 * (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5009 */
5010 MaxResults?: CommandMaxResults;
5011 /**
5012 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
5013 */
5014 NextToken?: NextToken;
5015 /**
5016 * (Optional) One or more filters. Use a filter to return a more specific list of results.
5017 */
5018 Filters?: CommandFilterList;
5019 /**
5020 * (Optional) If set this returns the response of the command executions and any command output. By default this is set to False.
5021 */
5022 Details?: Boolean;
5023 }
5024 export interface ListCommandInvocationsResult {
5025 /**
5026 * (Optional) A list of all invocations.
5027 */
5028 CommandInvocations?: CommandInvocationList;
5029 /**
5030 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
5031 */
5032 NextToken?: NextToken;
5033 }
5034 export interface ListCommandsRequest {
5035 /**
5036 * (Optional) If provided, lists only the specified command.
5037 */
5038 CommandId?: CommandId;
5039 /**
5040 * (Optional) Lists commands issued against this instance ID.
5041 */
5042 InstanceId?: InstanceId;
5043 /**
5044 * (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5045 */
5046 MaxResults?: CommandMaxResults;
5047 /**
5048 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
5049 */
5050 NextToken?: NextToken;
5051 /**
5052 * (Optional) One or more filters. Use a filter to return a more specific list of results.
5053 */
5054 Filters?: CommandFilterList;
5055 }
5056 export interface ListCommandsResult {
5057 /**
5058 * (Optional) The list of commands requested by the user.
5059 */
5060 Commands?: CommandList;
5061 /**
5062 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
5063 */
5064 NextToken?: NextToken;
5065 }
5066 export interface ListComplianceItemsRequest {
5067 /**
5068 * One or more compliance filters. Use a filter to return a more specific list of results.
5069 */
5070 Filters?: ComplianceStringFilterList;
5071 /**
5072 * The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.
5073 */
5074 ResourceIds?: ComplianceResourceIdList;
5075 /**
5076 * The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.
5077 */
5078 ResourceTypes?: ComplianceResourceTypeList;
5079 /**
5080 * A token to start the list. Use this token to get the next set of results.
5081 */
5082 NextToken?: NextToken;
5083 /**
5084 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5085 */
5086 MaxResults?: MaxResults;
5087 }
5088 export interface ListComplianceItemsResult {
5089 /**
5090 * A list of compliance information for the specified resource ID.
5091 */
5092 ComplianceItems?: ComplianceItemList;
5093 /**
5094 * The token for the next set of items to return. Use this token to get the next set of results.
5095 */
5096 NextToken?: NextToken;
5097 }
5098 export interface ListComplianceSummariesRequest {
5099 /**
5100 * One or more compliance or inventory filters. Use a filter to return a more specific list of results.
5101 */
5102 Filters?: ComplianceStringFilterList;
5103 /**
5104 * A token to start the list. Use this token to get the next set of results.
5105 */
5106 NextToken?: NextToken;
5107 /**
5108 * The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5109 */
5110 MaxResults?: MaxResults;
5111 }
5112 export interface ListComplianceSummariesResult {
5113 /**
5114 * A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.
5115 */
5116 ComplianceSummaryItems?: ComplianceSummaryItemList;
5117 /**
5118 * The token for the next set of items to return. Use this token to get the next set of results.
5119 */
5120 NextToken?: NextToken;
5121 }
5122 export interface ListDocumentVersionsRequest {
5123 /**
5124 * The name of the document about which you want version information.
5125 */
5126 Name: DocumentName;
5127 /**
5128 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5129 */
5130 MaxResults?: MaxResults;
5131 /**
5132 * The token for the next set of items to return. (You received this token from a previous call.)
5133 */
5134 NextToken?: NextToken;
5135 }
5136 export interface ListDocumentVersionsResult {
5137 /**
5138 * The document versions.
5139 */
5140 DocumentVersions?: DocumentVersionList;
5141 /**
5142 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
5143 */
5144 NextToken?: NextToken;
5145 }
5146 export interface ListDocumentsRequest {
5147 /**
5148 * One or more filters. Use a filter to return a more specific list of results.
5149 */
5150 DocumentFilterList?: DocumentFilterList;
5151 /**
5152 * One or more filters. Use a filter to return a more specific list of results.
5153 */
5154 Filters?: DocumentKeyValuesFilterList;
5155 /**
5156 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5157 */
5158 MaxResults?: MaxResults;
5159 /**
5160 * The token for the next set of items to return. (You received this token from a previous call.)
5161 */
5162 NextToken?: NextToken;
5163 }
5164 export interface ListDocumentsResult {
5165 /**
5166 * The names of the Systems Manager documents.
5167 */
5168 DocumentIdentifiers?: DocumentIdentifierList;
5169 /**
5170 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
5171 */
5172 NextToken?: NextToken;
5173 }
5174 export interface ListInventoryEntriesRequest {
5175 /**
5176 * The instance ID for which you want inventory information.
5177 */
5178 InstanceId: InstanceId;
5179 /**
5180 * The type of inventory item for which you want information.
5181 */
5182 TypeName: InventoryItemTypeName;
5183 /**
5184 * One or more filters. Use a filter to return a more specific list of results.
5185 */
5186 Filters?: InventoryFilterList;
5187 /**
5188 * The token for the next set of items to return. (You received this token from a previous call.)
5189 */
5190 NextToken?: NextToken;
5191 /**
5192 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5193 */
5194 MaxResults?: MaxResults;
5195 }
5196 export interface ListInventoryEntriesResult {
5197 /**
5198 * The type of inventory item returned by the request.
5199 */
5200 TypeName?: InventoryItemTypeName;
5201 /**
5202 * The instance ID targeted by the request to query inventory information.
5203 */
5204 InstanceId?: InstanceId;
5205 /**
5206 * The inventory schema version used by the instance(s).
5207 */
5208 SchemaVersion?: InventoryItemSchemaVersion;
5209 /**
5210 * The time that inventory information was collected for the instance(s).
5211 */
5212 CaptureTime?: InventoryItemCaptureTime;
5213 /**
5214 * A list of inventory items on the instance(s).
5215 */
5216 Entries?: InventoryItemEntryList;
5217 /**
5218 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
5219 */
5220 NextToken?: NextToken;
5221 }
5222 export interface ListResourceComplianceSummariesRequest {
5223 /**
5224 * One or more filters. Use a filter to return a more specific list of results.
5225 */
5226 Filters?: ComplianceStringFilterList;
5227 /**
5228 * A token to start the list. Use this token to get the next set of results.
5229 */
5230 NextToken?: NextToken;
5231 /**
5232 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5233 */
5234 MaxResults?: MaxResults;
5235 }
5236 export interface ListResourceComplianceSummariesResult {
5237 /**
5238 * A summary count for specified or targeted managed instances. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.
5239 */
5240 ResourceComplianceSummaryItems?: ResourceComplianceSummaryItemList;
5241 /**
5242 * The token for the next set of items to return. Use this token to get the next set of results.
5243 */
5244 NextToken?: NextToken;
5245 }
5246 export interface ListResourceDataSyncRequest {
5247 /**
5248 * A token to start the list. Use this token to get the next set of results.
5249 */
5250 NextToken?: NextToken;
5251 /**
5252 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
5253 */
5254 MaxResults?: MaxResults;
5255 }
5256 export interface ListResourceDataSyncResult {
5257 /**
5258 * A list of your current Resource Data Sync configurations and their statuses.
5259 */
5260 ResourceDataSyncItems?: ResourceDataSyncItemList;
5261 /**
5262 * The token for the next set of items to return. Use this token to get the next set of results.
5263 */
5264 NextToken?: NextToken;
5265 }
5266 export interface ListTagsForResourceRequest {
5267 /**
5268 * Returns a list of tags for a specific resource type.
5269 */
5270 ResourceType: ResourceTypeForTagging;
5271 /**
5272 * The resource ID for which you want to see a list of tags.
5273 */
5274 ResourceId: ResourceId;
5275 }
5276 export interface ListTagsForResourceResult {
5277 /**
5278 * A list of tags.
5279 */
5280 TagList?: TagList;
5281 }
5282 export interface LoggingInfo {
5283 /**
5284 * The name of an Amazon S3 bucket where execution logs are stored .
5285 */
5286 S3BucketName: S3BucketName;
5287 /**
5288 * (Optional) The Amazon S3 bucket subfolder.
5289 */
5290 S3KeyPrefix?: S3KeyPrefix;
5291 /**
5292 * The region where the Amazon S3 bucket is located.
5293 */
5294 S3Region: S3Region;
5295 }
5296 export type Long = number;
5297 export type MaintenanceWindowAllowUnassociatedTargets = boolean;
5298 export interface MaintenanceWindowAutomationParameters {
5299 /**
5300 * The version of an Automation document to use during task execution.
5301 */
5302 DocumentVersion?: DocumentVersion;
5303 /**
5304 * The parameters for the AUTOMATION task. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
5305 */
5306 Parameters?: AutomationParameterMap;
5307 }
5308 export type MaintenanceWindowCutoff = number;
5309 export type MaintenanceWindowDescription = string;
5310 export type MaintenanceWindowDurationHours = number;
5311 export type MaintenanceWindowEnabled = boolean;
5312 export interface MaintenanceWindowExecution {
5313 /**
5314 * The ID of the Maintenance Window.
5315 */
5316 WindowId?: MaintenanceWindowId;
5317 /**
5318 * The ID of the Maintenance Window execution.
5319 */
5320 WindowExecutionId?: MaintenanceWindowExecutionId;
5321 /**
5322 * The status of the execution.
5323 */
5324 Status?: MaintenanceWindowExecutionStatus;
5325 /**
5326 * The details explaining the Status. Only available for certain status values.
5327 */
5328 StatusDetails?: MaintenanceWindowExecutionStatusDetails;
5329 /**
5330 * The time the execution started.
5331 */
5332 StartTime?: DateTime;
5333 /**
5334 * The time the execution finished.
5335 */
5336 EndTime?: DateTime;
5337 }
5338 export type MaintenanceWindowExecutionId = string;
5339 export type MaintenanceWindowExecutionList = MaintenanceWindowExecution[];
5340 export type MaintenanceWindowExecutionStatus = "PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|"TIMED_OUT"|"CANCELLING"|"CANCELLED"|"SKIPPED_OVERLAPPING"|string;
5341 export type MaintenanceWindowExecutionStatusDetails = string;
5342 export type MaintenanceWindowExecutionTaskExecutionId = string;
5343 export type MaintenanceWindowExecutionTaskId = string;
5344 export type MaintenanceWindowExecutionTaskIdList = MaintenanceWindowExecutionTaskId[];
5345 export interface MaintenanceWindowExecutionTaskIdentity {
5346 /**
5347 * The ID of the Maintenance Window execution that ran the task.
5348 */
5349 WindowExecutionId?: MaintenanceWindowExecutionId;
5350 /**
5351 * The ID of the specific task execution in the Maintenance Window execution.
5352 */
5353 TaskExecutionId?: MaintenanceWindowExecutionTaskId;
5354 /**
5355 * The status of the task execution.
5356 */
5357 Status?: MaintenanceWindowExecutionStatus;
5358 /**
5359 * The details explaining the status of the task execution. Only available for certain status values.
5360 */
5361 StatusDetails?: MaintenanceWindowExecutionStatusDetails;
5362 /**
5363 * The time the task execution started.
5364 */
5365 StartTime?: DateTime;
5366 /**
5367 * The time the task execution finished.
5368 */
5369 EndTime?: DateTime;
5370 /**
5371 * The ARN of the executed task.
5372 */
5373 TaskArn?: MaintenanceWindowTaskArn;
5374 /**
5375 * The type of executed task.
5376 */
5377 TaskType?: MaintenanceWindowTaskType;
5378 }
5379 export type MaintenanceWindowExecutionTaskIdentityList = MaintenanceWindowExecutionTaskIdentity[];
5380 export type MaintenanceWindowExecutionTaskInvocationId = string;
5381 export interface MaintenanceWindowExecutionTaskInvocationIdentity {
5382 /**
5383 * The ID of the Maintenance Window execution that ran the task.
5384 */
5385 WindowExecutionId?: MaintenanceWindowExecutionId;
5386 /**
5387 * The ID of the specific task execution in the Maintenance Window execution.
5388 */
5389 TaskExecutionId?: MaintenanceWindowExecutionTaskId;
5390 /**
5391 * The ID of the task invocation.
5392 */
5393 InvocationId?: MaintenanceWindowExecutionTaskInvocationId;
5394 /**
5395 * The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.
5396 */
5397 ExecutionId?: MaintenanceWindowExecutionTaskExecutionId;
5398 /**
5399 * The task type.
5400 */
5401 TaskType?: MaintenanceWindowTaskType;
5402 /**
5403 * The parameters that were provided for the invocation when it was executed.
5404 */
5405 Parameters?: MaintenanceWindowExecutionTaskInvocationParameters;
5406 /**
5407 * The status of the task invocation.
5408 */
5409 Status?: MaintenanceWindowExecutionStatus;
5410 /**
5411 * The details explaining the status of the task invocation. Only available for certain Status values.
5412 */
5413 StatusDetails?: MaintenanceWindowExecutionStatusDetails;
5414 /**
5415 * The time the invocation started.
5416 */
5417 StartTime?: DateTime;
5418 /**
5419 * The time the invocation finished.
5420 */
5421 EndTime?: DateTime;
5422 /**
5423 * User-provided value that was specified when the target was registered with the Maintenance Window. This was also included in any CloudWatch events raised during the task invocation.
5424 */
5425 OwnerInformation?: OwnerInformation;
5426 /**
5427 * The ID of the target definition in this Maintenance Window the invocation was performed for.
5428 */
5429 WindowTargetId?: MaintenanceWindowTaskTargetId;
5430 }
5431 export type MaintenanceWindowExecutionTaskInvocationIdentityList = MaintenanceWindowExecutionTaskInvocationIdentity[];
5432 export type MaintenanceWindowExecutionTaskInvocationParameters = string;
5433 export interface MaintenanceWindowFilter {
5434 /**
5435 * The name of the filter.
5436 */
5437 Key?: MaintenanceWindowFilterKey;
5438 /**
5439 * The filter values.
5440 */
5441 Values?: MaintenanceWindowFilterValues;
5442 }
5443 export type MaintenanceWindowFilterKey = string;
5444 export type MaintenanceWindowFilterList = MaintenanceWindowFilter[];
5445 export type MaintenanceWindowFilterValue = string;
5446 export type MaintenanceWindowFilterValues = MaintenanceWindowFilterValue[];
5447 export type MaintenanceWindowId = string;
5448 export interface MaintenanceWindowIdentity {
5449 /**
5450 * The ID of the Maintenance Window.
5451 */
5452 WindowId?: MaintenanceWindowId;
5453 /**
5454 * The name of the Maintenance Window.
5455 */
5456 Name?: MaintenanceWindowName;
5457 /**
5458 * A description of the Maintenance Window.
5459 */
5460 Description?: MaintenanceWindowDescription;
5461 /**
5462 * Whether the Maintenance Window is enabled.
5463 */
5464 Enabled?: MaintenanceWindowEnabled;
5465 /**
5466 * The duration of the Maintenance Window in hours.
5467 */
5468 Duration?: MaintenanceWindowDurationHours;
5469 /**
5470 * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
5471 */
5472 Cutoff?: MaintenanceWindowCutoff;
5473 /**
5474 * The schedule of the Maintenance Window in the form of a cron or rate expression.
5475 */
5476 Schedule?: MaintenanceWindowSchedule;
5477 /**
5478 * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
5479 */
5480 ScheduleTimezone?: MaintenanceWindowTimezone;
5481 /**
5482 * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become inactive.
5483 */
5484 EndDate?: MaintenanceWindowStringDateTime;
5485 /**
5486 * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become active.
5487 */
5488 StartDate?: MaintenanceWindowStringDateTime;
5489 /**
5490 * The next time the Maintenance Window will actually run, taking into account any specified times for the Maintenance Window to become active or inactive.
5491 */
5492 NextExecutionTime?: MaintenanceWindowStringDateTime;
5493 }
5494 export interface MaintenanceWindowIdentityForTarget {
5495 /**
5496 * The ID of the Maintenance Window.
5497 */
5498 WindowId?: MaintenanceWindowId;
5499 /**
5500 * The name of the Maintenance Window.
5501 */
5502 Name?: MaintenanceWindowName;
5503 }
5504 export type MaintenanceWindowIdentityList = MaintenanceWindowIdentity[];
5505 export type MaintenanceWindowLambdaClientContext = string;
5506 export interface MaintenanceWindowLambdaParameters {
5507 /**
5508 * Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.
5509 */
5510 ClientContext?: MaintenanceWindowLambdaClientContext;
5511 /**
5512 * (Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.
5513 */
5514 Qualifier?: MaintenanceWindowLambdaQualifier;
5515 /**
5516 * JSON to provide to your Lambda function as input.
5517 */
5518 Payload?: MaintenanceWindowLambdaPayload;
5519 }
5520 export type MaintenanceWindowLambdaPayload = Buffer|Uint8Array|Blob|string;
5521 export type MaintenanceWindowLambdaQualifier = string;
5522 export type MaintenanceWindowMaxResults = number;
5523 export type MaintenanceWindowName = string;
5524 export type MaintenanceWindowResourceType = "INSTANCE"|string;
5525 export interface MaintenanceWindowRunCommandParameters {
5526 /**
5527 * Information about the command(s) to execute.
5528 */
5529 Comment?: Comment;
5530 /**
5531 * The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
5532 */
5533 DocumentHash?: DocumentHash;
5534 /**
5535 * SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
5536 */
5537 DocumentHashType?: DocumentHashType;
5538 /**
5539 * Configurations for sending notifications about command status changes on a per-instance basis.
5540 */
5541 NotificationConfig?: NotificationConfig;
5542 /**
5543 * The name of the Amazon S3 bucket.
5544 */
5545 OutputS3BucketName?: S3BucketName;
5546 /**
5547 * The Amazon S3 bucket subfolder.
5548 */
5549 OutputS3KeyPrefix?: S3KeyPrefix;
5550 /**
5551 * The parameters for the RUN_COMMAND task execution.
5552 */
5553 Parameters?: Parameters;
5554 /**
5555 * The IAM service role to assume during task execution.
5556 */
5557 ServiceRoleArn?: ServiceRole;
5558 /**
5559 * If this time is reached and the command has not already started executing, it doesn't run.
5560 */
5561 TimeoutSeconds?: TimeoutSeconds;
5562 }
5563 export type MaintenanceWindowSchedule = string;
5564 export type MaintenanceWindowSearchMaxResults = number;
5565 export type MaintenanceWindowStepFunctionsInput = string;
5566 export type MaintenanceWindowStepFunctionsName = string;
5567 export interface MaintenanceWindowStepFunctionsParameters {
5568 /**
5569 * The inputs for the STEP_FUNCTION task.
5570 */
5571 Input?: MaintenanceWindowStepFunctionsInput;
5572 /**
5573 * The name of the STEP_FUNCTION task.
5574 */
5575 Name?: MaintenanceWindowStepFunctionsName;
5576 }
5577 export type MaintenanceWindowStringDateTime = string;
5578 export interface MaintenanceWindowTarget {
5579 /**
5580 * The Maintenance Window ID where the target is registered.
5581 */
5582 WindowId?: MaintenanceWindowId;
5583 /**
5584 * The ID of the target.
5585 */
5586 WindowTargetId?: MaintenanceWindowTargetId;
5587 /**
5588 * The type of target.
5589 */
5590 ResourceType?: MaintenanceWindowResourceType;
5591 /**
5592 * The targets (either instances or tags). Instances are specified using Key=instanceids,Values=&lt;instanceid1&gt;,&lt;instanceid2&gt;. Tags are specified using Key=&lt;tag name&gt;,Values=&lt;tag value&gt;.
5593 */
5594 Targets?: Targets;
5595 /**
5596 * User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
5597 */
5598 OwnerInformation?: OwnerInformation;
5599 /**
5600 * The target name.
5601 */
5602 Name?: MaintenanceWindowName;
5603 /**
5604 * A description of the target.
5605 */
5606 Description?: MaintenanceWindowDescription;
5607 }
5608 export type MaintenanceWindowTargetId = string;
5609 export type MaintenanceWindowTargetList = MaintenanceWindowTarget[];
5610 export interface MaintenanceWindowTask {
5611 /**
5612 * The Maintenance Window ID where the task is registered.
5613 */
5614 WindowId?: MaintenanceWindowId;
5615 /**
5616 * The task ID.
5617 */
5618 WindowTaskId?: MaintenanceWindowTaskId;
5619 /**
5620 * The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN.
5621 */
5622 TaskArn?: MaintenanceWindowTaskArn;
5623 /**
5624 * The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
5625 */
5626 Type?: MaintenanceWindowTaskType;
5627 /**
5628 * The targets (either instances or tags). Instances are specified using Key=instanceids,Values=&lt;instanceid1&gt;,&lt;instanceid2&gt;. Tags are specified using Key=&lt;tag name&gt;,Values=&lt;tag value&gt;.
5629 */
5630 Targets?: Targets;
5631 /**
5632 * The parameters that should be passed to the task when it is executed. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
5633 */
5634 TaskParameters?: MaintenanceWindowTaskParameters;
5635 /**
5636 * The priority of the task in the Maintenance Window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
5637 */
5638 Priority?: MaintenanceWindowTaskPriority;
5639 /**
5640 * Information about an Amazon S3 bucket to write task-level logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
5641 */
5642 LoggingInfo?: LoggingInfo;
5643 /**
5644 * The role that should be assumed when executing the task
5645 */
5646 ServiceRoleArn?: ServiceRole;
5647 /**
5648 * The maximum number of targets this task can be run for in parallel.
5649 */
5650 MaxConcurrency?: MaxConcurrency;
5651 /**
5652 * The maximum number of errors allowed before this task stops being scheduled.
5653 */
5654 MaxErrors?: MaxErrors;
5655 /**
5656 * The task name.
5657 */
5658 Name?: MaintenanceWindowName;
5659 /**
5660 * A description of the task.
5661 */
5662 Description?: MaintenanceWindowDescription;
5663 }
5664 export type MaintenanceWindowTaskArn = string;
5665 export type MaintenanceWindowTaskId = string;
5666 export interface MaintenanceWindowTaskInvocationParameters {
5667 /**
5668 * The parameters for a RUN_COMMAND task type.
5669 */
5670 RunCommand?: MaintenanceWindowRunCommandParameters;
5671 /**
5672 * The parameters for an AUTOMATION task type.
5673 */
5674 Automation?: MaintenanceWindowAutomationParameters;
5675 /**
5676 * The parameters for a STEP_FUNCTION task type.
5677 */
5678 StepFunctions?: MaintenanceWindowStepFunctionsParameters;
5679 /**
5680 * The parameters for a LAMBDA task type.
5681 */
5682 Lambda?: MaintenanceWindowLambdaParameters;
5683 }
5684 export type MaintenanceWindowTaskList = MaintenanceWindowTask[];
5685 export type MaintenanceWindowTaskParameterName = string;
5686 export type MaintenanceWindowTaskParameterValue = string;
5687 export interface MaintenanceWindowTaskParameterValueExpression {
5688 /**
5689 * This field contains an array of 0 or more strings, each 1 to 255 characters in length.
5690 */
5691 Values?: MaintenanceWindowTaskParameterValueList;
5692 }
5693 export type MaintenanceWindowTaskParameterValueList = MaintenanceWindowTaskParameterValue[];
5694 export type MaintenanceWindowTaskParameters = {[key: string]: MaintenanceWindowTaskParameterValueExpression};
5695 export type MaintenanceWindowTaskParametersList = MaintenanceWindowTaskParameters[];
5696 export type MaintenanceWindowTaskPriority = number;
5697 export type MaintenanceWindowTaskTargetId = string;
5698 export type MaintenanceWindowTaskType = "RUN_COMMAND"|"AUTOMATION"|"STEP_FUNCTIONS"|"LAMBDA"|string;
5699 export type MaintenanceWindowTimezone = string;
5700 export type MaintenanceWindowsForTargetList = MaintenanceWindowIdentityForTarget[];
5701 export type ManagedInstanceId = string;
5702 export type MaxConcurrency = string;
5703 export type MaxErrors = string;
5704 export type MaxResults = number;
5705 export type MaxResultsEC2Compatible = number;
5706 export interface ModifyDocumentPermissionRequest {
5707 /**
5708 * The name of the document that you want to share.
5709 */
5710 Name: DocumentName;
5711 /**
5712 * The permission type for the document. The permission type can be Share.
5713 */
5714 PermissionType: DocumentPermissionType;
5715 /**
5716 * The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
5717 */
5718 AccountIdsToAdd?: AccountIdList;
5719 /**
5720 * The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
5721 */
5722 AccountIdsToRemove?: AccountIdList;
5723 }
5724 export interface ModifyDocumentPermissionResponse {
5725 }
5726 export type NextToken = string;
5727 export interface NonCompliantSummary {
5728 /**
5729 * The total number of compliance items that are not compliant.
5730 */
5731 NonCompliantCount?: ComplianceSummaryCount;
5732 /**
5733 * A summary of the non-compliance severity by compliance type
5734 */
5735 SeveritySummary?: SeveritySummary;
5736 }
5737 export type NormalStringMap = {[key: string]: String};
5738 export type NotificationArn = string;
5739 export interface NotificationConfig {
5740 /**
5741 * An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
5742 */
5743 NotificationArn?: NotificationArn;
5744 /**
5745 * The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.
5746 */
5747 NotificationEvents?: NotificationEventList;
5748 /**
5749 * Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
5750 */
5751 NotificationType?: NotificationType;
5752 }
5753 export type NotificationEvent = "All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
5754 export type NotificationEventList = NotificationEvent[];
5755 export type NotificationType = "Command"|"Invocation"|string;
5756 export type OperatingSystem = "WINDOWS"|"AMAZON_LINUX"|"AMAZON_LINUX_2"|"UBUNTU"|"REDHAT_ENTERPRISE_LINUX"|"SUSE"|"CENTOS"|string;
5757 export interface OutputSource {
5758 /**
5759 * The ID of the output source, for example the URL of an Amazon S3 bucket.
5760 */
5761 OutputSourceId?: OutputSourceId;
5762 /**
5763 * The type of source where the association execution details are stored, for example, Amazon S3.
5764 */
5765 OutputSourceType?: OutputSourceType;
5766 }
5767 export type OutputSourceId = string;
5768 export type OutputSourceType = string;
5769 export type OwnerInformation = string;
5770 export type PSParameterName = string;
5771 export type PSParameterSelector = string;
5772 export type PSParameterValue = string;
5773 export type PSParameterVersion = number;
5774 export interface Parameter {
5775 /**
5776 * The name of the parameter.
5777 */
5778 Name?: PSParameterName;
5779 /**
5780 * The type of parameter. Valid values include the following: String, String list, Secure string.
5781 */
5782 Type?: ParameterType;
5783 /**
5784 * The parameter value.
5785 */
5786 Value?: PSParameterValue;
5787 /**
5788 * The parameter version.
5789 */
5790 Version?: PSParameterVersion;
5791 /**
5792 * Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats: parameter_name:version parameter_name:label
5793 */
5794 Selector?: PSParameterSelector;
5795 /**
5796 * Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
5797 */
5798 SourceResult?: String;
5799 /**
5800 * Date the parameter was last changed or updated and the parameter version was created.
5801 */
5802 LastModifiedDate?: DateTime;
5803 /**
5804 * The Amazon Resource Name (ARN) of the parameter.
5805 */
5806 ARN?: String;
5807 }
5808 export type ParameterDescription = string;
5809 export interface ParameterHistory {
5810 /**
5811 * The name of the parameter.
5812 */
5813 Name?: PSParameterName;
5814 /**
5815 * The type of parameter used.
5816 */
5817 Type?: ParameterType;
5818 /**
5819 * The ID of the query key used for this parameter.
5820 */
5821 KeyId?: ParameterKeyId;
5822 /**
5823 * Date the parameter was last changed or updated.
5824 */
5825 LastModifiedDate?: DateTime;
5826 /**
5827 * Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
5828 */
5829 LastModifiedUser?: String;
5830 /**
5831 * Information about the parameter.
5832 */
5833 Description?: ParameterDescription;
5834 /**
5835 * The parameter value.
5836 */
5837 Value?: PSParameterValue;
5838 /**
5839 * Parameter names can include the following letters and symbols. a-zA-Z0-9_.-
5840 */
5841 AllowedPattern?: AllowedPattern;
5842 /**
5843 * The parameter version.
5844 */
5845 Version?: PSParameterVersion;
5846 /**
5847 * Labels assigned to the parameter version.
5848 */
5849 Labels?: ParameterLabelList;
5850 }
5851 export type ParameterHistoryList = ParameterHistory[];
5852 export type ParameterKeyId = string;
5853 export type ParameterLabel = string;
5854 export type ParameterLabelList = ParameterLabel[];
5855 export type ParameterList = Parameter[];
5856 export interface ParameterMetadata {
5857 /**
5858 * The parameter name.
5859 */
5860 Name?: PSParameterName;
5861 /**
5862 * The type of parameter. Valid parameter types include the following: String, String list, Secure string.
5863 */
5864 Type?: ParameterType;
5865 /**
5866 * The ID of the query key used for this parameter.
5867 */
5868 KeyId?: ParameterKeyId;
5869 /**
5870 * Date the parameter was last changed or updated.
5871 */
5872 LastModifiedDate?: DateTime;
5873 /**
5874 * Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
5875 */
5876 LastModifiedUser?: String;
5877 /**
5878 * Description of the parameter actions.
5879 */
5880 Description?: ParameterDescription;
5881 /**
5882 * A parameter name can include only the following letters and symbols. a-zA-Z0-9_.-
5883 */
5884 AllowedPattern?: AllowedPattern;
5885 /**
5886 * The parameter version.
5887 */
5888 Version?: PSParameterVersion;
5889 }
5890 export type ParameterMetadataList = ParameterMetadata[];
5891 export type ParameterName = string;
5892 export type ParameterNameList = PSParameterName[];
5893 export interface ParameterStringFilter {
5894 /**
5895 * The name of the filter.
5896 */
5897 Key: ParameterStringFilterKey;
5898 /**
5899 * Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
5900 */
5901 Option?: ParameterStringQueryOption;
5902 /**
5903 * The value you want to search for.
5904 */
5905 Values?: ParameterStringFilterValueList;
5906 }
5907 export type ParameterStringFilterKey = string;
5908 export type ParameterStringFilterList = ParameterStringFilter[];
5909 export type ParameterStringFilterValue = string;
5910 export type ParameterStringFilterValueList = ParameterStringFilterValue[];
5911 export type ParameterStringQueryOption = string;
5912 export type ParameterType = "String"|"StringList"|"SecureString"|string;
5913 export type ParameterValue = string;
5914 export type ParameterValueList = ParameterValue[];
5915 export type Parameters = {[key: string]: ParameterValueList};
5916 export interface ParametersFilter {
5917 /**
5918 * The name of the filter.
5919 */
5920 Key: ParametersFilterKey;
5921 /**
5922 * The filter values.
5923 */
5924 Values: ParametersFilterValueList;
5925 }
5926 export type ParametersFilterKey = "Name"|"Type"|"KeyId"|string;
5927 export type ParametersFilterList = ParametersFilter[];
5928 export type ParametersFilterValue = string;
5929 export type ParametersFilterValueList = ParametersFilterValue[];
5930 export interface Patch {
5931 /**
5932 * The ID of the patch (this is different than the Microsoft Knowledge Base ID).
5933 */
5934 Id?: PatchId;
5935 /**
5936 * The date the patch was released.
5937 */
5938 ReleaseDate?: DateTime;
5939 /**
5940 * The title of the patch.
5941 */
5942 Title?: PatchTitle;
5943 /**
5944 * The description of the patch.
5945 */
5946 Description?: PatchDescription;
5947 /**
5948 * The URL where more information can be obtained about the patch.
5949 */
5950 ContentUrl?: PatchContentUrl;
5951 /**
5952 * The name of the vendor providing the patch.
5953 */
5954 Vendor?: PatchVendor;
5955 /**
5956 * The product family the patch is applicable for (for example, Windows).
5957 */
5958 ProductFamily?: PatchProductFamily;
5959 /**
5960 * The specific product the patch is applicable for (for example, WindowsServer2016).
5961 */
5962 Product?: PatchProduct;
5963 /**
5964 * The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
5965 */
5966 Classification?: PatchClassification;
5967 /**
5968 * The severity of the patch (for example Critical, Important, Moderate).
5969 */
5970 MsrcSeverity?: PatchMsrcSeverity;
5971 /**
5972 * The Microsoft Knowledge Base ID of the patch.
5973 */
5974 KbNumber?: PatchKbNumber;
5975 /**
5976 * The ID of the MSRC bulletin the patch is related to.
5977 */
5978 MsrcNumber?: PatchMsrcNumber;
5979 /**
5980 * The language of the patch if it's language-specific.
5981 */
5982 Language?: PatchLanguage;
5983 }
5984 export type PatchAction = "ALLOW_AS_DEPENDENCY"|"BLOCK"|string;
5985 export interface PatchBaselineIdentity {
5986 /**
5987 * The ID of the patch baseline.
5988 */
5989 BaselineId?: BaselineId;
5990 /**
5991 * The name of the patch baseline.
5992 */
5993 BaselineName?: BaselineName;
5994 /**
5995 * Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
5996 */
5997 OperatingSystem?: OperatingSystem;
5998 /**
5999 * The description of the patch baseline.
6000 */
6001 BaselineDescription?: BaselineDescription;
6002 /**
6003 * Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
6004 */
6005 DefaultBaseline?: DefaultBaseline;
6006 }
6007 export type PatchBaselineIdentityList = PatchBaselineIdentity[];
6008 export type PatchBaselineMaxResults = number;
6009 export type PatchClassification = string;
6010 export interface PatchComplianceData {
6011 /**
6012 * The title of the patch.
6013 */
6014 Title: PatchTitle;
6015 /**
6016 * The operating system-specific ID of the patch.
6017 */
6018 KBId: PatchKbNumber;
6019 /**
6020 * The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
6021 */
6022 Classification: PatchClassification;
6023 /**
6024 * The severity of the patch (for example, Critical, Important, Moderate).
6025 */
6026 Severity: PatchSeverity;
6027 /**
6028 * The state of the patch on the instance, such as INSTALLED or FAILED. For descriptions of each patch state, see About Patch Compliance in the AWS Systems Manager User Guide.
6029 */
6030 State: PatchComplianceDataState;
6031 /**
6032 * The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.
6033 */
6034 InstalledTime: DateTime;
6035 }
6036 export type PatchComplianceDataList = PatchComplianceData[];
6037 export type PatchComplianceDataState = "INSTALLED"|"INSTALLED_OTHER"|"INSTALLED_REJECTED"|"MISSING"|"NOT_APPLICABLE"|"FAILED"|string;
6038 export type PatchComplianceLevel = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED"|string;
6039 export type PatchComplianceMaxResults = number;
6040 export type PatchContentUrl = string;
6041 export type PatchDeploymentStatus = "APPROVED"|"PENDING_APPROVAL"|"EXPLICIT_APPROVED"|"EXPLICIT_REJECTED"|string;
6042 export type PatchDescription = string;
6043 export type PatchFailedCount = number;
6044 export interface PatchFilter {
6045 /**
6046 * The key for the filter. See PatchFilter for lists of valid keys for each operating system type.
6047 */
6048 Key: PatchFilterKey;
6049 /**
6050 * The value for the filter key. See PatchFilter for lists of valid values for each key based on operating system type.
6051 */
6052 Values: PatchFilterValueList;
6053 }
6054 export interface PatchFilterGroup {
6055 /**
6056 * The set of patch filters that make up the group.
6057 */
6058 PatchFilters: PatchFilterList;
6059 }
6060 export type PatchFilterKey = "PRODUCT"|"CLASSIFICATION"|"MSRC_SEVERITY"|"PATCH_ID"|"SECTION"|"PRIORITY"|"SEVERITY"|string;
6061 export type PatchFilterList = PatchFilter[];
6062 export type PatchFilterValue = string;
6063 export type PatchFilterValueList = PatchFilterValue[];
6064 export type PatchGroup = string;
6065 export type PatchGroupList = PatchGroup[];
6066 export interface PatchGroupPatchBaselineMapping {
6067 /**
6068 * The name of the patch group registered with the patch baseline.
6069 */
6070 PatchGroup?: PatchGroup;
6071 /**
6072 * The patch baseline the patch group is registered with.
6073 */
6074 BaselineIdentity?: PatchBaselineIdentity;
6075 }
6076 export type PatchGroupPatchBaselineMappingList = PatchGroupPatchBaselineMapping[];
6077 export type PatchId = string;
6078 export type PatchIdList = PatchId[];
6079 export type PatchInstalledCount = number;
6080 export type PatchInstalledOtherCount = number;
6081 export type PatchInstalledRejectedCount = number;
6082 export type PatchKbNumber = string;
6083 export type PatchLanguage = string;
6084 export type PatchList = Patch[];
6085 export type PatchMissingCount = number;
6086 export type PatchMsrcNumber = string;
6087 export type PatchMsrcSeverity = string;
6088 export type PatchNotApplicableCount = number;
6089 export type PatchOperationType = "Scan"|"Install"|string;
6090 export interface PatchOrchestratorFilter {
6091 /**
6092 * The key for the filter.
6093 */
6094 Key?: PatchOrchestratorFilterKey;
6095 /**
6096 * The value for the filter.
6097 */
6098 Values?: PatchOrchestratorFilterValues;
6099 }
6100 export type PatchOrchestratorFilterKey = string;
6101 export type PatchOrchestratorFilterList = PatchOrchestratorFilter[];
6102 export type PatchOrchestratorFilterValue = string;
6103 export type PatchOrchestratorFilterValues = PatchOrchestratorFilterValue[];
6104 export type PatchProduct = string;
6105 export type PatchProductFamily = string;
6106 export interface PatchRule {
6107 /**
6108 * The patch filter group that defines the criteria for the rule.
6109 */
6110 PatchFilterGroup: PatchFilterGroup;
6111 /**
6112 * A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.
6113 */
6114 ComplianceLevel?: PatchComplianceLevel;
6115 /**
6116 * The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.
6117 */
6118 ApproveAfterDays: ApproveAfterDays;
6119 /**
6120 * For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.
6121 */
6122 EnableNonSecurity?: Boolean;
6123 }
6124 export interface PatchRuleGroup {
6125 /**
6126 * The rules that make up the rule group.
6127 */
6128 PatchRules: PatchRuleList;
6129 }
6130 export type PatchRuleList = PatchRule[];
6131 export type PatchSeverity = string;
6132 export interface PatchSource {
6133 /**
6134 * The name specified to identify the patch source.
6135 */
6136 Name: PatchSourceName;
6137 /**
6138 * The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter.
6139 */
6140 Products: PatchSourceProductList;
6141 /**
6142 * The value of the yum repo configuration. For example: [main] cachedir=/var/cache/yum/$basesearch$releasever keepcache=0 debuglevel=2
6143 */
6144 Configuration: PatchSourceConfiguration;
6145 }
6146 export type PatchSourceConfiguration = string;
6147 export type PatchSourceList = PatchSource[];
6148 export type PatchSourceName = string;
6149 export type PatchSourceProduct = string;
6150 export type PatchSourceProductList = PatchSourceProduct[];
6151 export interface PatchStatus {
6152 /**
6153 * The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED).
6154 */
6155 DeploymentStatus?: PatchDeploymentStatus;
6156 /**
6157 * The compliance severity level for a patch.
6158 */
6159 ComplianceLevel?: PatchComplianceLevel;
6160 /**
6161 * The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).
6162 */
6163 ApprovalDate?: DateTime;
6164 }
6165 export type PatchTitle = string;
6166 export type PatchVendor = string;
6167 export type PingStatus = "Online"|"ConnectionLost"|"Inactive"|string;
6168 export type PlatformType = "Windows"|"Linux"|string;
6169 export type PlatformTypeList = PlatformType[];
6170 export type Product = string;
6171 export interface ProgressCounters {
6172 /**
6173 * The total number of steps executed in all specified AWS Regions and accounts for the current Automation execution.
6174 */
6175 TotalSteps?: Integer;
6176 /**
6177 * The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution.
6178 */
6179 SuccessSteps?: Integer;
6180 /**
6181 * The total number of steps that failed to execute in all specified AWS Regions and accounts for the current Automation execution.
6182 */
6183 FailedSteps?: Integer;
6184 /**
6185 * The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution.
6186 */
6187 CancelledSteps?: Integer;
6188 /**
6189 * The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution.
6190 */
6191 TimedOutSteps?: Integer;
6192 }
6193 export interface PutComplianceItemsRequest {
6194 /**
6195 * Specify an ID for this resource. For a managed instance, this is the instance ID.
6196 */
6197 ResourceId: ComplianceResourceId;
6198 /**
6199 * Specify the type of resource. ManagedInstance is currently the only supported resource type.
6200 */
6201 ResourceType: ComplianceResourceType;
6202 /**
6203 * Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.
6204 */
6205 ComplianceType: ComplianceTypeName;
6206 /**
6207 * A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
6208 */
6209 ExecutionSummary: ComplianceExecutionSummary;
6210 /**
6211 * Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, etc.
6212 */
6213 Items: ComplianceItemEntryList;
6214 /**
6215 * MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.
6216 */
6217 ItemContentHash?: ComplianceItemContentHash;
6218 }
6219 export interface PutComplianceItemsResult {
6220 }
6221 export type PutInventoryMessage = string;
6222 export interface PutInventoryRequest {
6223 /**
6224 * One or more instance IDs where you want to add or update inventory items.
6225 */
6226 InstanceId: InstanceId;
6227 /**
6228 * The inventory items that you want to add or update on instances.
6229 */
6230 Items: InventoryItemList;
6231 }
6232 export interface PutInventoryResult {
6233 /**
6234 * Information about the request.
6235 */
6236 Message?: PutInventoryMessage;
6237 }
6238 export interface PutParameterRequest {
6239 /**
6240 * The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13 Naming Constraints: Parameter names are case sensitive. A parameter name must be unique within an AWS Region A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive). Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/ A parameter name can't include spaces. Parameter hierarchies are limited to a maximum depth of fifteen levels. For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide. The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.
6241 */
6242 Name: PSParameterName;
6243 /**
6244 * Information about the parameter that you want to add to the system. Optional but recommended. Do not enter personally identifiable information in this field.
6245 */
6246 Description?: ParameterDescription;
6247 /**
6248 * The parameter value that you want to add to the system.
6249 */
6250 Value: PSParameterValue;
6251 /**
6252 * The type of parameter that you want to add to the system. Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type. SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
6253 */
6254 Type: ParameterType;
6255 /**
6256 * The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account. To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key. To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
6257 */
6258 KeyId?: ParameterKeyId;
6259 /**
6260 * Overwrite an existing parameter. If not specified, will default to "false".
6261 */
6262 Overwrite?: Boolean;
6263 /**
6264 * A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
6265 */
6266 AllowedPattern?: AllowedPattern;
6267 /**
6268 * Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs: Key=Resource,Value=S3bucket Key=OS,Value=Windows Key=ParameterType,Value=LicenseKey To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
6269 */
6270 Tags?: TagList;
6271 }
6272 export interface PutParameterResult {
6273 /**
6274 * The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.
6275 */
6276 Version?: PSParameterVersion;
6277 }
6278 export type Region = string;
6279 export type Regions = Region[];
6280 export interface RegisterDefaultPatchBaselineRequest {
6281 /**
6282 * The ID of the patch baseline that should be the default patch baseline.
6283 */
6284 BaselineId: BaselineId;
6285 }
6286 export interface RegisterDefaultPatchBaselineResult {
6287 /**
6288 * The ID of the default patch baseline.
6289 */
6290 BaselineId?: BaselineId;
6291 }
6292 export interface RegisterPatchBaselineForPatchGroupRequest {
6293 /**
6294 * The ID of the patch baseline to register the patch group with.
6295 */
6296 BaselineId: BaselineId;
6297 /**
6298 * The name of the patch group that should be registered with the patch baseline.
6299 */
6300 PatchGroup: PatchGroup;
6301 }
6302 export interface RegisterPatchBaselineForPatchGroupResult {
6303 /**
6304 * The ID of the patch baseline the patch group was registered with.
6305 */
6306 BaselineId?: BaselineId;
6307 /**
6308 * The name of the patch group registered with the patch baseline.
6309 */
6310 PatchGroup?: PatchGroup;
6311 }
6312 export interface RegisterTargetWithMaintenanceWindowRequest {
6313 /**
6314 * The ID of the Maintenance Window the target should be registered with.
6315 */
6316 WindowId: MaintenanceWindowId;
6317 /**
6318 * The type of target being registered with the Maintenance Window.
6319 */
6320 ResourceType: MaintenanceWindowResourceType;
6321 /**
6322 * The targets (either instances or tags). Specify instances using the following format: Key=InstanceIds,Values=&lt;instance-id-1&gt;,&lt;instance-id-2&gt; Specify tags using either of the following formats: Key=tag:&lt;tag-key&gt;,Values=&lt;tag-value-1&gt;,&lt;tag-value-2&gt; Key=tag-key,Values=&lt;tag-key-1&gt;,&lt;tag-key-2&gt;
6323 */
6324 Targets: Targets;
6325 /**
6326 * User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
6327 */
6328 OwnerInformation?: OwnerInformation;
6329 /**
6330 * An optional name for the target.
6331 */
6332 Name?: MaintenanceWindowName;
6333 /**
6334 * An optional description for the target.
6335 */
6336 Description?: MaintenanceWindowDescription;
6337 /**
6338 * User-provided idempotency token.
6339 */
6340 ClientToken?: ClientToken;
6341 }
6342 export interface RegisterTargetWithMaintenanceWindowResult {
6343 /**
6344 * The ID of the target definition in this Maintenance Window.
6345 */
6346 WindowTargetId?: MaintenanceWindowTargetId;
6347 }
6348 export interface RegisterTaskWithMaintenanceWindowRequest {
6349 /**
6350 * The ID of the Maintenance Window the task should be added to.
6351 */
6352 WindowId: MaintenanceWindowId;
6353 /**
6354 * The targets (either instances or Maintenance Window targets). Specify instances using the following format: Key=InstanceIds,Values=&lt;instance-id-1&gt;,&lt;instance-id-2&gt; Specify Maintenance Window targets using the following format: Key=&lt;WindowTargetIds&gt;,Values=&lt;window-target-id-1&gt;,&lt;window-target-id-2&gt;
6355 */
6356 Targets: Targets;
6357 /**
6358 * The ARN of the task to execute
6359 */
6360 TaskArn: MaintenanceWindowTaskArn;
6361 /**
6362 * The role to assume when running the Maintenance Window task. If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN. For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.
6363 */
6364 ServiceRoleArn?: ServiceRole;
6365 /**
6366 * The type of task being registered.
6367 */
6368 TaskType: MaintenanceWindowTaskType;
6369 /**
6370 * The parameters that should be passed to the task when it is executed. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
6371 */
6372 TaskParameters?: MaintenanceWindowTaskParameters;
6373 /**
6374 * The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
6375 */
6376 TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
6377 /**
6378 * The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
6379 */
6380 Priority?: MaintenanceWindowTaskPriority;
6381 /**
6382 * The maximum number of targets this task can be run for in parallel.
6383 */
6384 MaxConcurrency: MaxConcurrency;
6385 /**
6386 * The maximum number of errors allowed before this task stops being scheduled.
6387 */
6388 MaxErrors: MaxErrors;
6389 /**
6390 * A structure containing information about an Amazon S3 bucket to write instance-level logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
6391 */
6392 LoggingInfo?: LoggingInfo;
6393 /**
6394 * An optional name for the task.
6395 */
6396 Name?: MaintenanceWindowName;
6397 /**
6398 * An optional description for the task.
6399 */
6400 Description?: MaintenanceWindowDescription;
6401 /**
6402 * User-provided idempotency token.
6403 */
6404 ClientToken?: ClientToken;
6405 }
6406 export interface RegisterTaskWithMaintenanceWindowResult {
6407 /**
6408 * The ID of the task in the Maintenance Window.
6409 */
6410 WindowTaskId?: MaintenanceWindowTaskId;
6411 }
6412 export type RegistrationLimit = number;
6413 export type RegistrationsCount = number;
6414 export type RemainingCount = number;
6415 export interface RemoveTagsFromResourceRequest {
6416 /**
6417 * The type of resource of which you want to remove a tag. The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
6418 */
6419 ResourceType: ResourceTypeForTagging;
6420 /**
6421 * The resource ID for which you want to remove tags. Use the ID of the resource. Here are some examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde For the Document and Parameter values, use the name of the resource. The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
6422 */
6423 ResourceId: ResourceId;
6424 /**
6425 * Tag keys that you want to remove from the specified resource.
6426 */
6427 TagKeys: KeyList;
6428 }
6429 export interface RemoveTagsFromResourceResult {
6430 }
6431 export interface ResetServiceSettingRequest {
6432 /**
6433 * The ID of the service setting to reset.
6434 */
6435 SettingId: ServiceSettingId;
6436 }
6437 export interface ResetServiceSettingResult {
6438 /**
6439 * The current, effective service setting after calling the ResetServiceSetting API action.
6440 */
6441 ServiceSetting?: ServiceSetting;
6442 }
6443 export interface ResolvedTargets {
6444 /**
6445 * A list of parameter values sent to targets that resolved during the Automation execution.
6446 */
6447 ParameterValues?: TargetParameterList;
6448 /**
6449 * A boolean value indicating whether the resolved target list is truncated.
6450 */
6451 Truncated?: Boolean;
6452 }
6453 export interface ResourceComplianceSummaryItem {
6454 /**
6455 * The compliance type.
6456 */
6457 ComplianceType?: ComplianceTypeName;
6458 /**
6459 * The resource type.
6460 */
6461 ResourceType?: ComplianceResourceType;
6462 /**
6463 * The resource ID.
6464 */
6465 ResourceId?: ComplianceResourceId;
6466 /**
6467 * The compliance status for the resource.
6468 */
6469 Status?: ComplianceStatus;
6470 /**
6471 * The highest severity item found for the resource. The resource is compliant for this item.
6472 */
6473 OverallSeverity?: ComplianceSeverity;
6474 /**
6475 * Information about the execution.
6476 */
6477 ExecutionSummary?: ComplianceExecutionSummary;
6478 /**
6479 * A list of items that are compliant for the resource.
6480 */
6481 CompliantSummary?: CompliantSummary;
6482 /**
6483 * A list of items that aren't compliant for the resource.
6484 */
6485 NonCompliantSummary?: NonCompliantSummary;
6486 }
6487 export type ResourceComplianceSummaryItemList = ResourceComplianceSummaryItem[];
6488 export type ResourceCount = number;
6489 export type ResourceCountByStatus = string;
6490 export type ResourceDataSyncAWSKMSKeyARN = string;
6491 export type ResourceDataSyncCreatedTime = Date;
6492 export interface ResourceDataSyncItem {
6493 /**
6494 * The name of the Resource Data Sync.
6495 */
6496 SyncName?: ResourceDataSyncName;
6497 /**
6498 * Configuration information for the target Amazon S3 bucket.
6499 */
6500 S3Destination?: ResourceDataSyncS3Destination;
6501 /**
6502 * The last time the configuration attempted to sync (UTC).
6503 */
6504 LastSyncTime?: LastResourceDataSyncTime;
6505 /**
6506 * The last time the sync operations returned a status of SUCCESSFUL (UTC).
6507 */
6508 LastSuccessfulSyncTime?: LastSuccessfulResourceDataSyncTime;
6509 /**
6510 * The status reported by the last sync.
6511 */
6512 LastStatus?: LastResourceDataSyncStatus;
6513 /**
6514 * The date and time the configuration was created (UTC).
6515 */
6516 SyncCreatedTime?: ResourceDataSyncCreatedTime;
6517 /**
6518 * The status message details reported by the last sync.
6519 */
6520 LastSyncStatusMessage?: LastResourceDataSyncMessage;
6521 }
6522 export type ResourceDataSyncItemList = ResourceDataSyncItem[];
6523 export type ResourceDataSyncName = string;
6524 export type ResourceDataSyncS3BucketName = string;
6525 export interface ResourceDataSyncS3Destination {
6526 /**
6527 * The name of the Amazon S3 bucket where the aggregated data is stored.
6528 */
6529 BucketName: ResourceDataSyncS3BucketName;
6530 /**
6531 * An Amazon S3 prefix for the bucket.
6532 */
6533 Prefix?: ResourceDataSyncS3Prefix;
6534 /**
6535 * A supported sync format. The following format is currently supported: JsonSerDe
6536 */
6537 SyncFormat: ResourceDataSyncS3Format;
6538 /**
6539 * The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.
6540 */
6541 Region: ResourceDataSyncS3Region;
6542 /**
6543 * The ARN of an encryption key for a destination in Amazon S3. Must belong to the same region as the destination Amazon S3 bucket.
6544 */
6545 AWSKMSKeyARN?: ResourceDataSyncAWSKMSKeyARN;
6546 }
6547 export type ResourceDataSyncS3Format = "JsonSerDe"|string;
6548 export type ResourceDataSyncS3Prefix = string;
6549 export type ResourceDataSyncS3Region = string;
6550 export type ResourceId = string;
6551 export type ResourceType = "ManagedInstance"|"Document"|"EC2Instance"|string;
6552 export type ResourceTypeForTagging = "Document"|"ManagedInstance"|"MaintenanceWindow"|"Parameter"|"PatchBaseline"|string;
6553 export type ResponseCode = number;
6554 export interface ResultAttribute {
6555 /**
6556 * Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.
6557 */
6558 TypeName: InventoryItemTypeName;
6559 }
6560 export type ResultAttributeList = ResultAttribute[];
6561 export interface ResumeSessionRequest {
6562 /**
6563 * The ID of the disconnected session to resume.
6564 */
6565 SessionId: SessionId;
6566 }
6567 export interface ResumeSessionResponse {
6568 /**
6569 * The ID of the session.
6570 */
6571 SessionId?: SessionId;
6572 /**
6573 * An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.
6574 */
6575 TokenValue?: TokenValue;
6576 /**
6577 * A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssm-messages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output). region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
6578 */
6579 StreamUrl?: StreamUrl;
6580 }
6581 export type S3BucketName = string;
6582 export type S3KeyPrefix = string;
6583 export interface S3OutputLocation {
6584 /**
6585 * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
6586 */
6587 OutputS3Region?: S3Region;
6588 /**
6589 * The name of the Amazon S3 bucket.
6590 */
6591 OutputS3BucketName?: S3BucketName;
6592 /**
6593 * The Amazon S3 bucket subfolder.
6594 */
6595 OutputS3KeyPrefix?: S3KeyPrefix;
6596 }
6597 export interface S3OutputUrl {
6598 /**
6599 * A URL for an Amazon S3 bucket where you want to store the results of this request.
6600 */
6601 OutputUrl?: Url;
6602 }
6603 export type S3Region = string;
6604 export type ScheduleExpression = string;
6605 export interface ScheduledWindowExecution {
6606 /**
6607 * The ID of the Maintenance Window to be run.
6608 */
6609 WindowId?: MaintenanceWindowId;
6610 /**
6611 * The name of the Maintenance Window to be run.
6612 */
6613 Name?: MaintenanceWindowName;
6614 /**
6615 * The time, in ISO-8601 Extended format, that the Maintenance Window is scheduled to be run.
6616 */
6617 ExecutionTime?: MaintenanceWindowStringDateTime;
6618 }
6619 export type ScheduledWindowExecutionList = ScheduledWindowExecution[];
6620 export interface SendAutomationSignalRequest {
6621 /**
6622 * The unique identifier for an existing Automation execution that you want to send the signal to.
6623 */
6624 AutomationExecutionId: AutomationExecutionId;
6625 /**
6626 * The type of signal. Valid signal types include the following: Approve and Reject
6627 */
6628 SignalType: SignalType;
6629 /**
6630 * The data sent with the signal. The data schema depends on the type of signal used in the request.
6631 */
6632 Payload?: AutomationParameterMap;
6633 }
6634 export interface SendAutomationSignalResult {
6635 }
6636 export interface SendCommandRequest {
6637 /**
6638 * The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.
6639 */
6640 InstanceIds?: InstanceIdList;
6641 /**
6642 * (Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.
6643 */
6644 Targets?: Targets;
6645 /**
6646 * Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.
6647 */
6648 DocumentName: DocumentARN;
6649 /**
6650 * The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you execute commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example: --document-version "\$DEFAULT" --document-version "\$LATEST" --document-version "3"
6651 */
6652 DocumentVersion?: DocumentVersion;
6653 /**
6654 * The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
6655 */
6656 DocumentHash?: DocumentHash;
6657 /**
6658 * Sha256 or Sha1. Sha1 hashes have been deprecated.
6659 */
6660 DocumentHashType?: DocumentHashType;
6661 /**
6662 * If this time is reached and the command has not already started executing, it will not run.
6663 */
6664 TimeoutSeconds?: TimeoutSeconds;
6665 /**
6666 * User-specified information about the command, such as a brief description of what the command should do.
6667 */
6668 Comment?: Comment;
6669 /**
6670 * The required and optional parameters specified in the document being executed.
6671 */
6672 Parameters?: Parameters;
6673 /**
6674 * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
6675 */
6676 OutputS3Region?: S3Region;
6677 /**
6678 * The name of the S3 bucket where command execution responses should be stored.
6679 */
6680 OutputS3BucketName?: S3BucketName;
6681 /**
6682 * The directory structure within the S3 bucket where the responses should be stored.
6683 */
6684 OutputS3KeyPrefix?: S3KeyPrefix;
6685 /**
6686 * (Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls in the AWS Systems Manager User Guide.
6687 */
6688 MaxConcurrency?: MaxConcurrency;
6689 /**
6690 * The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using Error Controls in the AWS Systems Manager User Guide.
6691 */
6692 MaxErrors?: MaxErrors;
6693 /**
6694 * The IAM role that Systems Manager uses to send notifications.
6695 */
6696 ServiceRoleArn?: ServiceRole;
6697 /**
6698 * Configurations for sending notifications.
6699 */
6700 NotificationConfig?: NotificationConfig;
6701 /**
6702 * Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
6703 */
6704 CloudWatchOutputConfig?: CloudWatchOutputConfig;
6705 }
6706 export interface SendCommandResult {
6707 /**
6708 * The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.
6709 */
6710 Command?: Command;
6711 }
6712 export type ServiceRole = string;
6713 export interface ServiceSetting {
6714 /**
6715 * The ID of the service setting.
6716 */
6717 SettingId?: ServiceSettingId;
6718 /**
6719 * The value of the service setting.
6720 */
6721 SettingValue?: ServiceSettingValue;
6722 /**
6723 * The last time the service setting was modified.
6724 */
6725 LastModifiedDate?: DateTime;
6726 /**
6727 * The ARN of the last modified user. This field is populated only if the setting value was overwritten.
6728 */
6729 LastModifiedUser?: String;
6730 /**
6731 * The ARN of the service setting.
6732 */
6733 ARN?: String;
6734 /**
6735 * The status of the service setting. The value can be Default, Customized or PendingUpdate. Default: The current setting uses a default value provisioned by the AWS service team. Customized: The current setting use a custom value specified by the customer. PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.
6736 */
6737 Status?: String;
6738 }
6739 export type ServiceSettingId = string;
6740 export type ServiceSettingValue = string;
6741 export interface Session {
6742 /**
6743 * The ID of the session.
6744 */
6745 SessionId?: SessionId;
6746 /**
6747 * The instance that the Session Manager session connected to.
6748 */
6749 Target?: SessionTarget;
6750 /**
6751 * The status of the session. For example, "Connected" or "Terminated".
6752 */
6753 Status?: SessionStatus;
6754 /**
6755 * The date and time, in ISO-8601 Extended format, when the session began.
6756 */
6757 StartDate?: DateTime;
6758 /**
6759 * The date and time, in ISO-8601 Extended format, when the session was terminated.
6760 */
6761 EndDate?: DateTime;
6762 /**
6763 * The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.
6764 */
6765 DocumentName?: DocumentName;
6766 /**
6767 * The ID of the AWS user account that started the session.
6768 */
6769 Owner?: SessionOwner;
6770 /**
6771 * Reserved for future use.
6772 */
6773 Details?: SessionDetails;
6774 /**
6775 * Reserved for future use.
6776 */
6777 OutputUrl?: SessionManagerOutputUrl;
6778 }
6779 export type SessionDetails = string;
6780 export interface SessionFilter {
6781 /**
6782 * The name of the filter.
6783 */
6784 key: SessionFilterKey;
6785 /**
6786 * The filter value. Valid values for each filter key are as follows: InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later. InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018. Target: Specify an instance to which session connections have been made. Owner: Specify an AWS user account to see a list of sessions started by that user. Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include: Connected Connecting Disconnected Terminated Terminating Failed
6787 */
6788 value: SessionFilterValue;
6789 }
6790 export type SessionFilterKey = "InvokedAfter"|"InvokedBefore"|"Target"|"Owner"|"Status"|string;
6791 export type SessionFilterList = SessionFilter[];
6792 export type SessionFilterValue = string;
6793 export type SessionId = string;
6794 export type SessionList = Session[];
6795 export type SessionManagerCloudWatchOutputUrl = string;
6796 export interface SessionManagerOutputUrl {
6797 /**
6798 * Reserved for future use.
6799 */
6800 S3OutputUrl?: SessionManagerS3OutputUrl;
6801 /**
6802 * Reserved for future use.
6803 */
6804 CloudWatchOutputUrl?: SessionManagerCloudWatchOutputUrl;
6805 }
6806 export type SessionManagerParameterName = string;
6807 export type SessionManagerParameterValue = string;
6808 export type SessionManagerParameterValueList = SessionManagerParameterValue[];
6809 export type SessionManagerParameters = {[key: string]: SessionManagerParameterValueList};
6810 export type SessionManagerS3OutputUrl = string;
6811 export type SessionMaxResults = number;
6812 export type SessionOwner = string;
6813 export type SessionState = "Active"|"History"|string;
6814 export type SessionStatus = "Connected"|"Connecting"|"Disconnected"|"Terminated"|"Terminating"|"Failed"|string;
6815 export type SessionTarget = string;
6816 export interface SeveritySummary {
6817 /**
6818 * The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.
6819 */
6820 CriticalCount?: ComplianceSummaryCount;
6821 /**
6822 * The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.
6823 */
6824 HighCount?: ComplianceSummaryCount;
6825 /**
6826 * The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.
6827 */
6828 MediumCount?: ComplianceSummaryCount;
6829 /**
6830 * The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.
6831 */
6832 LowCount?: ComplianceSummaryCount;
6833 /**
6834 * The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.
6835 */
6836 InformationalCount?: ComplianceSummaryCount;
6837 /**
6838 * The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.
6839 */
6840 UnspecifiedCount?: ComplianceSummaryCount;
6841 }
6842 export type SignalType = "Approve"|"Reject"|"StartStep"|"StopStep"|"Resume"|string;
6843 export type SnapshotDownloadUrl = string;
6844 export type SnapshotId = string;
6845 export type StandardErrorContent = string;
6846 export type StandardOutputContent = string;
6847 export interface StartAssociationsOnceRequest {
6848 /**
6849 * The association IDs that you want to execute immediately and only one time.
6850 */
6851 AssociationIds: AssociationIdList;
6852 }
6853 export interface StartAssociationsOnceResult {
6854 }
6855 export interface StartAutomationExecutionRequest {
6856 /**
6857 * The name of the Automation document to use for this execution.
6858 */
6859 DocumentName: DocumentARN;
6860 /**
6861 * The version of the Automation document to use for this execution.
6862 */
6863 DocumentVersion?: DocumentVersion;
6864 /**
6865 * A key-value map of execution parameters, which match the declared parameters in the Automation document.
6866 */
6867 Parameters?: AutomationParameterMap;
6868 /**
6869 * User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
6870 */
6871 ClientToken?: IdempotencyToken;
6872 /**
6873 * The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
6874 */
6875 Mode?: ExecutionMode;
6876 /**
6877 * The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
6878 */
6879 TargetParameterName?: AutomationParameterKey;
6880 /**
6881 * A key-value mapping to target resources. Required if you specify TargetParameterName.
6882 */
6883 Targets?: Targets;
6884 /**
6885 * A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
6886 */
6887 TargetMaps?: TargetMaps;
6888 /**
6889 * The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
6890 */
6891 MaxConcurrency?: MaxConcurrency;
6892 /**
6893 * The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received. Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.
6894 */
6895 MaxErrors?: MaxErrors;
6896 /**
6897 * A location is a combination of AWS Regions and/or AWS accounts where you want to execute the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
6898 */
6899 TargetLocations?: TargetLocations;
6900 }
6901 export interface StartAutomationExecutionResult {
6902 /**
6903 * The unique ID of a newly scheduled automation execution.
6904 */
6905 AutomationExecutionId?: AutomationExecutionId;
6906 }
6907 export interface StartSessionRequest {
6908 /**
6909 * The instance to connect to for the session.
6910 */
6911 Target: SessionTarget;
6912 /**
6913 * The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. If no document name is provided, a shell to the instance is launched by default.
6914 */
6915 DocumentName?: DocumentARN;
6916 /**
6917 * Reserved for future use.
6918 */
6919 Parameters?: SessionManagerParameters;
6920 }
6921 export interface StartSessionResponse {
6922 /**
6923 * The ID of the session.
6924 */
6925 SessionId?: SessionId;
6926 /**
6927 * An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.
6928 */
6929 TokenValue?: TokenValue;
6930 /**
6931 * A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssm-messages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
6932 */
6933 StreamUrl?: StreamUrl;
6934 }
6935 export type StatusAdditionalInfo = string;
6936 export type StatusDetails = string;
6937 export type StatusMessage = string;
6938 export type StatusName = string;
6939 export interface StepExecution {
6940 /**
6941 * The name of this execution step.
6942 */
6943 StepName?: String;
6944 /**
6945 * The action this step performs. The action determines the behavior of the step.
6946 */
6947 Action?: AutomationActionName;
6948 /**
6949 * The timeout seconds of the step.
6950 */
6951 TimeoutSeconds?: Long;
6952 /**
6953 * The action to take if the step fails. The default value is Abort.
6954 */
6955 OnFailure?: String;
6956 /**
6957 * The maximum number of tries to run the action of the step. The default value is 1.
6958 */
6959 MaxAttempts?: Integer;
6960 /**
6961 * If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
6962 */
6963 ExecutionStartTime?: DateTime;
6964 /**
6965 * If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
6966 */
6967 ExecutionEndTime?: DateTime;
6968 /**
6969 * The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
6970 */
6971 StepStatus?: AutomationExecutionStatus;
6972 /**
6973 * The response code returned by the execution of the step.
6974 */
6975 ResponseCode?: String;
6976 /**
6977 * Fully-resolved values passed into the step before execution.
6978 */
6979 Inputs?: NormalStringMap;
6980 /**
6981 * Returned values from the execution of the step.
6982 */
6983 Outputs?: AutomationParameterMap;
6984 /**
6985 * A message associated with the response code for an execution.
6986 */
6987 Response?: String;
6988 /**
6989 * If a step failed, this message explains why the execution failed.
6990 */
6991 FailureMessage?: String;
6992 /**
6993 * Information about the Automation failure.
6994 */
6995 FailureDetails?: FailureDetails;
6996 /**
6997 * The unique ID of a step execution.
6998 */
6999 StepExecutionId?: String;
7000 /**
7001 * A user-specified list of parameters to override when executing a step.
7002 */
7003 OverriddenParameters?: AutomationParameterMap;
7004 /**
7005 * The flag which can be used to end automation no matter whether the step succeeds or fails.
7006 */
7007 IsEnd?: Boolean;
7008 /**
7009 * The next step after the step succeeds.
7010 */
7011 NextStep?: String;
7012 /**
7013 * The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
7014 */
7015 IsCritical?: Boolean;
7016 /**
7017 * Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to execute the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
7018 */
7019 ValidNextSteps?: ValidNextStepList;
7020 /**
7021 * The targets for the step execution.
7022 */
7023 Targets?: Targets;
7024 /**
7025 * The combination of AWS Regions and accounts targeted by the current Automation execution.
7026 */
7027 TargetLocation?: TargetLocation;
7028 }
7029 export interface StepExecutionFilter {
7030 /**
7031 * One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.
7032 */
7033 Key: StepExecutionFilterKey;
7034 /**
7035 * The values of the filter key.
7036 */
7037 Values: StepExecutionFilterValueList;
7038 }
7039 export type StepExecutionFilterKey = "StartTimeBefore"|"StartTimeAfter"|"StepExecutionStatus"|"StepExecutionId"|"StepName"|"Action"|string;
7040 export type StepExecutionFilterList = StepExecutionFilter[];
7041 export type StepExecutionFilterValue = string;
7042 export type StepExecutionFilterValueList = StepExecutionFilterValue[];
7043 export type StepExecutionList = StepExecution[];
7044 export interface StopAutomationExecutionRequest {
7045 /**
7046 * The execution ID of the Automation to stop.
7047 */
7048 AutomationExecutionId: AutomationExecutionId;
7049 /**
7050 * The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.
7051 */
7052 Type?: StopType;
7053 }
7054 export interface StopAutomationExecutionResult {
7055 }
7056 export type StopType = "Complete"|"Cancel"|string;
7057 export type StreamUrl = string;
7058 export type String = string;
7059 export type StringDateTime = string;
7060 export type StringList = String[];
7061 export interface Tag {
7062 /**
7063 * The name of the tag.
7064 */
7065 Key: TagKey;
7066 /**
7067 * The value of the tag.
7068 */
7069 Value: TagValue;
7070 }
7071 export type TagKey = string;
7072 export type TagList = Tag[];
7073 export type TagValue = string;
7074 export interface Target {
7075 /**
7076 * User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:&lt;Amazon EC2 tag&gt; or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see Targeting Multiple Instances in the AWS Systems Manager User Guide.
7077 */
7078 Key?: TargetKey;
7079 /**
7080 * User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.
7081 */
7082 Values?: TargetValues;
7083 }
7084 export type TargetCount = number;
7085 export type TargetKey = string;
7086 export interface TargetLocation {
7087 /**
7088 * The AWS accounts targeted by the current Automation execution.
7089 */
7090 Accounts?: Accounts;
7091 /**
7092 * The AWS Regions targeted by the current Automation execution.
7093 */
7094 Regions?: Regions;
7095 /**
7096 * The maxium number of AWS accounts and AWS regions allowed to run the Automation concurrently
7097 */
7098 TargetLocationMaxConcurrency?: MaxConcurrency;
7099 /**
7100 * The maxium number of errors allowed before the system stops queueing additional Automation executions for the currently executing Automation.
7101 */
7102 TargetLocationMaxErrors?: MaxErrors;
7103 /**
7104 * The Automation execution role used by the currently executing Automation.
7105 */
7106 ExecutionRoleName?: ExecutionRoleName;
7107 }
7108 export type TargetLocations = TargetLocation[];
7109 export type TargetMap = {[key: string]: TargetMapValueList};
7110 export type TargetMapKey = string;
7111 export type TargetMapValue = string;
7112 export type TargetMapValueList = TargetMapValue[];
7113 export type TargetMaps = TargetMap[];
7114 export type TargetParameterList = ParameterValue[];
7115 export type TargetType = string;
7116 export type TargetValue = string;
7117 export type TargetValues = TargetValue[];
7118 export type Targets = Target[];
7119 export interface TerminateSessionRequest {
7120 /**
7121 * The ID of the session to terminate.
7122 */
7123 SessionId: SessionId;
7124 }
7125 export interface TerminateSessionResponse {
7126 /**
7127 * The ID of the session that has been terminated.
7128 */
7129 SessionId?: SessionId;
7130 }
7131 export type TimeoutSeconds = number;
7132 export type TokenValue = string;
7133 export type TotalCount = number;
7134 export interface UpdateAssociationRequest {
7135 /**
7136 * The ID of the association you want to update.
7137 */
7138 AssociationId: AssociationId;
7139 /**
7140 * The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
7141 */
7142 Parameters?: Parameters;
7143 /**
7144 * The document version you want update for the association.
7145 */
7146 DocumentVersion?: DocumentVersion;
7147 /**
7148 * The cron expression used to schedule the association that you want to update.
7149 */
7150 ScheduleExpression?: ScheduleExpression;
7151 /**
7152 * An Amazon S3 bucket where you want to store the results of this request.
7153 */
7154 OutputLocation?: InstanceAssociationOutputLocation;
7155 /**
7156 * The name of the SSM document that contains the configuration information for the instance. You can specify Command, Policy, or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:aws:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
7157 */
7158 Name?: DocumentARN;
7159 /**
7160 * The targets of the association.
7161 */
7162 Targets?: Targets;
7163 /**
7164 * The name of the association that you want to update.
7165 */
7166 AssociationName?: AssociationName;
7167 /**
7168 * This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.
7169 */
7170 AssociationVersion?: AssociationVersion;
7171 /**
7172 * Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
7173 */
7174 AutomationTargetParameterName?: AutomationTargetParameterName;
7175 /**
7176 * The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
7177 */
7178 MaxErrors?: MaxErrors;
7179 /**
7180 * The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
7181 */
7182 MaxConcurrency?: MaxConcurrency;
7183 /**
7184 * The severity level to assign to the association.
7185 */
7186 ComplianceSeverity?: AssociationComplianceSeverity;
7187 }
7188 export interface UpdateAssociationResult {
7189 /**
7190 * The description of the association that was updated.
7191 */
7192 AssociationDescription?: AssociationDescription;
7193 }
7194 export interface UpdateAssociationStatusRequest {
7195 /**
7196 * The name of the Systems Manager document.
7197 */
7198 Name: DocumentARN;
7199 /**
7200 * The ID of the instance.
7201 */
7202 InstanceId: InstanceId;
7203 /**
7204 * The association status.
7205 */
7206 AssociationStatus: AssociationStatus;
7207 }
7208 export interface UpdateAssociationStatusResult {
7209 /**
7210 * Information about the association.
7211 */
7212 AssociationDescription?: AssociationDescription;
7213 }
7214 export interface UpdateDocumentDefaultVersionRequest {
7215 /**
7216 * The name of a custom document that you want to set as the default version.
7217 */
7218 Name: DocumentName;
7219 /**
7220 * The version of a custom document that you want to set as the default version.
7221 */
7222 DocumentVersion: DocumentVersionNumber;
7223 }
7224 export interface UpdateDocumentDefaultVersionResult {
7225 /**
7226 * The description of a custom document that you want to set as the default version.
7227 */
7228 Description?: DocumentDefaultVersionDescription;
7229 }
7230 export interface UpdateDocumentRequest {
7231 /**
7232 * A valid JSON or YAML string.
7233 */
7234 Content: DocumentContent;
7235 /**
7236 * A list of key and value pairs that describe attachments to a version of a document.
7237 */
7238 Attachments?: AttachmentsSourceList;
7239 /**
7240 * The name of the document that you want to update.
7241 */
7242 Name: DocumentName;
7243 /**
7244 * An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
7245 */
7246 VersionName?: DocumentVersionName;
7247 /**
7248 * The version of the document that you want to update.
7249 */
7250 DocumentVersion?: DocumentVersion;
7251 /**
7252 * Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
7253 */
7254 DocumentFormat?: DocumentFormat;
7255 /**
7256 * Specify a new target type for the document.
7257 */
7258 TargetType?: TargetType;
7259 }
7260 export interface UpdateDocumentResult {
7261 /**
7262 * A description of the document that was updated.
7263 */
7264 DocumentDescription?: DocumentDescription;
7265 }
7266 export interface UpdateMaintenanceWindowRequest {
7267 /**
7268 * The ID of the Maintenance Window to update.
7269 */
7270 WindowId: MaintenanceWindowId;
7271 /**
7272 * The name of the Maintenance Window.
7273 */
7274 Name?: MaintenanceWindowName;
7275 /**
7276 * An optional description for the update request.
7277 */
7278 Description?: MaintenanceWindowDescription;
7279 /**
7280 * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
7281 */
7282 StartDate?: MaintenanceWindowStringDateTime;
7283 /**
7284 * The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive. EndDate allows you to set a date and time in the future when the Maintenance Window will no longer run.
7285 */
7286 EndDate?: MaintenanceWindowStringDateTime;
7287 /**
7288 * The schedule of the Maintenance Window in the form of a cron or rate expression.
7289 */
7290 Schedule?: MaintenanceWindowSchedule;
7291 /**
7292 * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
7293 */
7294 ScheduleTimezone?: MaintenanceWindowTimezone;
7295 /**
7296 * The duration of the Maintenance Window in hours.
7297 */
7298 Duration?: MaintenanceWindowDurationHours;
7299 /**
7300 * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
7301 */
7302 Cutoff?: MaintenanceWindowCutoff;
7303 /**
7304 * Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
7305 */
7306 AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets;
7307 /**
7308 * Whether the Maintenance Window is enabled.
7309 */
7310 Enabled?: MaintenanceWindowEnabled;
7311 /**
7312 * If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
7313 */
7314 Replace?: Boolean;
7315 }
7316 export interface UpdateMaintenanceWindowResult {
7317 /**
7318 * The ID of the created Maintenance Window.
7319 */
7320 WindowId?: MaintenanceWindowId;
7321 /**
7322 * The name of the Maintenance Window.
7323 */
7324 Name?: MaintenanceWindowName;
7325 /**
7326 * An optional description of the update.
7327 */
7328 Description?: MaintenanceWindowDescription;
7329 /**
7330 * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become active. The Maintenance Window will not run before this specified time.
7331 */
7332 StartDate?: MaintenanceWindowStringDateTime;
7333 /**
7334 * The date and time, in ISO-8601 Extended format, for when the Maintenance Window is scheduled to become inactive. The Maintenance Window will not run after this specified time.
7335 */
7336 EndDate?: MaintenanceWindowStringDateTime;
7337 /**
7338 * The schedule of the Maintenance Window in the form of a cron or rate expression.
7339 */
7340 Schedule?: MaintenanceWindowSchedule;
7341 /**
7342 * The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
7343 */
7344 ScheduleTimezone?: MaintenanceWindowTimezone;
7345 /**
7346 * The duration of the Maintenance Window in hours.
7347 */
7348 Duration?: MaintenanceWindowDurationHours;
7349 /**
7350 * The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
7351 */
7352 Cutoff?: MaintenanceWindowCutoff;
7353 /**
7354 * Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
7355 */
7356 AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets;
7357 /**
7358 * Whether the Maintenance Window is enabled.
7359 */
7360 Enabled?: MaintenanceWindowEnabled;
7361 }
7362 export interface UpdateMaintenanceWindowTargetRequest {
7363 /**
7364 * The Maintenance Window ID with which to modify the target.
7365 */
7366 WindowId: MaintenanceWindowId;
7367 /**
7368 * The target ID to modify.
7369 */
7370 WindowTargetId: MaintenanceWindowTargetId;
7371 /**
7372 * The targets to add or replace.
7373 */
7374 Targets?: Targets;
7375 /**
7376 * User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
7377 */
7378 OwnerInformation?: OwnerInformation;
7379 /**
7380 * A name for the update.
7381 */
7382 Name?: MaintenanceWindowName;
7383 /**
7384 * An optional description for the update.
7385 */
7386 Description?: MaintenanceWindowDescription;
7387 /**
7388 * If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
7389 */
7390 Replace?: Boolean;
7391 }
7392 export interface UpdateMaintenanceWindowTargetResult {
7393 /**
7394 * The Maintenance Window ID specified in the update request.
7395 */
7396 WindowId?: MaintenanceWindowId;
7397 /**
7398 * The target ID specified in the update request.
7399 */
7400 WindowTargetId?: MaintenanceWindowTargetId;
7401 /**
7402 * The updated targets.
7403 */
7404 Targets?: Targets;
7405 /**
7406 * The updated owner.
7407 */
7408 OwnerInformation?: OwnerInformation;
7409 /**
7410 * The updated name.
7411 */
7412 Name?: MaintenanceWindowName;
7413 /**
7414 * The updated description.
7415 */
7416 Description?: MaintenanceWindowDescription;
7417 }
7418 export interface UpdateMaintenanceWindowTaskRequest {
7419 /**
7420 * The Maintenance Window ID that contains the task to modify.
7421 */
7422 WindowId: MaintenanceWindowId;
7423 /**
7424 * The task ID to modify.
7425 */
7426 WindowTaskId: MaintenanceWindowTaskId;
7427 /**
7428 * The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
7429 */
7430 Targets?: Targets;
7431 /**
7432 * The task ARN to modify.
7433 */
7434 TaskArn?: MaintenanceWindowTaskArn;
7435 /**
7436 * The IAM service role ARN to modify. The system assumes this role during task execution. If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN. For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.
7437 */
7438 ServiceRoleArn?: ServiceRole;
7439 /**
7440 * The parameters to modify. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters
7441 */
7442 TaskParameters?: MaintenanceWindowTaskParameters;
7443 /**
7444 * The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
7445 */
7446 TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
7447 /**
7448 * The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
7449 */
7450 Priority?: MaintenanceWindowTaskPriority;
7451 /**
7452 * The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
7453 */
7454 MaxConcurrency?: MaxConcurrency;
7455 /**
7456 * The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
7457 */
7458 MaxErrors?: MaxErrors;
7459 /**
7460 * The new logging location in Amazon S3 to specify. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
7461 */
7462 LoggingInfo?: LoggingInfo;
7463 /**
7464 * The new task name to specify.
7465 */
7466 Name?: MaintenanceWindowName;
7467 /**
7468 * The new task description to specify.
7469 */
7470 Description?: MaintenanceWindowDescription;
7471 /**
7472 * If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.
7473 */
7474 Replace?: Boolean;
7475 }
7476 export interface UpdateMaintenanceWindowTaskResult {
7477 /**
7478 * The ID of the Maintenance Window that was updated.
7479 */
7480 WindowId?: MaintenanceWindowId;
7481 /**
7482 * The task ID of the Maintenance Window that was updated.
7483 */
7484 WindowTaskId?: MaintenanceWindowTaskId;
7485 /**
7486 * The updated target values.
7487 */
7488 Targets?: Targets;
7489 /**
7490 * The updated task ARN value.
7491 */
7492 TaskArn?: MaintenanceWindowTaskArn;
7493 /**
7494 * The updated service role ARN value.
7495 */
7496 ServiceRoleArn?: ServiceRole;
7497 /**
7498 * The updated parameter values. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
7499 */
7500 TaskParameters?: MaintenanceWindowTaskParameters;
7501 /**
7502 * The updated parameter values.
7503 */
7504 TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
7505 /**
7506 * The updated priority value.
7507 */
7508 Priority?: MaintenanceWindowTaskPriority;
7509 /**
7510 * The updated MaxConcurrency value.
7511 */
7512 MaxConcurrency?: MaxConcurrency;
7513 /**
7514 * The updated MaxErrors value.
7515 */
7516 MaxErrors?: MaxErrors;
7517 /**
7518 * The updated logging information in Amazon S3. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.
7519 */
7520 LoggingInfo?: LoggingInfo;
7521 /**
7522 * The updated task name.
7523 */
7524 Name?: MaintenanceWindowName;
7525 /**
7526 * The updated task description.
7527 */
7528 Description?: MaintenanceWindowDescription;
7529 }
7530 export interface UpdateManagedInstanceRoleRequest {
7531 /**
7532 * The ID of the managed instance where you want to update the role.
7533 */
7534 InstanceId: ManagedInstanceId;
7535 /**
7536 * The IAM role you want to assign or change.
7537 */
7538 IamRole: IamRole;
7539 }
7540 export interface UpdateManagedInstanceRoleResult {
7541 }
7542 export interface UpdatePatchBaselineRequest {
7543 /**
7544 * The ID of the patch baseline to update.
7545 */
7546 BaselineId: BaselineId;
7547 /**
7548 * The name of the patch baseline.
7549 */
7550 Name?: BaselineName;
7551 /**
7552 * A set of global filters used to include patches in the baseline.
7553 */
7554 GlobalFilters?: PatchFilterGroup;
7555 /**
7556 * A set of rules used to include patches in the baseline.
7557 */
7558 ApprovalRules?: PatchRuleGroup;
7559 /**
7560 * A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
7561 */
7562 ApprovedPatches?: PatchIdList;
7563 /**
7564 * Assigns a new compliance severity level to an existing patch baseline.
7565 */
7566 ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
7567 /**
7568 * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
7569 */
7570 ApprovedPatchesEnableNonSecurity?: Boolean;
7571 /**
7572 * A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
7573 */
7574 RejectedPatches?: PatchIdList;
7575 /**
7576 * The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
7577 */
7578 RejectedPatchesAction?: PatchAction;
7579 /**
7580 * A description of the patch baseline.
7581 */
7582 Description?: BaselineDescription;
7583 /**
7584 * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
7585 */
7586 Sources?: PatchSourceList;
7587 /**
7588 * If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.
7589 */
7590 Replace?: Boolean;
7591 }
7592 export interface UpdatePatchBaselineResult {
7593 /**
7594 * The ID of the deleted patch baseline.
7595 */
7596 BaselineId?: BaselineId;
7597 /**
7598 * The name of the patch baseline.
7599 */
7600 Name?: BaselineName;
7601 /**
7602 * The operating system rule used by the updated patch baseline.
7603 */
7604 OperatingSystem?: OperatingSystem;
7605 /**
7606 * A set of global filters used to exclude patches from the baseline.
7607 */
7608 GlobalFilters?: PatchFilterGroup;
7609 /**
7610 * A set of rules used to include patches in the baseline.
7611 */
7612 ApprovalRules?: PatchRuleGroup;
7613 /**
7614 * A list of explicitly approved patches for the baseline.
7615 */
7616 ApprovedPatches?: PatchIdList;
7617 /**
7618 * The compliance severity level assigned to the patch baseline after the update completed.
7619 */
7620 ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
7621 /**
7622 * Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
7623 */
7624 ApprovedPatchesEnableNonSecurity?: Boolean;
7625 /**
7626 * A list of explicitly rejected patches for the baseline.
7627 */
7628 RejectedPatches?: PatchIdList;
7629 /**
7630 * The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
7631 */
7632 RejectedPatchesAction?: PatchAction;
7633 /**
7634 * The date when the patch baseline was created.
7635 */
7636 CreatedDate?: DateTime;
7637 /**
7638 * The date when the patch baseline was last modified.
7639 */
7640 ModifiedDate?: DateTime;
7641 /**
7642 * A description of the Patch Baseline.
7643 */
7644 Description?: BaselineDescription;
7645 /**
7646 * Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
7647 */
7648 Sources?: PatchSourceList;
7649 }
7650 export interface UpdateServiceSettingRequest {
7651 /**
7652 * The ID of the service setting to update.
7653 */
7654 SettingId: ServiceSettingId;
7655 /**
7656 * The new value to specify for the service setting.
7657 */
7658 SettingValue: ServiceSettingValue;
7659 }
7660 export interface UpdateServiceSettingResult {
7661 }
7662 export type Url = string;
7663 export type ValidNextStep = string;
7664 export type ValidNextStepList = ValidNextStep[];
7665 export type Version = string;
7666 /**
7667 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
7668 */
7669 export type apiVersion = "2014-11-06"|"latest"|string;
7670 export interface ClientApiVersions {
7671 /**
7672 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
7673 */
7674 apiVersion?: apiVersion;
7675 }
7676 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
7677 /**
7678 * Contains interfaces for use with the SSM client.
7679 */
7680 export import Types = SSM;
7681}
7682export = SSM;