Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DeregisterTargetFromMaintenanceWindow

Removes a target from a maintenance window.

Request Syntax


{
   "Safe": boolean,
   "WindowId": "string",
   "WindowTargetId": "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.

Safe

The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.

Type: Boolean

Required: No

WindowId

The ID of the maintenance window the target should be removed from.

Type: String

Length Constraints: Fixed length of 20.

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

Required: Yes

WindowTargetId

The ID of the target definition to remove.

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


{
   "WindowId": "string",
   "WindowTargetId": "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.

WindowId

The ID of the maintenance window the target was removed from.

Type: String

Length Constraints: Fixed length of 20.

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

WindowTargetId

The ID of the removed target definition.

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

TargetInUseException

You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeregisterTargetFromMaintenanceWindow.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeregisterTargetFromMaintenanceWindow
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: 20200225T182719Z
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: 94

{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
}

Sample Response


{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
}