update_public_sharing_settings async ¶

async def update_public_sharing_settings(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    public_sharing_enabled: Optional[
        "capo_quicksight.types.boolean.Boolean"
    ] = None,
) -> "capo_quicksight.types.update_public_sharing_settings_response.UpdatePublicSharingSettingsResponse":
    """<important> <p>This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing:</p> <ul> <li> <p>Dashboards can be shared publicly</p> </li> <li> <p>This setting affects your entire Amazon Web Services account and all Quick Sight users</p> </li> </ul> <p> <b>Before proceeding:</b> Ensure you understand the security implications and have proper IAM permissions configured.</p> </important> <p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard.</p> <p>To use this operation, turn on session capacity pricing for your Amazon Quick Sight account.</p> <p>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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using Quick with IAM</a> in the <i>Amazon Quick Sight User Guide</i>.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID associated with your Amazon Quick Sight subscription.</p>
        public_sharing_enabled: <p>A Boolean value that indicates whether public sharing is turned on for an Quick account.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_pricing_plan_exception.UnsupportedPricingPlanException: <p>This error indicates that you are calling an embedding operation in Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick Sight. You can do this on the <b>Manage Quick Suite</b> page. </p> <p>After capacity pricing is added, you can use the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a> </code> API operation with the <code>--identity-type ANONYMOUS</code> option.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.update_public_sharing_settings_request.UpdatePublicSharingSettingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.update_public_sharing_settings_response.UpdatePublicSharingSettingsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.update_public_sharing_settings

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.update_public_sharing_settings.async_update_public_sharing_settings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePublicSharingSettings")
    )
    input_: capo_quicksight.types.update_public_sharing_settings_request.UpdatePublicSharingSettingsRequest = {
        "aws_account_id": aws_account_id
    }
    if public_sharing_enabled is not None:
        input_["public_sharing_enabled"] = public_sharing_enabled

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output