DescribeDefaultQBusinessApplication
Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.
Request Syntax
GET /accounts/AwsAccountId/default-qbusiness-application?namespace=Namespace HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the Amazon QuickSight account that is linked to the Amazon Q Business application that you want described.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
- Namespace
-
The Amazon QuickSight 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 does not have a request body.
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"ApplicationId": "string",
"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.
- ApplicationId
-
The ID of the Amazon Q Business application that is linked to the Amazon QuickSight account.
Type: String
- RequestId
-
The AWS 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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
HTTP Status Code: 401
- InternalFailureException
-
An internal failure occurred.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
