QBusiness / Client / cancel_subscription

cancel_subscription#

QBusiness.Client.cancel_subscription(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_subscription(
    applicationId='string',
    subscriptionId='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

  • subscriptionId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business subscription being cancelled.

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 being cancelled.

    • 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