GetMaintenanceWindowTask - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

GetMaintenanceWindowTask

Lists the tasks in a maintenance window.

Note

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

Request Syntax

{ "WindowId": "string", "WindowTaskId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

WindowId

The maintenance window ID that includes the task to retrieve.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^mw-[0-9a-f]{17}$

Required: Yes

WindowTaskId

The maintenance window task ID to retrieve.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Required: Yes

Response Syntax

{ "Description": "string", "LoggingInfo": { "S3BucketName": "string", "S3KeyPrefix": "string", "S3Region": "string" }, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "Priority": number, "ServiceRoleArn": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TaskArn": "string", "TaskInvocationParameters": { "Automation": { "DocumentVersion": "string", "Parameters": { "string" : [ "string" ] } }, "Lambda": { "ClientContext": "string", "Payload": blob, "Qualifier": "string" }, "RunCommand": { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "Comment": "string", "DocumentHash": "string", "DocumentHashType": "string", "DocumentVersion": "string", "NotificationConfig": { "NotificationArn": "string", "NotificationEvents": [ "string" ], "NotificationType": "string" }, "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "Parameters": { "string" : [ "string" ] }, "ServiceRoleArn": "string", "TimeoutSeconds": number }, "StepFunctions": { "Input": "string", "Name": "string" } }, "TaskParameters": { "string" : { "Values": [ "string" ] } }, "TaskType": "string", "WindowId": "string", "WindowTaskId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Description

The retrieved task description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

LoggingInfo

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

Note

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters .

Type: LoggingInfo object

MaxConcurrency

The maximum number of targets allowed to run this task in parallel.

Note

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 7.

Pattern: ^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$

MaxErrors

The maximum number of errors allowed before the task stops being scheduled.

Note

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 7.

Pattern: ^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$

Name

The retrieved task name.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Priority

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.

Type: Integer

Valid Range: Minimum value of 0.

ServiceRoleArn

The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Type: String

Targets

The targets where the task should run.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

TaskArn

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

TaskInvocationParameters

The parameters to pass to the task when it runs.

Type: MaintenanceWindowTaskInvocationParameters object

TaskParameters

The parameters to pass to the task when it runs.

Note

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 .

Type: String to MaintenanceWindowTaskParameterValueExpression object map

Key Length Constraints: Minimum length of 1. Maximum length of 255.

TaskType

The type of task to run.

Type: String

Valid Values: RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA

WindowId

The retrieved maintenance window ID.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^mw-[0-9a-f]{17}$

WindowTaskId

The retrieved maintenance window task ID.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Errors

For information about the errors that are common to all actions, see Common Errors.

DoesNotExistException

Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

For information about resource quotas in Amazon Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of GetMaintenanceWindowTask.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetMaintenanceWindowTask Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20200225T002532Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200225/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 92 { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE" }

Sample Response

{ "WindowId": "mw-0c50858d01EXAMPLE", "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE", "Name": "MyRunCommandTask", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" ] } ], "TaskArn": "AWS-ApplyPatchBaseline", "ServiceRoleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "TaskType": "RUN_COMMAND", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "Comment": "", "Parameters": { "Operation": [ "Install" ], "SnapshotId": [ "" ] }, "TimeoutSeconds": 600 } }, "MaxConcurrency": "1", "MaxErrors": "1" }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: