Skip to content

QBusiness  >  Operations  >  update_subscription

update_subscription

Operation

update_subscription async 

update_subscription(input: UpdateSubscriptionInput, plugins: list[Plugin] | None = None) -> UpdateSubscriptionOutput

Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

Parameters:

Name Type Description Default
input UpdateSubscriptionInput

An instance of UpdateSubscriptionInput.

 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
UpdateSubscriptionOutput

An instance of UpdateSubscriptionOutput.

Input

UpdateSubscriptionInput dataclass

Dataclass for UpdateSubscriptionInput structure.

Attributes

application_id class-attribute instance-attribute 
application_id: str | None = None

The identifier of the Amazon Q Business application where the subscription update should take effect.

subscription_id class-attribute instance-attribute 
subscription_id: str | None = None

The identifier of the Amazon Q Business subscription to be updated.

type class-attribute instance-attribute 
type: str | None = None

The type of the Amazon Q Business subscription to be updated.

Output

UpdateSubscriptionOutput dataclass

Dataclass for UpdateSubscriptionOutput 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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.

subscription_arn class-attribute instance-attribute 
subscription_arn: str | None = None

The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.