Skip to content

DeliverToQBusinessAction

Source code in docs_src/capo_mailmanager/types/deliver_to_q_business_action.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class DeliverToQBusinessAction(TypedDict, closed=True):
    action_failure_policy: NotRequired[
        "capo_mailmanager.types.action_failure_policy.ActionFailurePolicy"
    ]
    """<p>A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the <code>qbusiness:BatchPutDocument</code> API.</p>"""
    application_id: (
        "capo_mailmanager.types.q_business_application_id.QBusinessApplicationId"
    )
    """<p>The unique identifier of the Amazon Q Business application instance where the email content will be delivered.</p>"""
    index_id: "capo_mailmanager.types.q_business_index_id.QBusinessIndexId"
    """<p>The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.</p>"""
    role_arn: "capo_mailmanager.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the <code>qbusiness:BatchPutDocument</code> API for the given application and index.</p>"""

action_failure_policy instance-attribute 

action_failure_policy: NotRequired[ActionFailurePolicy]

A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

application_id instance-attribute 

application_id: QBusinessApplicationId

The unique identifier of the Amazon Q Business application instance where the email content will be delivered.

index_id instance-attribute 

index_id: QBusinessIndexId

The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.

role_arn instance-attribute 

role_arn: IamRoleArn

The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.