AWS API Changes

2025/01/30 - QBusiness - 4 new api methods

Changes Added APIs to manage QBusiness user subscriptions

CreateSubscription (new)

Link ¶

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. 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

client.create_subscription(
    applicationId='string',
    principal={
        'user': 'string',
        'group': 'string'
    },
    type='Q_LITE'|'Q_BUSINESS',
    clientToken='string'
)

type applicationId:

string

param applicationId:

[REQUIRED]

The identifier of the Amazon Q Business application the subscription should be added to.

type principal:

dict

param principal:

[REQUIRED]

The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

user (string) --

The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.
group (string) --

The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.

type type:

string

param type:

[REQUIRED]

The type of Amazon Q Business subscription you want to create.

type clientToken:

string

param clientToken:

A token that you provide to identify the request to create a subscription for your Amazon Q Business application.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- subscriptionId (string) --
  
  The identifier of the Amazon Q Business subscription created.
- subscriptionArn (string) --
  
  The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.
- 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.

CancelSubscription (new)

Link ¶

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

client.cancel_subscription(
    applicationId='string',
    subscriptionId='string'
)

type applicationId:

string

param applicationId:

[REQUIRED]

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

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The identifier of the Amazon Q Business subscription being cancelled.

rtype:

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.

ListSubscriptions (new)

Link ¶

Lists all subscriptions created in an Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

client.list_subscriptions(
    applicationId='string',
    nextToken='string',
    maxResults=123
)

type applicationId:

string

param applicationId:

[REQUIRED]

The identifier of the Amazon Q Business application linked to the subscription.

type nextToken:

string

param nextToken:

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.

type maxResults:

integer

param maxResults:

The maximum number of Amazon Q Business subscriptions to return.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'subscriptions': [
        {
            'subscriptionId': 'string',
            'subscriptionArn': 'string',
            'principal': {
                'user': 'string',
                'group': 'string'
            },
            'currentSubscription': {
                'type': 'Q_LITE'|'Q_BUSINESS'
            },
            'nextSubscription': {
                'type': 'Q_LITE'|'Q_BUSINESS'
            }
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.
- subscriptions (list) --
  
  An array of summary information on the subscriptions configured for an Amazon Q Business application.
  - (dict) --
    
    Information about an Amazon Q Business subscription.
    
    Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.
    
    Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
    - subscriptionId (string) --
      
      The identifier of the Amazon Q Business subscription to be updated.
    - subscriptionArn (string) --
      
      The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.
    - principal (dict) --
      
      The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: user, group. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - user (string) --
        
        The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.
      - group (string) --
        
        The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.
    - 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.

UpdateSubscription (new)

Link ¶

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

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

type applicationId:

string

param applicationId:

[REQUIRED]

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

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

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

type type:

string

param type:

[REQUIRED]

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

rtype:

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.