MaintenanceWindowRunCommandParameters
The parameters for a RUN_COMMAND task type.
For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
Note
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 Run Command tasks,
Systems Manager uses specified values for TaskParameters and LoggingInfo only if
no values are specified for TaskInvocationParameters.
Contents
- Comment
-
Information about the command(s) to execute.
Type: String
Length Constraints: Maximum length of 100.
Required: No
- DocumentHash
-
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- DocumentHashType
-
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
Type: String
Valid Values:
Sha256 | Sha1Required: No
- NotificationConfig
-
Configurations for sending notifications about command status changes on a per-instance basis.
Type: NotificationConfig object
Required: No
- OutputS3BucketName
-
The name of the Amazon S3 bucket.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Required: No
- OutputS3KeyPrefix
-
The Amazon S3 bucket subfolder.
Type: String
Length Constraints: Maximum length of 500.
Required: No
- Parameters
-
The parameters for the RUN_COMMAND task execution.
Type: String to array of strings map
Required: No
- ServiceRoleArn
-
The IAM service role to assume during task execution.
Type: String
Required: No
- TimeoutSeconds
-
If this time is reached and the command has not already started executing, it doesn't run.
Type: Integer
Valid Range: Minimum value of 30. Maximum value of 2592000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
