UNPKG

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