QuickSight / Client / update_public_sharing_settings

update_public_sharing_settings#

QuickSight.Client.update_public_sharing_settings(**kwargs)#

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

To use this operation, turn on session capacity pricing for your Amazon QuickSight 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 QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_public_sharing_settings(
    AwsAccountId='string',
    PublicSharingEnabled=True|False
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

  • PublicSharingEnabled (boolean) – A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.UnsupportedPricingPlanException

  • QuickSight.Client.exceptions.InternalFailureException