- 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.
UpdateResourcePolicyCommand
Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LexModelsV2Client, UpdateResourcePolicyCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, UpdateResourcePolicyCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // UpdateResourcePolicyRequest
resourceArn: "STRING_VALUE", // required
policy: "STRING_VALUE", // required
expectedRevisionId: "STRING_VALUE",
};
const command = new UpdateResourcePolicyCommand(input);
const response = await client.send(command);
// { // UpdateResourcePolicyResponse
// resourceArn: "STRING_VALUE",
// revisionId: "STRING_VALUE",
// };
UpdateResourcePolicyCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
policyRequired | string | undefined | A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference . If the policy isn't valid, Amazon Lex returns a validation exception. |
resourceArnRequired | string | undefined | The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to. |
expectedRevisionId | string | undefined | The identifier of the revision of the policy to update. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception. If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values. |
UpdateResourcePolicyCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
resourceArn | string | undefined | The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to. |
revisionId | string | undefined | The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServerException | server | The service encountered an unexpected condition. Try your request again. |
| PreconditionFailedException | client | Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again. |
| ResourceNotFoundException | client | You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again. |
| ServiceQuotaExceededException | client | You have reached a quota for your bot. |
| ThrottlingException | client | Your request rate is too high. Reduce the frequency of requests. |
| ValidationException | client | One of the input parameters in your request isn't valid. Check the parameters and try your request again. |
| LexModelsV2ServiceException | Base exception class for all service exceptions from LexModelsV2 service. |