create_subscription¶
Operation¶
create_subscription
¶
create_subscription(request: CreateSubscriptionInput | CreateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSubscriptionInputDict]) -> 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 |
|---|---|---|---|
request
|
CreateSubscriptionInput | CreateSubscriptionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[CreateSubscriptionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateSubscriptionOutput
|
An instance of |
create_subscription
async
¶
create_subscription(request: CreateSubscriptionInput | CreateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSubscriptionInputDict]) -> 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 |
|---|---|---|---|
request
|
CreateSubscriptionInput | CreateSubscriptionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[CreateSubscriptionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateSubscriptionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateSubscriptionInputDict
¶
Bases: TypedDict
Dictionary form of CreateSubscriptionInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the Amazon Q Business application the subscription should be added to.
client_token
instance-attribute
¶
client_token: str | None
A token that you provide to identify the request to create a subscription for your Amazon Q Business application.
This field is autopopulated if not provided.
principal
instance-attribute
¶
principal: Required[SubscriptionPrincipal | SubscriptionPrincipalDict]
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.
CreateSubscriptionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateSubscriptionInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the Amazon Q Business application the subscription should be added to.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A token that you provide to identify the request to create a subscription for your Amazon Q Business application.
This field is autopopulated if not provided.
principal
class-attribute
instance-attribute
¶
principal: SubscriptionPrincipal | 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.
Output¶
CreateSubscriptionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateSubscriptionOutput structure.
Attributes¶
current_subscription
class-attribute
instance-attribute
¶
current_subscription: SubscriptionDetails | None = ...
The type of your current Amazon Q Business subscription.
next_subscription
class-attribute
instance-attribute
¶
next_subscription: SubscriptionDetails | None = ...
The type of the Amazon Q Business subscription for the next month.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.