UpdateSubscriptionCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, UpdateSubscriptionCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, UpdateSubscriptionCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // UpdateSubscriptionRequest
  applicationId: "STRING_VALUE", // required
  subscriptionId: "STRING_VALUE", // required
  type: "Q_LITE" || "Q_BUSINESS", // required
};
const command = new UpdateSubscriptionCommand(input);
const response = await client.send(command);
// { // UpdateSubscriptionResponse
//   subscriptionArn: "STRING_VALUE",
//   currentSubscription: { // SubscriptionDetails
//     type: "Q_LITE" || "Q_BUSINESS",
//   },
//   nextSubscription: {
//     type: "Q_LITE" || "Q_BUSINESS",
//   },
// };

UpdateSubscriptionCommand Input

See UpdateSubscriptionCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

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

subscriptionId
Required
string | undefined

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

type
Required
SubscriptionType | undefined

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

UpdateSubscriptionCommand Output

See UpdateSubscriptionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
currentSubscription
SubscriptionDetails | undefined

The type of your current Amazon Q Business subscription.

nextSubscription
SubscriptionDetails | undefined

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

subscriptionArn
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ConflictException
client

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.