RemoveTagsFromResource
Removes tag keys from the specified resource.
Request Syntax
{
"ResourceId": "string
",
"ResourceType": "string
",
"TagKeys": [ "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.
- ResourceId
-
The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
Automation
:example-c160-4567-8519-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object:
ResourceID
for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically,ResourceID
is created from the strings that come after the wordopsmetadata
in the ARN. For example, an OpsMetadata object with an ARN ofarn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has aResourceID
of eitheraws/ssm/MyGroup/appmanager
or/aws/ssm/MyGroup/appmanager
.For the Document and Parameter values, use the name of the resource.
Note
The
ManagedInstance
type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.Type: String
Required: Yes
- ResourceType
-
The type of resource from which you want to remove a tag.
Note
The
ManagedInstance
type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format:mi-ID_number
. For example,mi-1a2b3c4d5e6f
.Type: String
Valid Values:
Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem | OpsMetadata | Automation | Association
Required: Yes
- TagKeys
-
Tag keys that you want to remove from the specified resource.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidResourceId
-
The resource ID isn't valid. Verify that you entered the correct ID and try again.
HTTP Status Code: 400
- InvalidResourceType
-
The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
HTTP Status Code: 400
- TooManyUpdates
-
There are concurrent updates for a resource that supports one update at a time.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of RemoveTagsFromResource.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.RemoveTagsFromResource
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: 20240221T004031Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 99
{
"ResourceType": "PatchBaseline",
"ResourceId": "pb-0c10e65780EXAMPLE",
"TagKeys": [
"Environment"
]
}
Sample Response
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: