Skip to content

update_privacy_budget_template

update_privacy_budget_template(
    membership_identifier: MembershipIdentifier,
    privacy_budget_template_identifier: PrivacyBudgetTemplateIdentifier,
    privacy_budget_type: PrivacyBudgetType,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    parameters: Optional[PrivacyBudgetTemplateUpdateParameters] = None,
) -> UpdatePrivacyBudgetTemplateOutput

Updates the privacy budget template for the specified collaboration.

Parameters:

  • membership_identifier (MembershipIdentifier) –

    A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.

  • privacy_budget_template_identifier (PrivacyBudgetTemplateIdentifier) –

    A unique identifier for your privacy budget template that you want to update.

  • privacy_budget_type (PrivacyBudgetType) –

    Specifies the type of the privacy budget template.

  • parameters (Optional[PrivacyBudgetTemplateUpdateParameters], default: None ) –

    Specifies the epsilon and noise parameters for the privacy budget template.

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def update_privacy_budget_template(
    self,
    membership_identifier: "capo_cleanrooms.types.membership_identifier.MembershipIdentifier",
    privacy_budget_template_identifier: "capo_cleanrooms.types.privacy_budget_template_identifier.PrivacyBudgetTemplateIdentifier",
    privacy_budget_type: "capo_cleanrooms.types.privacy_budget_type.PrivacyBudgetType",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    parameters: Optional[
        "capo_cleanrooms.types.privacy_budget_template_update_parameters.PrivacyBudgetTemplateUpdateParameters"
    ] = None,
) -> "capo_cleanrooms.types.update_privacy_budget_template_output.UpdatePrivacyBudgetTemplateOutput":
    """<p>Updates the privacy budget template for the specified collaboration.</p>

    Args:
        membership_identifier: <p>A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.</p>
        privacy_budget_template_identifier: <p>A unique identifier for your privacy budget template that you want to update.</p>
        privacy_budget_type: <p>Specifies the type of the privacy budget template.</p>
        parameters: <p>Specifies the epsilon and noise parameters for the privacy budget template.</p>

    Raises:
        capo_cleanrooms.errors.access_denied_exception.AccessDeniedException: <p>Caller does not have sufficient access to perform this action.</p>
        capo_cleanrooms.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_cleanrooms.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_cleanrooms.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_cleanrooms.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_cleanrooms.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
        capo_cleanrooms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cleanrooms.types.update_privacy_budget_template_input.UpdatePrivacyBudgetTemplateInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.update_privacy_budget_template_output.UpdatePrivacyBudgetTemplateOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.update_privacy_budget_template

        output, http_response = (
            capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.update_privacy_budget_template.update_privacy_budget_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePrivacyBudgetTemplate")
    )
    input_: capo_cleanrooms.types.update_privacy_budget_template_input.UpdatePrivacyBudgetTemplateInput = {
        "membership_identifier": membership_identifier,
        "privacy_budget_template_identifier": privacy_budget_template_identifier,
        "privacy_budget_type": privacy_budget_type,
    }
    if parameters is not None:
        input_["parameters"] = parameters

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output