- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UntagResourceCommand
Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PCSClient, UntagResourceCommand } from "@aws-sdk/client-pcs"; // ES Modules import
// const { PCSClient, UntagResourceCommand } = require("@aws-sdk/client-pcs"); // CommonJS import
const client = new PCSClient(config);
const input = { // UntagResourceRequest
resourceArn: "STRING_VALUE", // required
tagKeys: [ // TagKeys // required
"STRING_VALUE",
],
};
const command = new UntagResourceCommand(input);
const response = await client.send(command);
// {};
UntagResourceCommand Input
See UntagResourceCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
resourceArn Required | string | undefined | The Amazon Resource Name (ARN) of the resource. |
tagKeys Required | string[] | undefined | 1 or more tag keys to remove from the resource. Specify only tag keys and not tag values. |
UntagResourceCommand Output
See UntagResourceCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ResourceNotFoundException | client | The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist. Examples |
PCSServiceException | Base exception class for all service exceptions from PCS service. |