- 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
Removes a tag from an index, FAQ, data source, or other resource.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KendraClient, UntagResourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, UntagResourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // UntagResourceRequest
ResourceARN: "STRING_VALUE", // required
TagKeys: [ // TagKeyList // required
"STRING_VALUE",
],
};
const command = new UntagResourceCommand(input);
const response = await client.send(command);
// {};
UntagResourceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ResourceARN Required | string | undefined | The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to remove a tag. For example, the ARN of an index is constructed as follows: arn:aws:kendra:your-region:your-account-id:index/index-id For information on how to construct an ARN for all types of Amazon Kendra resources, see Resource types . |
TagKeys Required | string[] | undefined | A list of tag keys to remove from the index, FAQ, data source, or other resource. If a tag key doesn't exist for the resource, it is ignored. |
UntagResourceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again. |
InternalServerException | server | An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help. |
ResourceUnavailableException | client | The resource you want to use isn't available. Please check you have provided the correct resource and try again. |
ThrottlingException | client | The request was denied due to request throttling. Please reduce the number of requests and try again. |
ValidationException | client | The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again. |
KendraServiceException | Base exception class for all service exceptions from Kendra service. |