- 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.
UntagContactCommand
Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, UntagContactCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UntagContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UntagContactRequest
ContactId: "STRING_VALUE", // required
InstanceId: "STRING_VALUE", // required
TagKeys: [ // ContactTagKeys // required
"STRING_VALUE",
],
};
const command = new UntagContactCommand(input);
const response = await client.send(command);
// {};
UntagContactCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ContactId Required | string | undefined | The identifier of the contact in this instance of Amazon Connect. |
InstanceId Required | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
TagKeys Required | string[] | undefined | A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed. |
UntagContactCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalServiceException | server | Request processing failed because of an error or failure with the service. |
InvalidParameterException | client | One or more of the specified parameters are not valid. |
InvalidRequestException | client | The request is not valid. |
ResourceNotFoundException | client | The specified resource was not found. |
ThrottlingException | client | The throttling limit has been exceeded. |
ConnectServiceException | Base exception class for all service exceptions from Connect service. |