UNPKG

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