Actions, resources, and condition keys for Amazon Q in Connect
Amazon Q in Connect (service prefix: wisdom
) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by Amazon Q in Connect
You can specify the following actions in the Action
element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource
element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource
element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition
element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
ActivateMessageTemplate | Grants permission to activate a message template | Write | |||
AllowVendedLogDeliveryForResource [permission only] | Grants permission to configure vended log delivery for an assistant | Permissions management | |||
CreateAIAgent | Grants permission to create an ai agent | Write | |||
CreateAIAgentVersion | Grants permission to create an ai agent version | Write | |||
CreateAIGuardrail | Grants permission to create an ai guardrail | Write | |||
CreateAIGuardrailVersion | Grants permission to create an ai guardrail version | Write | |||
CreateAIPrompt | Grants permission to create an ai prompt | Write | |||
CreateAIPromptVersion | Grants permission to create an ai prompt version | Write | |||
CreateAssistant | Grants permission to create an assistant | Write | |||
CreateAssistantAssociation | Grants permission to create an association between an assistant and another resource | Write | |||
CreateContent | Grants permission to create content | Write | |||
CreateContentAssociation | Grants permission to create a content association | Write | |||
CreateKnowledgeBase | Grants permission to create a knowledge base | Write | |||
CreateMessageTemplate | Grants permission to create a message template | Write | |||
CreateMessageTemplateAttachment | Grants permission to create an attachment to a message template | Write | |||
CreateMessageTemplateVersion | Grants permission to create a version of a message template | Write | |||
CreateQuickResponse | Grants permission to create quick response | Write | |||
CreateSession | Grants permission to create a session | Write | |||
DeactivateMessageTemplate | Grants permission to deactivate a message template | Write | |||
DeleteAIAgent | Grants permission to delete an ai agent | Write | |||
DeleteAIAgentVersion | Grants permission to delete an ai agent version | Write | |||
DeleteAIGuardrail | Grants permission to delete an ai guardrail | Write | |||
DeleteAIGuardrailVersion | Grants permission to delete an ai guardrail version | Write | |||
DeleteAIPrompt | Grants permission to delete an ai prompt | Write | |||
DeleteAIPromptVersion | Grants permission to delete an ai prompt version | Write | |||
DeleteAssistant | Grants permission to delete an assistant | Write | |||
DeleteAssistantAssociation | Grants permission to delete an assistant association | Write | |||
DeleteContent | Grants permission to delete content | Write | |||
DeleteContentAssociation | Grants permission to delete a content association | Write | |||
DeleteImportJob | Grants permission to delete a import job of a knowledge base | Write | |||
DeleteKnowledgeBase | Grants permission to delete a knowledge base | Write | |||
DeleteMessageTemplate | Grants permission to delete a message template | Write | |||
DeleteMessageTemplateAttachment | Grants permission to delete an attachment from a message template | Write | |||
DeleteQuickResponse | Grants permission to delete quick response | Write | |||
GetAIAgent | Grants permission to retrieve information about an ai agent | Read | |||
GetAIGuardrail | Grants permission to retrieve information about an ai guardrail | Read | |||
GetAIPrompt | Grants permission to retrieve information about an ai prompt | Read | |||
GetAssistant | Grants permission to retrieve information about an assistant | Read | |||
GetAssistantAssociation | Grants permission to retrieve information about an assistant association | Read | |||
GetContent | Grants permission to retrieve content, including a pre-signed URL to download the content | Read | |||
GetContentAssociation | Grants permission to retrieve information about a content association | Read | |||
GetContentSummary | Grants permission to retrieve summary information about the content | Read | |||
GetImportJob | Grants permission to retrieve information about the import job | Read | |||
GetKnowledgeBase | Grants permission to retrieve information about the knowledge base | Read | |||
GetMessageTemplate | Grants permission to retrieve a message template | Read | |||
GetNextMessage | Grants permission to retrieve for next message in a session | Read | |||
GetQuickResponse | Grants permission to retrieve content | Read | |||
GetRecommendations | Grants permission to retrieve recommendations for the specified session | Read | |||
GetSession | Grants permission to retrieve information for a specified session | Read | |||
ListAIAgentVersions | Grants permission to list information about ai agent versions | List | |||
ListAIAgents | Grants permission to list information about ai agents | List | |||
ListAIGuardrailVersions | Grants permission to list information about ai guardrail versions | List | |||
ListAIGuardrails | Grants permission to list information about ai guardrails | List | |||
ListAIPromptVersions | Grants permission to list information about ai prompt versions | List | |||
ListAIPrompts | Grants permission to list information about ai prompts | List | |||
ListAssistantAssociations | Grants permission to list information about assistant associations | List | |||
ListAssistants | Grants permission to list information about assistants | List | |||
ListContentAssociations | Grants permission to list information about content associations | List | |||
ListContents | Grants permission to list the content with a knowledge base | List | |||
ListImportJobs | Grants permission to list information about knowledge bases | List | |||
ListKnowledgeBases | Grants permission to list information about knowledge bases | List | |||
ListMessageTemplateVersions | Grants permission to list message template versions for the specified message template | List | |||
ListMessageTemplates | Grants permission to list the message templates for a knowledge base | List | |||
ListMessages | Grants permission to list messages in a session | List | |||
ListQuickResponses | Grants permission to list the quick response with a knowledge base | List | |||
ListTagsForResource | Grants permission to list the tags for the specified resource | Read | |||
NotifyRecommendationsReceived | Grants permission to remove the specified recommendations from the specified assistant's queue of newly available recommendations | Write | |||
PutFeedback | Grants permission to submit feedback | Write | |||
QueryAssistant | Grants permission to perform a manual search against the specified assistant | Read | |||
RemoveAssistantAIAgent | Grants permission to remove an ai agent from an assistant | Write | |||
RemoveKnowledgeBaseTemplateUri | Grants permission to remove a URI template from a knowledge base | Write | |||
RenderMessageTemplate | Grants permission to render a message template | Read |
wisdom:GetMessageTemplate |
||
SearchContent | Grants permission to search for content referencing a specified knowledge base. Can be used to get a specific content resource by its name | Read | |||
SearchMessageTemplates | Grants permission to search for message templates referencing a specified knowledge base | Read | |||
SearchQuickResponses | Grants permission to search for quick response referencing a specified knowledge base | Read |
wisdom:GetQuickResponse |
||
SearchSessions | Grants permission to search for sessions referencing a specified assistant. Can be used to et a specific session resource by its name | Read | |||
SendMessage | Grants permission to send a message | Write | |||
StartContentUpload | Grants permission to get a URL to upload content to a knowledge base | Write | |||
StartImportJob | Grants permission to create multiple quick responses | Write | |||
TagResource | Grants permission to add the specified tags to the specified resource | Tagging | |||
UntagResource | Grants permission to remove the specified tags from the specified resource | Tagging | |||
UpdateAIAgent | Grants permission to update information about an ai agent | Write | |||
UpdateAIGuardrail | Grants permission to update information about an ai guardrail | Write | |||
UpdateAIPrompt | Grants permission to update information about an ai prompt | Write | |||
UpdateAssistantAIAgent | Grants permission to update assistant information about an ai agent | Write | |||
UpdateContent | Grants permission to update information about the content | Write | |||
UpdateKnowledgeBaseTemplateUri | Grants permission to update the template URI of a knowledge base | Write | |||
UpdateMessageTemplate | Grants permission to update content of the message template | Write | |||
UpdateMessageTemplateMetadata | Grants permission to update metadata of the message template | Write | |||
UpdateQuickResponse | Grants permission to update information or content of the quick response | Write | |||
UpdateSession | Grants permission to update a session | Write | |||
UpdateSessionData | Grants permission to update data stored in a session | Write | |||
Resource types defined by Amazon Q in Connect
The following resource types are defined by this service and can be used in the Resource
element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.
Resource types | ARN | Condition keys |
---|---|---|
AIAgent |
arn:${Partition}:wisdom:${Region}:${Account}:ai-agent/${AssistantId}/${AIAgentId}
|
|
AIPrompt |
arn:${Partition}:wisdom:${Region}:${Account}:ai-prompt/${AssistantId}/${AIPromptId}
|
|
AIGuardrail |
arn:${Partition}:wisdom:${Region}:${Account}:ai-guardrail/${AssistantId}/${AIGuardrailId}
|
|
Assistant |
arn:${Partition}:wisdom:${Region}:${Account}:assistant/${AssistantId}
|
|
AssistantAssociation |
arn:${Partition}:wisdom:${Region}:${Account}:association/${AssistantId}/${AssistantAssociationId}
|
|
Content |
arn:${Partition}:wisdom:${Region}:${Account}:content/${KnowledgeBaseId}/${ContentId}
|
|
ContentAssociation |
arn:${Partition}:wisdom:${Region}:${Account}:content-association/${KnowledgeBaseId}/${ContentId}/${ContentAssociationId}
|
|
KnowledgeBase |
arn:${Partition}:wisdom:${Region}:${Account}:knowledge-base/${KnowledgeBaseId}
|
|
MessageTemplate |
arn:${Partition}:wisdom:${Region}:${Account}:message-template/${KnowledgeBaseId}/${MessageTemplateId}
|
|
Session |
arn:${Partition}:wisdom:${Region}:${Account}:session/${AssistantId}/${SessionId}
|
|
QuickResponse |
arn:${Partition}:wisdom:${Region}:${Account}:quick-response/${KnowledgeBaseId}/${QuickResponseId}
|
Condition keys for Amazon Q in Connect
Amazon Q in Connect defines the following condition keys that can be used in the Condition
element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
Condition keys | Description | Type |
---|---|---|
aws:RequestTag/${TagKey} | Filters access by the tags that are passed in the request | String |
aws:ResourceTag/${TagKey} | Filters access by the tags associated with the resource | String |
aws:TagKeys | Filters access by the tag keys that are passed in the request | ArrayOfString |
wisdom:MessageTemplate/RoutingProfileArn | Filters access by the connect routing profile arns associated with the resource | ArrayOfARN |
wisdom:SearchFilter/Qualifier | Filters access by the qualifiers that are passed in the request | ArrayOfString |
wisdom:SearchFilter/RoutingProfileArn | Filters access by the connect routing profile arn that is passed in the request | ARN |