Qbusiness  >  Operations  >  cancel_subscription

cancel_subscription

Operation

cancel_subscription async

cancel_subscription(input: CancelSubscriptionInput, plugins: list[Plugin] | None = None) -> 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
input	CancelSubscriptionInput	An instance of CancelSubscriptionInput.	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
CancelSubscriptionOutput	An instance of CancelSubscriptionOutput.

Input

CancelSubscriptionInput dataclass

Dataclass for CancelSubscriptionInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the Amazon Q Business application for which the subscription is being cancelled.

subscription_id class-attribute instance-attribute

subscription_id: str | None = None

The identifier of the Amazon Q Business subscription being cancelled.

Output

CancelSubscriptionOutput dataclass

Dataclass for CancelSubscriptionOutput structure.

Attributes

current_subscription class-attribute instance-attribute

current_subscription: SubscriptionDetails | None = None

The type of your current Amazon Q Business subscription.

next_subscription class-attribute instance-attribute

next_subscription: SubscriptionDetails | None = None

The type of the Amazon Q Business subscription for the next month.

subscription_arn class-attribute instance-attribute

subscription_arn: str | None = None

The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.