QBusiness / Client / create_subscription

create_subscription

QBusiness.Client.create_subscription(**kwargs)

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.

Note

For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.

See also: AWS API Documentation

Request Syntax

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

  • applicationId (string) –

    [REQUIRED]

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

  • principal (dict) –

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

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: user, group.

    • 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 (string) –

    [REQUIRED]

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

  • clientToken (string) –

    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.

Return type:

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.

Exceptions