Skip to content

CreateSubscriptionRequest

Source code in docs_src/capo_qbusiness/types/create_subscription_request.py
class CreateSubscriptionRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business application the subscription should be added to.</p>"""
    principal: "capo_qbusiness.types.subscription_principal.SubscriptionPrincipal"
    """<p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>"""
    type: "capo_qbusiness.types.subscription_type.SubscriptionType"
    """<p>The type of Amazon Q Business subscription you want to create.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>"""

application_id instance-attribute

application_id: ApplicationId

The identifier of the Amazon Q Business application the subscription should be added to.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A token that you provide to identify the request to create a subscription for your Amazon Q Business application.

principal instance-attribute

The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

type instance-attribute

The type of Amazon Q Business subscription you want to create.