Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CancelSubscription

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.

Request Syntax


DELETE /applications/applicationId/subscriptions/subscriptionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

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

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

Length Constraints: Minimum length of 0. Maximum length of 1224.

Required: Yes

Request Body

The request does not have a request body.

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

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

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.

message: The message describing a ResourceNotFoundException.
resourceId: The identifier of the resource affected.
resourceType: The type of the resource affected.

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.

fields: The input field(s) that failed validation.
message: The message describing the ValidationException.
reason: The reason for the ValidationException.

HTTP Status Code: 400