Skip to content

update_protected_query

update_protected_query(
    membership_identifier: MembershipIdentifier,
    protected_query_identifier: ProtectedQueryIdentifier,
    target_status: TargetProtectedQueryStatus,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
) -> UpdateProtectedQueryOutput

Updates the processing of a currently running query.

Parameters:

  • membership_identifier (MembershipIdentifier) –

    The identifier for a member of a protected query instance.

  • protected_query_identifier (ProtectedQueryIdentifier) –

    The identifier for a protected query instance.

  • target_status (TargetProtectedQueryStatus) –

    The target status of a query. Used to update the execution status of a currently running query.

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def update_protected_query(
    self,
    membership_identifier: "capo_cleanrooms.types.membership_identifier.MembershipIdentifier",
    protected_query_identifier: "capo_cleanrooms.types.protected_query_identifier.ProtectedQueryIdentifier",
    target_status: "capo_cleanrooms.types.target_protected_query_status.TargetProtectedQueryStatus",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
) -> (
    "capo_cleanrooms.types.update_protected_query_output.UpdateProtectedQueryOutput"
):
    """<p>Updates the processing of a currently running query.</p>

    Args:
        membership_identifier: <p>The identifier for a member of a protected query instance.</p>
        protected_query_identifier: <p>The identifier for a protected query instance.</p>
        target_status: <p>The target status of a query. Used to update the execution status of a currently running query.</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_protected_query_input.UpdateProtectedQueryInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.update_protected_query_output.UpdateProtectedQueryOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.update_protected_query

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

    def _redact_output(
        output: "capo_cleanrooms.types.update_protected_query_output.UpdateProtectedQueryOutput",
    ) -> dict[str, Any]:
        import capo_cleanrooms.types.update_protected_query_output

        return capo_cleanrooms.types.update_protected_query_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateProtectedQuery", redact_output=_redact_output),
    )
    input_: capo_cleanrooms.types.update_protected_query_input.UpdateProtectedQueryInput = {
        "membership_identifier": membership_identifier,
        "protected_query_identifier": protected_query_identifier,
        "target_status": target_status,
    }

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