identity_propagation_configs

Creates, updates, deletes, gets or lists an identity_propagation_configs resource.

Overview

Name	identity_propagation_configs
Type	Resource
Id	aws.quicksight.identity_propagation_configs

Fields

The following fields are returned by SELECT queries:

list_identity_propagation_configs

Name	Datatype	Description
next_token	string	The token for the next set of results, or null if there are no more results.
request_id	string	The Amazon Web Services request ID for this operation.
services	array	A list of services and their authorized targets that the Quick Sight IAM Identity Center application can access.
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
list_identity_propagation_configs	select	aws_account_id, region	max-results, next-token	Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts that use IAM Identity Center.
update_identity_propagation_config	update	aws_account_id, service, region		Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts using IAM Identity Center
delete_identity_propagation_config	delete	aws_account_id, service, region		Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.

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 you want to delete an identity propagation configuration from.
region	string	AWS region (default: us-east-1)
service	string	The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.
max-results	integer	The maximum number of results to be returned.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

list_identity_propagation_configs

Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts that use IAM Identity Center.

SELECT
next_token,
request_id,
services,
status
FROM aws.quicksight.identity_propagation_configs
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

UPDATE examples

update_identity_propagation_config

Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts using IAM Identity Center

UPDATE aws.quicksight.identity_propagation_configs
SET 
AuthorizedTargets = '{{ AuthorizedTargets }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND service = '{{ service }}' --required
AND region = '{{ region }}' --required
RETURNING
request_id,
status;

DELETE examples

delete_identity_propagation_config

Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.

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