quick_sight_q_search_configurations

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

Overview

Name	quick_sight_q_search_configurations
Type	Resource
Id	aws.quicksight.quick_sight_q_search_configurations

Fields

The following fields are returned by SELECT queries:

describe_quick_sight_q_search_configuration

Name	Datatype	Description
q_search_status	string	The status of Quick Sight Q Search configuration. (ENABLED, DISABLED)
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_quick_sight_q_search_configuration	select	aws_account_id, region		Describes the state of a Quick Sight Q Search configuration.
update_quick_sight_q_search_configuration	update	aws_account_id, region, QSearchStatus		Updates the state of a Quick Sight Q Search configuration.

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 Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_quick_sight_q_search_configuration

Describes the state of a Quick Sight Q Search configuration.

SELECT
q_search_status,
request_id,
status
FROM aws.quicksight.quick_sight_q_search_configurations
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_quick_sight_q_search_configuration

Updates the state of a Quick Sight Q Search configuration.

UPDATE aws.quicksight.quick_sight_q_search_configurations
SET 
QSearchStatus = '{{ QSearchStatus }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND QSearchStatus = '{{ QSearchStatus }}' --required
RETURNING
q_search_status,
request_id,
status;