create_subscription¶
Operation¶
async
¶
create_subscription(input: CreateSubscriptionInput, plugins: list[Plugin] | None = None) -> CreateSubscriptionOutput
Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.
Amazon Q Business offers two subscription tiers: Q_LITE and
Q_BUSINESS. Subscription tier determines feature access for the user.
For more information on subscriptions and pricing tiers, see Amazon Q
Business pricing.
Note
For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateSubscriptionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateSubscriptionOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateSubscriptionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application the subscription should be added to.
class-attribute
instance-attribute
¶
client_token: str | None = None
A token that you provide to identify the request to create a subscription for your Amazon Q Business application.
class-attribute
instance-attribute
¶
principal: SubscriptionPrincipal | None = None
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.
class-attribute
instance-attribute
¶
type: SubscriptionType | None = None
The type of Amazon Q Business subscription you want to create.
Output¶
dataclass
¶
Dataclass for CreateSubscriptionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
current_subscription: SubscriptionDetails | None = None
The type of your current Amazon Q Business subscription.
class-attribute
instance-attribute
¶
next_subscription: SubscriptionDetails | None = None
The type of the Amazon Q Business subscription for the next month.
class-attribute
instance-attribute
¶
subscription_arn: str | None = None
The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.
class-attribute
instance-attribute
¶
subscription_id: str | None = None
The identifier of the Amazon Q Business subscription created.