QBusiness / Client / update_subscription

update_subscription#

QBusiness.Client.update_subscription(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_subscription(
    applicationId='string',
    subscriptionId='string',
    type='Q_LITE'|'Q_BUSINESS'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

  • subscriptionId (string) –

    [REQUIRED]

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

  • type (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'subscriptionArn': 'string',
    'currentSubscription': {
        'type': 'Q_LITE'|'Q_BUSINESS'
    },
    'nextSubscription': {
        'type': 'Q_LITE'|'Q_BUSINESS'
    }
}

Response Structure

  • (dict) –

    • subscriptionArn (string) –

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

    • currentSubscription (dict) –

      The type of your current Amazon Q Business subscription.

      • type (string) –

        The type of an Amazon Q Business subscription.

    • nextSubscription (dict) –

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

      • type (string) –

        The type of an Amazon Q Business subscription.

Exceptions