default_q_business_applications

Creates, updates, deletes, gets or lists a default_q_business_applications resource.

Overview

Name	default_q_business_applications
Type	Resource
Id	aws.quicksight.default_q_business_applications

Fields

The following fields are returned by SELECT queries:

describe_default_q_business_application

Name	Datatype	Description
application_id	string	The ID of the Amazon Q Business application that is linked to the Quick Sight account.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_default_q_business_application	select	aws_account_id, region	namespace	Describes a Amazon Q Business application that is linked to an Quick Sight account.
update_default_q_business_application	update	aws_account_id, region, ApplicationId	namespace	Updates a Amazon Q Business application that is linked to a Quick Sight account.
delete_default_q_business_application	delete	aws_account_id, region	namespace	Deletes a linked Amazon Q Business application from an Quick Sight account

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The ID of the Quick Sight account that you want to disconnect from a Amazon Q Business application.
region	string	AWS region (default: us-east-1)
namespace	string	The Quick Sight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.

SELECT examples

describe_default_q_business_application

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

SELECT
application_id,
request_id,
status
FROM aws.quicksight.default_q_business_applications
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND namespace = '{{ namespace }}'
;

UPDATE examples

update_default_q_business_application

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

UPDATE aws.quicksight.default_q_business_applications
SET 
ApplicationId = '{{ ApplicationId }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND ApplicationId = '{{ ApplicationId }}' --required
AND namespace = '{{ namespace}}'
RETURNING
request_id,
status;

DELETE examples

delete_default_q_business_application

Deletes a linked Amazon Q Business application from an Quick Sight account

DELETE FROM aws.quicksight.default_q_business_applications
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND namespace = '{{ namespace }}'
;