ssm.d.ts (57358B)
1 import {Request} from '../lib/request';
2 import {Response} from '../lib/response';
3 import {AWSError} from '../lib/error';
4 import {Service} from '../lib/service';
5 import {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare 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 assign to your managed instances. Tags enable you to categorize your managed instances 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 10 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 assign to your managed instances. Tags enable you to categorize your managed instances 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 10 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 * Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide.
32 */
33 createActivation(params: SSM.Types.CreateActivationRequest, callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request<SSM.Types.CreateActivationResult, AWSError>;
34 /**
35 * Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide.
36 */
37 createActivation(callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request<SSM.Types.CreateActivationResult, AWSError>;
38 /**
39 * Associates the specified SSM document with the specified instance. When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) 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 throws the AssociationAlreadyExists exception.
40 */
41 createAssociation(params: SSM.Types.CreateAssociationRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request<SSM.Types.CreateAssociationResult, AWSError>;
42 /**
43 * Associates the specified SSM document with the specified instance. When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) 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 throws the AssociationAlreadyExists exception.
44 */
45 createAssociation(callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request<SSM.Types.CreateAssociationResult, AWSError>;
46 /**
47 * Associates the specified SSM document with the specified instances. When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) 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 throws the AssociationAlreadyExists exception.
48 */
49 createAssociationBatch(params: SSM.Types.CreateAssociationBatchRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request<SSM.Types.CreateAssociationBatchResult, AWSError>;
50 /**
51 * Associates the specified SSM document with the specified instances. When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) 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 throws the AssociationAlreadyExists exception.
52 */
53 createAssociationBatch(callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request<SSM.Types.CreateAssociationBatchResult, AWSError>;
54 /**
55 * Creates an SSM document. After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
56 */
57 createDocument(params: SSM.Types.CreateDocumentRequest, callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request<SSM.Types.CreateDocumentResult, AWSError>;
58 /**
59 * Creates an SSM document. After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
60 */
61 createDocument(callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request<SSM.Types.CreateDocumentResult, AWSError>;
62 /**
63 * 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.
64 */
65 deleteActivation(params: SSM.Types.DeleteActivationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request<SSM.Types.DeleteActivationResult, AWSError>;
66 /**
67 * 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.
68 */
69 deleteActivation(callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request<SSM.Types.DeleteActivationResult, AWSError>;
70 /**
71 * Disassociates the specified SSM document from the specified instance. When you disassociate an SSM 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.
72 */
73 deleteAssociation(params: SSM.Types.DeleteAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request<SSM.Types.DeleteAssociationResult, AWSError>;
74 /**
75 * Disassociates the specified SSM document from the specified instance. When you disassociate an SSM 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.
76 */
77 deleteAssociation(callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request<SSM.Types.DeleteAssociationResult, AWSError>;
78 /**
79 * Deletes the SSM document and all instance associations to the document. Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
80 */
81 deleteDocument(params: SSM.Types.DeleteDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request<SSM.Types.DeleteDocumentResult, AWSError>;
82 /**
83 * Deletes the SSM document and all instance associations to the document. Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
84 */
85 deleteDocument(callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request<SSM.Types.DeleteDocumentResult, AWSError>;
86 /**
87 * 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 the SSM agent first.
88 */
89 deregisterManagedInstance(params: SSM.Types.DeregisterManagedInstanceRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request<SSM.Types.DeregisterManagedInstanceResult, AWSError>;
90 /**
91 * 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 the SSM agent first.
92 */
93 deregisterManagedInstance(callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request<SSM.Types.DeregisterManagedInstanceResult, AWSError>;
94 /**
95 * Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
96 */
97 describeActivations(params: SSM.Types.DescribeActivationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request<SSM.Types.DescribeActivationsResult, AWSError>;
98 /**
99 * Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
100 */
101 describeActivations(callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request<SSM.Types.DescribeActivationsResult, AWSError>;
102 /**
103 * Describes the associations for the specified SSM document or instance.
104 */
105 describeAssociation(params: SSM.Types.DescribeAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request<SSM.Types.DescribeAssociationResult, AWSError>;
106 /**
107 * Describes the associations for the specified SSM document or instance.
108 */
109 describeAssociation(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request<SSM.Types.DescribeAssociationResult, AWSError>;
110 /**
111 * Describes the specified SSM document.
112 */
113 describeDocument(params: SSM.Types.DescribeDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request<SSM.Types.DescribeDocumentResult, AWSError>;
114 /**
115 * Describes the specified SSM document.
116 */
117 describeDocument(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request<SSM.Types.DescribeDocumentResult, AWSError>;
118 /**
119 * Describes the permissions for an SSM 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).
120 */
121 describeDocumentPermission(params: SSM.Types.DescribeDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request<SSM.Types.DescribeDocumentPermissionResponse, AWSError>;
122 /**
123 * Describes the permissions for an SSM 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).
124 */
125 describeDocumentPermission(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request<SSM.Types.DescribeDocumentPermissionResponse, AWSError>;
126 /**
127 * 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.
128 */
129 describeInstanceInformation(params: SSM.Types.DescribeInstanceInformationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request<SSM.Types.DescribeInstanceInformationResult, AWSError>;
130 /**
131 * 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.
132 */
133 describeInstanceInformation(callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request<SSM.Types.DescribeInstanceInformationResult, AWSError>;
134 /**
135 * Gets the contents of the specified SSM document.
136 */
137 getDocument(params: SSM.Types.GetDocumentRequest, callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request<SSM.Types.GetDocumentResult, AWSError>;
138 /**
139 * Gets the contents of the specified SSM document.
140 */
141 getDocument(callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request<SSM.Types.GetDocumentResult, AWSError>;
142 /**
143 * Lists the associations for the specified SSM document or instance.
144 */
145 listAssociations(params: SSM.Types.ListAssociationsRequest, callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request<SSM.Types.ListAssociationsResult, AWSError>;
146 /**
147 * Lists the associations for the specified SSM document or instance.
148 */
149 listAssociations(callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request<SSM.Types.ListAssociationsResult, AWSError>;
150 /**
151 * An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
152 */
153 listCommandInvocations(params: SSM.Types.ListCommandInvocationsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request<SSM.Types.ListCommandInvocationsResult, AWSError>;
154 /**
155 * An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
156 */
157 listCommandInvocations(callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request<SSM.Types.ListCommandInvocationsResult, AWSError>;
158 /**
159 * Lists the commands requested by users of the AWS account.
160 */
161 listCommands(params: SSM.Types.ListCommandsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request<SSM.Types.ListCommandsResult, AWSError>;
162 /**
163 * Lists the commands requested by users of the AWS account.
164 */
165 listCommands(callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request<SSM.Types.ListCommandsResult, AWSError>;
166 /**
167 * Describes one or more of your SSM documents.
168 */
169 listDocuments(params: SSM.Types.ListDocumentsRequest, callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request<SSM.Types.ListDocumentsResult, AWSError>;
170 /**
171 * Describes one or more of your SSM documents.
172 */
173 listDocuments(callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request<SSM.Types.ListDocumentsResult, AWSError>;
174 /**
175 * Returns a list of the tags assigned to the specified resource.
176 */
177 listTagsForResource(params: SSM.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request<SSM.Types.ListTagsForResourceResult, AWSError>;
178 /**
179 * Returns a list of the tags assigned to the specified resource.
180 */
181 listTagsForResource(callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request<SSM.Types.ListTagsForResourceResult, AWSError>;
182 /**
183 * Share a 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.
184 */
185 modifyDocumentPermission(params: SSM.Types.ModifyDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request<SSM.Types.ModifyDocumentPermissionResponse, AWSError>;
186 /**
187 * Share a 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.
188 */
189 modifyDocumentPermission(callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request<SSM.Types.ModifyDocumentPermissionResponse, AWSError>;
190 /**
191 * Removes all tags from the specified resource.
192 */
193 removeTagsFromResource(params: SSM.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request<SSM.Types.RemoveTagsFromResourceResult, AWSError>;
194 /**
195 * Removes all tags from the specified resource.
196 */
197 removeTagsFromResource(callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request<SSM.Types.RemoveTagsFromResourceResult, AWSError>;
198 /**
199 * Executes commands on one or more remote instances.
200 */
201 sendCommand(params: SSM.Types.SendCommandRequest, callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request<SSM.Types.SendCommandResult, AWSError>;
202 /**
203 * Executes commands on one or more remote instances.
204 */
205 sendCommand(callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request<SSM.Types.SendCommandResult, AWSError>;
206 /**
207 * Updates the status of the SSM document associated with the specified instance.
208 */
209 updateAssociationStatus(params: SSM.Types.UpdateAssociationStatusRequest, callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request<SSM.Types.UpdateAssociationStatusResult, AWSError>;
210 /**
211 * Updates the status of the SSM document associated with the specified instance.
212 */
213 updateAssociationStatus(callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request<SSM.Types.UpdateAssociationStatusResult, AWSError>;
214 /**
215 * Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
216 */
217 updateManagedInstanceRole(params: SSM.Types.UpdateManagedInstanceRoleRequest, callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request<SSM.Types.UpdateManagedInstanceRoleResult, AWSError>;
218 /**
219 * Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
220 */
221 updateManagedInstanceRole(callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request<SSM.Types.UpdateManagedInstanceRoleResult, AWSError>;
222 }
223 declare namespace SSM.Types {
224 export type AccountId = string;
225 export type AccountIdList = AccountId[];
226 export interface Activation {
227 /**
228 * The ID created by SSM when you submitted the activation.
229 */
230 ActivationId?: ActivationId;
231 /**
232 * A user defined description of the activation.
233 */
234 Description?: ActivationDescription;
235 /**
236 * A name for the managed instance when it is created.
237 */
238 DefaultInstanceName?: DefaultInstanceName;
239 /**
240 * The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
241 */
242 IamRole?: IamRole;
243 /**
244 * The maximum number of managed instances that can be registered using this activation.
245 */
246 RegistrationLimit?: RegistrationLimit;
247 /**
248 * The number of managed instances already registered with this activation.
249 */
250 RegistrationsCount?: RegistrationsCount;
251 /**
252 * The date when this activation can no longer be used to register managed instances.
253 */
254 ExpirationDate?: ExpirationDate;
255 /**
256 * Whether or not the activation is expired.
257 */
258 Expired?: Boolean;
259 /**
260 * The date the activation was created.
261 */
262 CreatedDate?: CreatedDate;
263 }
264 export type ActivationCode = string;
265 export type ActivationDescription = string;
266 export type ActivationId = string;
267 export type ActivationList = Activation[];
268 export interface AddTagsToResourceRequest {
269 /**
270 * Specifies the type of resource you are tagging.
271 */
272 ResourceType: ResourceTypeForTagging;
273 /**
274 * The resource ID you want to tag.
275 */
276 ResourceId: ResourceId;
277 /**
278 * 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.
279 */
280 Tags: TagList;
281 }
282 export interface AddTagsToResourceResult {
283 }
284 export interface Association {
285 /**
286 * The name of the SSM document.
287 */
288 Name?: DocumentName;
289 /**
290 * The ID of the instance.
291 */
292 InstanceId?: InstanceId;
293 }
294 export interface AssociationDescription {
295 /**
296 * The name of the SSM document.
297 */
298 Name?: DocumentName;
299 /**
300 * The ID of the instance.
301 */
302 InstanceId?: InstanceId;
303 /**
304 * The date when the association was made.
305 */
306 Date?: DateTime;
307 /**
308 * The association status.
309 */
310 Status?: AssociationStatus;
311 /**
312 * A description of the parameters for a document.
313 */
314 Parameters?: Parameters;
315 }
316 export type AssociationDescriptionList = AssociationDescription[];
317 export interface AssociationFilter {
318 /**
319 * The name of the filter.
320 */
321 key: AssociationFilterKey;
322 /**
323 * The filter value.
324 */
325 value: AssociationFilterValue;
326 }
327 export type AssociationFilterKey = "InstanceId"|"Name"|string;
328 export type AssociationFilterList = AssociationFilter[];
329 export type AssociationFilterValue = string;
330 export type AssociationList = Association[];
331 export interface AssociationStatus {
332 /**
333 * The date when the status changed.
334 */
335 Date: DateTime;
336 /**
337 * The status.
338 */
339 Name: AssociationStatusName;
340 /**
341 * The reason for the status.
342 */
343 Message: StatusMessage;
344 /**
345 * A user-defined string.
346 */
347 AdditionalInfo?: StatusAdditionalInfo;
348 }
349 export type AssociationStatusName = "Pending"|"Success"|"Failed"|string;
350 export type BatchErrorMessage = string;
351 export type Boolean = boolean;
352 export interface CancelCommandRequest {
353 /**
354 * The ID of the command you want to cancel.
355 */
356 CommandId: CommandId;
357 /**
358 * (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.
359 */
360 InstanceIds?: InstanceIdList;
361 }
362 export interface CancelCommandResult {
363 }
364 export interface Command {
365 /**
366 * A unique identifier for this command.
367 */
368 CommandId?: CommandId;
369 /**
370 * The name of the SSM document requested for execution.
371 */
372 DocumentName?: DocumentName;
373 /**
374 * User-specified information about the command, such as a brief description of what the command should do.
375 */
376 Comment?: Comment;
377 /**
378 * If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
379 */
380 ExpiresAfter?: DateTime;
381 /**
382 * The parameter values to be inserted in the SSM document when executing the command.
383 */
384 Parameters?: Parameters;
385 /**
386 * The instance IDs against which this command was requested.
387 */
388 InstanceIds?: InstanceIdList;
389 /**
390 * The date and time the command was requested.
391 */
392 RequestedDateTime?: DateTime;
393 /**
394 * The status of the command.
395 */
396 Status?: CommandStatus;
397 /**
398 * The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
399 */
400 OutputS3BucketName?: S3BucketName;
401 /**
402 * The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
403 */
404 OutputS3KeyPrefix?: S3KeyPrefix;
405 /**
406 * The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes.
407 */
408 ServiceRole?: ServiceRole;
409 /**
410 * Configurations for sending notifications about command status changes.
411 */
412 NotificationConfig?: NotificationConfig;
413 }
414 export interface CommandFilter {
415 /**
416 * The name of the filter. For example, requested date and time.
417 */
418 key: CommandFilterKey;
419 /**
420 * The filter value. For example: June 30, 2015.
421 */
422 value: CommandFilterValue;
423 }
424 export type CommandFilterKey = "InvokedAfter"|"InvokedBefore"|"Status"|string;
425 export type CommandFilterList = CommandFilter[];
426 export type CommandFilterValue = string;
427 export type CommandId = string;
428 export interface CommandInvocation {
429 /**
430 * The command against which this invocation was requested.
431 */
432 CommandId?: CommandId;
433 /**
434 * The instance ID in which this invocation was requested.
435 */
436 InstanceId?: InstanceId;
437 /**
438 * User-specified information about the command, such as a brief description of what the command should do.
439 */
440 Comment?: Comment;
441 /**
442 * The document name that was requested for execution.
443 */
444 DocumentName?: DocumentName;
445 /**
446 * The time and date the request was sent to this instance.
447 */
448 RequestedDateTime?: DateTime;
449 /**
450 * Whether or not the invocation succeeded, failed, or is pending.
451 */
452 Status?: CommandInvocationStatus;
453 /**
454 * Gets the trace output sent by the agent.
455 */
456 TraceOutput?: InvocationTraceOutput;
457 CommandPlugins?: CommandPluginList;
458 /**
459 * The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes on a per instance basis.
460 */
461 ServiceRole?: ServiceRole;
462 /**
463 * Configurations for sending notifications about command status changes on a per instance basis.
464 */
465 NotificationConfig?: NotificationConfig;
466 }
467 export type CommandInvocationList = CommandInvocation[];
468 export type CommandInvocationStatus = "Pending"|"InProgress"|"Cancelling"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
469 export type CommandList = Command[];
470 export type CommandMaxResults = number;
471 export interface CommandPlugin {
472 /**
473 * 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.
474 */
475 Name?: CommandPluginName;
476 /**
477 * The status of this plugin. You can execute a document with multiple plugins.
478 */
479 Status?: CommandPluginStatus;
480 /**
481 * A numeric response code generated after executing the plugin.
482 */
483 ResponseCode?: ResponseCode;
484 /**
485 * The time the plugin started executing.
486 */
487 ResponseStartDateTime?: DateTime;
488 /**
489 * The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
490 */
491 ResponseFinishDateTime?: DateTime;
492 /**
493 * Output of the plugin execution.
494 */
495 Output?: CommandPluginOutput;
496 /**
497 * The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
498 */
499 OutputS3BucketName?: S3BucketName;
500 /**
501 * The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
502 */
503 OutputS3KeyPrefix?: S3KeyPrefix;
504 }
505 export type CommandPluginList = CommandPlugin[];
506 export type CommandPluginName = string;
507 export type CommandPluginOutput = string;
508 export type CommandPluginStatus = "Pending"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
509 export type CommandStatus = "Pending"|"InProgress"|"Cancelling"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
510 export type Comment = string;
511 export type ComputerName = string;
512 export interface CreateActivationRequest {
513 /**
514 * A user-defined description of the resource that you want to register with Amazon EC2.
515 */
516 Description?: ActivationDescription;
517 /**
518 * The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.
519 */
520 DefaultInstanceName?: DefaultInstanceName;
521 /**
522 * The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.
523 */
524 IamRole: IamRole;
525 /**
526 * Specify the maximum number of managed instances you want to register. The default value is 1 instance.
527 */
528 RegistrationLimit?: RegistrationLimit;
529 /**
530 * The date by which this activation request should expire. The default value is 24 hours.
531 */
532 ExpirationDate?: ExpirationDate;
533 }
534 export interface CreateActivationResult {
535 /**
536 * The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
537 */
538 ActivationId?: ActivationId;
539 /**
540 * The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
541 */
542 ActivationCode?: ActivationCode;
543 }
544 export interface CreateAssociationBatchRequest {
545 /**
546 * One or more associations.
547 */
548 Entries: CreateAssociationBatchRequestEntries;
549 }
550 export type CreateAssociationBatchRequestEntries = CreateAssociationBatchRequestEntry[];
551 export interface CreateAssociationBatchRequestEntry {
552 /**
553 * The name of the configuration document.
554 */
555 Name?: DocumentName;
556 /**
557 * The ID of the instance.
558 */
559 InstanceId?: InstanceId;
560 /**
561 * A description of the parameters for a document.
562 */
563 Parameters?: Parameters;
564 }
565 export interface CreateAssociationBatchResult {
566 /**
567 * Information about the associations that succeeded.
568 */
569 Successful?: AssociationDescriptionList;
570 /**
571 * Information about the associations that failed.
572 */
573 Failed?: FailedCreateAssociationList;
574 }
575 export interface CreateAssociationRequest {
576 /**
577 * The name of the SSM document.
578 */
579 Name: DocumentName;
580 /**
581 * The instance ID.
582 */
583 InstanceId: InstanceId;
584 /**
585 * The parameters for the documents runtime configuration.
586 */
587 Parameters?: Parameters;
588 }
589 export interface CreateAssociationResult {
590 /**
591 * Information about the association.
592 */
593 AssociationDescription?: AssociationDescription;
594 }
595 export interface CreateDocumentRequest {
596 /**
597 * A valid JSON string.
598 */
599 Content: DocumentContent;
600 /**
601 * A name for the SSM document.
602 */
603 Name: DocumentName;
604 }
605 export interface CreateDocumentResult {
606 /**
607 * Information about the SSM document.
608 */
609 DocumentDescription?: DocumentDescription;
610 }
611 export type CreatedDate = Date;
612 export type DateTime = Date;
613 export type DefaultInstanceName = string;
614 export interface DeleteActivationRequest {
615 /**
616 * The ID of the activation that you want to delete.
617 */
618 ActivationId: ActivationId;
619 }
620 export interface DeleteActivationResult {
621 }
622 export interface DeleteAssociationRequest {
623 /**
624 * The name of the SSM document.
625 */
626 Name: DocumentName;
627 /**
628 * The ID of the instance.
629 */
630 InstanceId: InstanceId;
631 }
632 export interface DeleteAssociationResult {
633 }
634 export interface DeleteDocumentRequest {
635 /**
636 * The name of the SSM document.
637 */
638 Name: DocumentName;
639 }
640 export interface DeleteDocumentResult {
641 }
642 export interface DeregisterManagedInstanceRequest {
643 /**
644 * The ID assigned to the managed instance when you registered it using the activation process.
645 */
646 InstanceId: ManagedInstanceId;
647 }
648 export interface DeregisterManagedInstanceResult {
649 }
650 export interface DescribeActivationsFilter {
651 /**
652 * The name of the filter.
653 */
654 FilterKey?: DescribeActivationsFilterKeys;
655 /**
656 * The filter values.
657 */
658 FilterValues?: StringList;
659 }
660 export type DescribeActivationsFilterKeys = "ActivationIds"|"DefaultInstanceName"|"IamRole"|string;
661 export type DescribeActivationsFilterList = DescribeActivationsFilter[];
662 export interface DescribeActivationsRequest {
663 /**
664 * A filter to view information about your activations.
665 */
666 Filters?: DescribeActivationsFilterList;
667 /**
668 * 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.
669 */
670 MaxResults?: MaxResults;
671 /**
672 * A token to start the list. Use this token to get the next set of results.
673 */
674 NextToken?: NextToken;
675 }
676 export interface DescribeActivationsResult {
677 /**
678 * A list of activations for your AWS account.
679 */
680 ActivationList?: ActivationList;
681 /**
682 * The token for the next set of items to return. Use this token to get the next set of results.
683 */
684 NextToken?: NextToken;
685 }
686 export interface DescribeAssociationRequest {
687 /**
688 * The name of the SSM document.
689 */
690 Name: DocumentName;
691 /**
692 * The instance ID.
693 */
694 InstanceId: InstanceId;
695 }
696 export interface DescribeAssociationResult {
697 /**
698 * Information about the association.
699 */
700 AssociationDescription?: AssociationDescription;
701 }
702 export interface DescribeDocumentPermissionRequest {
703 /**
704 * The name of the document for which you are the owner.
705 */
706 Name: DocumentName;
707 /**
708 * The permission type for the document. The permission type can be Share.
709 */
710 PermissionType: DocumentPermissionType;
711 }
712 export interface DescribeDocumentPermissionResponse {
713 /**
714 * The account IDs that have permission to use this document. The ID can be either an AWS account or All.
715 */
716 AccountIds?: AccountIdList;
717 }
718 export interface DescribeDocumentRequest {
719 /**
720 * The name of the SSM document.
721 */
722 Name: DocumentARN;
723 }
724 export interface DescribeDocumentResult {
725 /**
726 * Information about the SSM document.
727 */
728 Document?: DocumentDescription;
729 }
730 export interface DescribeInstanceInformationRequest {
731 /**
732 * One or more filters. Use a filter to return a more specific list of instances.
733 */
734 InstanceInformationFilterList?: InstanceInformationFilterList;
735 /**
736 * 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.
737 */
738 MaxResults?: MaxResultsEC2Compatible;
739 /**
740 * The token for the next set of items to return. (You received this token from a previous call.)
741 */
742 NextToken?: NextToken;
743 }
744 export interface DescribeInstanceInformationResult {
745 /**
746 * The instance information list.
747 */
748 InstanceInformationList?: InstanceInformationList;
749 /**
750 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
751 */
752 NextToken?: NextToken;
753 }
754 export type DescriptionInDocument = string;
755 export type DocumentARN = string;
756 export type DocumentContent = string;
757 export interface DocumentDescription {
758 /**
759 * The SHA1 hash of the document, which you can use for verification purposes.
760 */
761 Sha1?: DocumentSha1;
762 /**
763 * The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
764 */
765 Hash?: DocumentHash;
766 /**
767 * Sha256 or Sha1. Sha1 hashes have been deprecated.
768 */
769 HashType?: DocumentHashType;
770 /**
771 * The name of the SSM document.
772 */
773 Name?: DocumentARN;
774 /**
775 * The AWS user account of the person who created the document.
776 */
777 Owner?: DocumentOwner;
778 /**
779 * The date when the SSM document was created.
780 */
781 CreatedDate?: DateTime;
782 /**
783 * The status of the SSM document.
784 */
785 Status?: DocumentStatus;
786 /**
787 * A description of the document.
788 */
789 Description?: DescriptionInDocument;
790 /**
791 * A description of the parameters for a document.
792 */
793 Parameters?: DocumentParameterList;
794 /**
795 * The list of OS platforms compatible with this SSM document.
796 */
797 PlatformTypes?: PlatformTypeList;
798 }
799 export interface DocumentFilter {
800 /**
801 * The name of the filter.
802 */
803 key: DocumentFilterKey;
804 /**
805 * The value of the filter.
806 */
807 value: DocumentFilterValue;
808 }
809 export type DocumentFilterKey = "Name"|"Owner"|"PlatformTypes"|string;
810 export type DocumentFilterList = DocumentFilter[];
811 export type DocumentFilterValue = string;
812 export type DocumentHash = string;
813 export type DocumentHashType = "Sha256"|"Sha1"|string;
814 export interface DocumentIdentifier {
815 /**
816 * The name of the SSM document.
817 */
818 Name?: DocumentARN;
819 /**
820 * The AWS user account of the person who created the document.
821 */
822 Owner?: DocumentOwner;
823 /**
824 * The operating system platform.
825 */
826 PlatformTypes?: PlatformTypeList;
827 }
828 export type DocumentIdentifierList = DocumentIdentifier[];
829 export type DocumentName = string;
830 export type DocumentOwner = string;
831 export interface DocumentParameter {
832 /**
833 * The name of the parameter.
834 */
835 Name?: DocumentParameterName;
836 /**
837 * The type of parameter. The type can be either “String” or “StringList”.
838 */
839 Type?: DocumentParameterType;
840 /**
841 * A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
842 */
843 Description?: DocumentParameterDescrption;
844 /**
845 * If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
846 */
847 DefaultValue?: DocumentParameterDefaultValue;
848 }
849 export type DocumentParameterDefaultValue = string;
850 export type DocumentParameterDescrption = string;
851 export type DocumentParameterList = DocumentParameter[];
852 export type DocumentParameterName = string;
853 export type DocumentParameterType = "String"|"StringList"|string;
854 export type DocumentPermissionType = "Share"|string;
855 export type DocumentSha1 = string;
856 export type DocumentStatus = "Creating"|"Active"|"Deleting"|string;
857 export type ExpirationDate = Date;
858 export interface FailedCreateAssociation {
859 /**
860 * The association.
861 */
862 Entry?: CreateAssociationBatchRequestEntry;
863 /**
864 * A description of the failure.
865 */
866 Message?: BatchErrorMessage;
867 /**
868 * The source of the failure.
869 */
870 Fault?: Fault;
871 }
872 export type FailedCreateAssociationList = FailedCreateAssociation[];
873 export type Fault = "Client"|"Server"|"Unknown"|string;
874 export interface GetDocumentRequest {
875 /**
876 * The name of the SSM document.
877 */
878 Name: DocumentARN;
879 }
880 export interface GetDocumentResult {
881 /**
882 * The name of the SSM document.
883 */
884 Name?: DocumentARN;
885 /**
886 * The contents of the SSM document.
887 */
888 Content?: DocumentContent;
889 }
890 export type IPAddress = string;
891 export type IamRole = string;
892 export type InstanceId = string;
893 export type InstanceIdList = InstanceId[];
894 export interface InstanceInformation {
895 /**
896 * The instance ID.
897 */
898 InstanceId?: InstanceId;
899 /**
900 * Connection status of the SSM agent.
901 */
902 PingStatus?: PingStatus;
903 /**
904 * The date and time when agent last pinged SSM service.
905 */
906 LastPingDateTime?: DateTime;
907 /**
908 * The version of the SSM agent running on your Linux instance.
909 */
910 AgentVersion?: Version;
911 /**
912 * Indicates whether latest version of the SSM agent is running on your instance.
913 */
914 IsLatestVersion?: Boolean;
915 /**
916 * The operating system platform type.
917 */
918 PlatformType?: PlatformType;
919 /**
920 * The name of the operating system platform running on your instance.
921 */
922 PlatformName?: String;
923 /**
924 * The version of the OS platform running on your instance.
925 */
926 PlatformVersion?: String;
927 /**
928 * The activation ID created by SSM when the server or VM was registered.
929 */
930 ActivationId?: ActivationId;
931 /**
932 * The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances.
933 */
934 IamRole?: IamRole;
935 /**
936 * The date the server or VM was registered with AWS as a managed instance.
937 */
938 RegistrationDate?: DateTime;
939 /**
940 * The type of instance. Instances are either EC2 instances or managed instances.
941 */
942 ResourceType?: ResourceType;
943 /**
944 * The name of the managed instance.
945 */
946 Name?: String;
947 /**
948 * The IP address of the managed instance.
949 */
950 IPAddress?: IPAddress;
951 /**
952 * The fully qualified host name of the managed instance.
953 */
954 ComputerName?: ComputerName;
955 }
956 export interface InstanceInformationFilter {
957 /**
958 * The name of the filter.
959 */
960 key: InstanceInformationFilterKey;
961 /**
962 * The filter values.
963 */
964 valueSet: InstanceInformationFilterValueSet;
965 }
966 export type InstanceInformationFilterKey = "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|string;
967 export type InstanceInformationFilterList = InstanceInformationFilter[];
968 export type InstanceInformationFilterValue = string;
969 export type InstanceInformationFilterValueSet = InstanceInformationFilterValue[];
970 export type InstanceInformationList = InstanceInformation[];
971 export type InvocationTraceOutput = string;
972 export type KeyList = TagKey[];
973 export interface ListAssociationsRequest {
974 /**
975 * One or more filters. Use a filter to return a more specific list of results.
976 */
977 AssociationFilterList: AssociationFilterList;
978 /**
979 * 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.
980 */
981 MaxResults?: MaxResults;
982 /**
983 * The token for the next set of items to return. (You received this token from a previous call.)
984 */
985 NextToken?: NextToken;
986 }
987 export interface ListAssociationsResult {
988 /**
989 * The associations.
990 */
991 Associations?: AssociationList;
992 /**
993 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
994 */
995 NextToken?: NextToken;
996 }
997 export interface ListCommandInvocationsRequest {
998 /**
999 * (Optional) The invocations for a specific command ID.
1000 */
1001 CommandId?: CommandId;
1002 /**
1003 * (Optional) The command execution details for a specific instance ID.
1004 */
1005 InstanceId?: InstanceId;
1006 /**
1007 * (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.
1008 */
1009 MaxResults?: CommandMaxResults;
1010 /**
1011 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
1012 */
1013 NextToken?: NextToken;
1014 /**
1015 * (Optional) One or more filters. Use a filter to return a more specific list of results.
1016 */
1017 Filters?: CommandFilterList;
1018 /**
1019 * (Optional) If set this returns the response of the command executions and any command output. By default this is set to False.
1020 */
1021 Details?: Boolean;
1022 }
1023 export interface ListCommandInvocationsResult {
1024 /**
1025 * (Optional) A list of all invocations.
1026 */
1027 CommandInvocations?: CommandInvocationList;
1028 /**
1029 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
1030 */
1031 NextToken?: NextToken;
1032 }
1033 export interface ListCommandsRequest {
1034 /**
1035 * (Optional) If provided, lists only the specified command.
1036 */
1037 CommandId?: CommandId;
1038 /**
1039 * (Optional) Lists commands issued against this instance ID.
1040 */
1041 InstanceId?: InstanceId;
1042 /**
1043 * (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.
1044 */
1045 MaxResults?: CommandMaxResults;
1046 /**
1047 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
1048 */
1049 NextToken?: NextToken;
1050 /**
1051 * (Optional) One or more filters. Use a filter to return a more specific list of results.
1052 */
1053 Filters?: CommandFilterList;
1054 }
1055 export interface ListCommandsResult {
1056 /**
1057 * (Optional) The list of commands requested by the user.
1058 */
1059 Commands?: CommandList;
1060 /**
1061 * (Optional) The token for the next set of items to return. (You received this token from a previous call.)
1062 */
1063 NextToken?: NextToken;
1064 }
1065 export interface ListDocumentsRequest {
1066 /**
1067 * One or more filters. Use a filter to return a more specific list of results.
1068 */
1069 DocumentFilterList?: DocumentFilterList;
1070 /**
1071 * 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.
1072 */
1073 MaxResults?: MaxResults;
1074 /**
1075 * The token for the next set of items to return. (You received this token from a previous call.)
1076 */
1077 NextToken?: NextToken;
1078 }
1079 export interface ListDocumentsResult {
1080 /**
1081 * The names of the SSM documents.
1082 */
1083 DocumentIdentifiers?: DocumentIdentifierList;
1084 /**
1085 * The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
1086 */
1087 NextToken?: NextToken;
1088 }
1089 export interface ListTagsForResourceRequest {
1090 /**
1091 * Returns a list of tags for a specific resource type.
1092 */
1093 ResourceType: ResourceTypeForTagging;
1094 /**
1095 * The resource ID for which you want to see a list of tags.
1096 */
1097 ResourceId: ResourceId;
1098 }
1099 export interface ListTagsForResourceResult {
1100 /**
1101 * A list of tags.
1102 */
1103 TagList?: TagList;
1104 }
1105 export type ManagedInstanceId = string;
1106 export type MaxResults = number;
1107 export type MaxResultsEC2Compatible = number;
1108 export interface ModifyDocumentPermissionRequest {
1109 /**
1110 * The name of the document that you want to share.
1111 */
1112 Name: DocumentName;
1113 /**
1114 * The permission type for the document. The permission type can be Share.
1115 */
1116 PermissionType: DocumentPermissionType;
1117 /**
1118 * The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
1119 */
1120 AccountIdsToAdd?: AccountIdList;
1121 /**
1122 * 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.
1123 */
1124 AccountIdsToRemove?: AccountIdList;
1125 }
1126 export interface ModifyDocumentPermissionResponse {
1127 }
1128 export type NextToken = string;
1129 export type NotificationArn = string;
1130 export interface NotificationConfig {
1131 /**
1132 * An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. SSM pushes notifications about command status changes to this topic.
1133 */
1134 NotificationArn?: NotificationArn;
1135 /**
1136 * 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 Monitoring Commands in the Amazon Elastic Compute Cloud User Guide .
1137 */
1138 NotificationEvents?: NotificationEventList;
1139 /**
1140 * 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.
1141 */
1142 NotificationType?: NotificationType;
1143 }
1144 export type NotificationEvent = "All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
1145 export type NotificationEventList = NotificationEvent[];
1146 export type NotificationType = "Command"|"Invocation"|string;
1147 export type ParameterName = string;
1148 export type ParameterValue = string;
1149 export type ParameterValueList = ParameterValue[];
1150 export type Parameters = {[key: string]: ParameterValueList};
1151 export type PingStatus = "Online"|"ConnectionLost"|"Inactive"|string;
1152 export type PlatformType = "Windows"|"Linux"|string;
1153 export type PlatformTypeList = PlatformType[];
1154 export type RegistrationLimit = number;
1155 export type RegistrationsCount = number;
1156 export interface RemoveTagsFromResourceRequest {
1157 /**
1158 * The type of resource of which you want to remove a tag.
1159 */
1160 ResourceType: ResourceTypeForTagging;
1161 /**
1162 * The resource ID for which you want to remove tags.
1163 */
1164 ResourceId: ResourceId;
1165 /**
1166 * Tag keys that you want to remove from the specified resource.
1167 */
1168 TagKeys: KeyList;
1169 }
1170 export interface RemoveTagsFromResourceResult {
1171 }
1172 export type ResourceId = string;
1173 export type ResourceType = "ManagedInstance"|"Document"|"EC2Instance"|string;
1174 export type ResourceTypeForTagging = "ManagedInstance"|string;
1175 export type ResponseCode = number;
1176 export type S3BucketName = string;
1177 export type S3KeyPrefix = string;
1178 export interface SendCommandRequest {
1179 /**
1180 * Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.
1181 */
1182 InstanceIds: InstanceIdList;
1183 /**
1184 * Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
1185 */
1186 DocumentName: DocumentARN;
1187 /**
1188 * The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
1189 */
1190 DocumentHash?: DocumentHash;
1191 /**
1192 * Sha256 or Sha1. Sha1 hashes have been deprecated.
1193 */
1194 DocumentHashType?: DocumentHashType;
1195 /**
1196 * If this time is reached and the command has not already started executing, it will not execute.
1197 */
1198 TimeoutSeconds?: TimeoutSeconds;
1199 /**
1200 * User-specified information about the command, such as a brief description of what the command should do.
1201 */
1202 Comment?: Comment;
1203 /**
1204 * The required and optional parameters specified in the SSM document being executed.
1205 */
1206 Parameters?: Parameters;
1207 /**
1208 * The name of the S3 bucket where command execution responses should be stored.
1209 */
1210 OutputS3BucketName?: S3BucketName;
1211 /**
1212 * The directory structure within the S3 bucket where the responses should be stored.
1213 */
1214 OutputS3KeyPrefix?: S3KeyPrefix;
1215 /**
1216 * The IAM role that SSM uses to send notifications.
1217 */
1218 ServiceRoleArn?: ServiceRole;
1219 /**
1220 * Configurations for sending notifications.
1221 */
1222 NotificationConfig?: NotificationConfig;
1223 }
1224 export interface SendCommandResult {
1225 /**
1226 * The request as it was received by SSM. Also provides the command ID which can be used future references to this request.
1227 */
1228 Command?: Command;
1229 }
1230 export type ServiceRole = string;
1231 export type StatusAdditionalInfo = string;
1232 export type StatusMessage = string;
1233 export type String = string;
1234 export type StringList = String[];
1235 export interface Tag {
1236 /**
1237 * The name of the tag.
1238 */
1239 Key: TagKey;
1240 /**
1241 * The value of the tag.
1242 */
1243 Value: TagValue;
1244 }
1245 export type TagKey = string;
1246 export type TagList = Tag[];
1247 export type TagValue = string;
1248 export type TimeoutSeconds = number;
1249 export interface UpdateAssociationStatusRequest {
1250 /**
1251 * The name of the SSM document.
1252 */
1253 Name: DocumentName;
1254 /**
1255 * The ID of the instance.
1256 */
1257 InstanceId: InstanceId;
1258 /**
1259 * The association status.
1260 */
1261 AssociationStatus: AssociationStatus;
1262 }
1263 export interface UpdateAssociationStatusResult {
1264 /**
1265 * Information about the association.
1266 */
1267 AssociationDescription?: AssociationDescription;
1268 }
1269 export interface UpdateManagedInstanceRoleRequest {
1270 /**
1271 * The ID of the managed instance where you want to update the role.
1272 */
1273 InstanceId: ManagedInstanceId;
1274 /**
1275 * The IAM role you want to assign or change.
1276 */
1277 IamRole: IamRole;
1278 }
1279 export interface UpdateManagedInstanceRoleResult {
1280 }
1281 export type Version = string;
1282 /**
1283 * 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.
1284 */
1285 export type apiVersion = "2014-11-06"|"latest"|string;
1286 export interface ClientApiVersions {
1287 /**
1288 * 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.
1289 */
1290 apiVersion?: apiVersion;
1291 }
1292 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1293 }
1294 export = SSM;