UpdateMaintenanceWindowTarget
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.
Note
If a parameter is null, then the corresponding field isn't modified.
Request Syntax
{
"Description": "string",
"Name": "string",
"OwnerInformation": "string",
"Replace": boolean,
"Targets": [
{
"Key": "string",
"Values": [ "string" ]
}
],
"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.
- Description
-
An optional description for the update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- Name
-
A name for the update.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^[a-zA-Z0-9_\-.]{3,128}$Required: No
- OwnerInformation
-
User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- Replace
-
If
True, then all fields that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.Type: Boolean
Required: No
- Targets
-
The targets to add or replace.
Type: Array of Target objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
- WindowId
-
The maintenance window ID with which to modify the target.
Type: String
Length Constraints: Fixed length of 20.
Pattern:
^mw-[0-9a-f]{17}$Required: Yes
- WindowTargetId
-
The target ID to modify.
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",
"Name": "string",
"OwnerInformation": "string",
"Targets": [
{
"Key": "string",
"Values": [ "string" ]
}
],
"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.
- Description
-
The updated description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- Name
-
The updated name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^[a-zA-Z0-9_\-.]{3,128}$ - OwnerInformation
-
The updated owner.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- Targets
-
The updated targets.
Type: Array of Target objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
- WindowId
-
The maintenance window ID specified in the update request.
Type: String
Length Constraints: Fixed length of 20.
Pattern:
^mw-[0-9a-f]{17}$ - WindowTargetId
-
The target ID specified in the update request.
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 AWS 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 UpdateMaintenanceWindowTarget.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateMaintenanceWindowTarget
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: 20240225T005329Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 233
{
"WindowId": "mw-0c50858d01EXAMPLE",
"WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE",
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-07782c72faEXAMPLE"
]
}
],
"Name": "MyNewTaskName",
"Description": "My new task description"
}Sample Response
{
"Description": "My new task description",
"Name": "MyNewTaskName",
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-07782c72faEXAMPLE"
]
}
],
"WindowId": "mw-0c50858d01EXAMPLE",
"WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
