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

UpdateDefaultQBusinessApplication

Updates a Amazon Q Business application that is linked to a Quick Sight account.

Request Syntax


PUT /accounts/AwsAccountId/default-qbusiness-application?namespace=Namespace HTTP/1.1
Content-type: application/json

{
   "ApplicationId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the Quick Sight account that is connected to the Amazon Q Business application that you want to update.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Namespace

The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

Length Constraints: Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$

Request Body

The request accepts the following data in JSON format.

ApplicationId

The ID of the Amazon Q Business application that you want to update.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

RequestId

The Amazon request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 429