cancel_subscription¶
Operation¶
cancel_subscription
¶
cancel_subscription(request: CancelSubscriptionInput | CancelSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelSubscriptionInputDict]) -> CancelSubscriptionOutput
Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CancelSubscriptionInput | CancelSubscriptionInputDict | 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[CancelSubscriptionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CancelSubscriptionOutput
|
An instance of |
cancel_subscription
async
¶
cancel_subscription(request: CancelSubscriptionInput | CancelSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelSubscriptionInputDict]) -> CancelSubscriptionOutput
Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CancelSubscriptionInput | CancelSubscriptionInputDict | 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[CancelSubscriptionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CancelSubscriptionOutput
|
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.
Output¶
CancelSubscriptionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CancelSubscriptionOutput 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.