brand_assignments

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

Overview

Name	brand_assignments
Type	Resource
Id	aws.quicksight.brand_assignments

Fields

The following fields are returned by SELECT queries:

describe_brand_assignment

Name	Datatype	Description
brand_arn	string	The Amazon Resource Name (ARN) of the brand.
request_id	string	The Amazon Web Services request ID for this operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_brand_assignment	select	aws_account_id, region		Describes a brand assignment.
update_brand_assignment	update	aws_account_id, region, BrandArn		Updates a brand assignment.
delete_brand_assignment	delete	aws_account_id, region		Deletes a brand assignment.

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 owns the brand assignment.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_brand_assignment

Describes a brand assignment.

SELECT
brand_arn,
request_id
FROM aws.quicksight.brand_assignments
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_brand_assignment

Updates a brand assignment.

UPDATE aws.quicksight.brand_assignments
SET 
BrandArn = '{{ BrandArn }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND BrandArn = '{{ BrandArn }}' --required
RETURNING
brand_arn,
request_id;

DELETE examples

delete_brand_assignment

Deletes a brand assignment.

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