- 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
Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { B2biClient, UntagResourceCommand } from "@aws-sdk/client-b2bi"; // ES Modules import
// const { B2biClient, UntagResourceCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import
const client = new B2biClient(config);
const input = { // UntagResourceRequest
ResourceARN: "STRING_VALUE", // required
TagKeys: [ // TagKeyList // required
"STRING_VALUE",
],
};
const command = new UntagResourceCommand(input);
const response = await client.send(command);
// {};
Example Usage
UntagResourceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ResourceARN Required | string | undefined | Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer. |
TagKeys Required | string[] | undefined | Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose. |
UntagResourceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalServerException | server | This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service. |
ResourceNotFoundException | client | Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call. |
ValidationException | client | Occurs when a B2BI object cannot be validated against a request from another object. |
B2biServiceException | Base exception class for all service exceptions from B2bi service. |