Skip to content

update_subscription

Operation

update_subscription

update_subscription(request: UpdateSubscriptionInput | UpdateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateSubscriptionInputDict]) -> 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
request UpdateSubscriptionInput | UpdateSubscriptionInputDict | 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[UpdateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateSubscriptionOutput

An instance of UpdateSubscriptionOutput.

update_subscription async

update_subscription(request: UpdateSubscriptionInput | UpdateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateSubscriptionInputDict]) -> 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
request UpdateSubscriptionInput | UpdateSubscriptionInputDict | 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[UpdateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateSubscriptionOutput

An instance of UpdateSubscriptionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateSubscriptionInputDict

Bases: TypedDict

Dictionary form of UpdateSubscriptionInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

subscription_id instance-attribute
subscription_id: Required[str]

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

type instance-attribute
type: Required[str]

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

UpdateSubscriptionInput dataclass

Bases: _SerdeShape

Dataclass for UpdateSubscriptionInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | 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 = ...

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

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

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

Output

UpdateSubscriptionOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateSubscriptionOutput 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
response_metadata: ResponseMetadata = ...

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 = ...

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