key_registrations

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

Overview

Name	key_registrations
Type	Resource
Id	aws.quicksight.key_registrations

Fields

The following fields are returned by SELECT queries:

describe_key_registration

Name	Datatype	Description
aws_account_id	string	The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request. (pattern: <code>^[0-9]{12}$</code>)
key_registration	array	A list of RegisteredCustomerManagedKey objects in a Quick Sight account.
q_data_key	object	A list of QDataKey objects in a Quick Sight account.
request_id	string	The Amazon Web Services request ID for this operation. (pattern: <code>.\S.</code>)
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_key_registration	select	aws_account_id, region	default-key-only	Describes all customer managed key registrations in a Quick Sight account.
update_key_registration	update	aws_account_id, region, KeyRegistration		Updates a customer managed key in a 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 Amazon Web Services account that contains the customer managed key registration that you want to update.
region	string	AWS region (default: us-east-1)
default-key-only	boolean	Determines whether the request returns the default key only.

SELECT examples

describe_key_registration

Describes all customer managed key registrations in a Quick Sight account.

SELECT
aws_account_id,
key_registration,
q_data_key,
request_id,
status
FROM aws.quicksight.key_registrations
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `default-key-only` = '{{ default-key-only }}'
;

UPDATE examples

update_key_registration

Updates a customer managed key in a Quick Sight account.

UPDATE aws.quicksight.key_registrations
SET 
KeyRegistration = '{{ KeyRegistration }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND KeyRegistration = '{{ KeyRegistration }}' --required
RETURNING
failed_key_registration,
request_id,
successful_key_registration;