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
Request Syntax
PUT /applications/applicationId/subscriptions/subscriptionId HTTP/1.1
Content-type: application/json
{
"type": "string"
}URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the Amazon Q Business application where the subscription update should take effect.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}Required: Yes
- subscriptionId
-
The identifier of the Amazon Q Business subscription to be updated.
Length Constraints: Minimum length of 0. Maximum length of 1224.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- type
-
The type of the Amazon Q Business subscription to be updated.
Type: String
Valid Values:
Q_LITE | Q_BUSINESSRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"currentSubscription": {
"type": "string"
},
"nextSubscription": {
"type": "string"
},
"subscriptionArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- currentSubscription
-
The type of your current Amazon Q Business subscription.
Type: SubscriptionDetails object
- nextSubscription
-
The type of the Amazon Q Business subscription for the next month.
Type: SubscriptionDetails object
- subscriptionArn
-
The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 1224.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- ConflictException
-
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.
HTTP Status Code: 409
- InternalServerException
-
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. HTTP Status Code: 500
- ResourceNotFoundException
-
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
