public_sharing_settings
Creates, updates, deletes, gets or lists a public_sharing_settings resource.
Overview
| Name | public_sharing_settings |
| Type | Resource |
| Id | aws.quicksight.public_sharing_settings |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
update_public_sharing_settings | update | aws_account_id, region | This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing: Dashboards can be shared publicly This setting affects your entire Amazon Web Services account and all Quick Sight users Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured. Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard. To use this operation, turn on session capacity pricing for your Amazon Quick Sight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using Quick with IAM in the Amazon Quick Sight User Guide. |
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 Amazon Web Services account ID associated with your Amazon Quick Sight subscription. |
region | string | AWS region (default: us-east-1) |
UPDATE examples
- update_public_sharing_settings
This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing: Dashboards can be shared publicly This setting affects your entire Amazon Web Services account and all Quick Sight users Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured. Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard. To use this operation, turn on session capacity pricing for your Amazon Quick Sight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using Quick with IAM in the Amazon Quick Sight User Guide.
UPDATE aws.quicksight.public_sharing_settings
SET
PublicSharingEnabled = {{ PublicSharingEnabled }}
WHERE
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
RETURNING
request_id,
status;