Skip to content

update_membership

update_membership(
    membership_identifier: MembershipIdentifier,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    query_log_status: Optional[MembershipQueryLogStatus] = None,
    job_log_status: Optional[MembershipJobLogStatus] = None,
    default_result_configuration: Optional[
        MembershipProtectedQueryResultConfiguration
    ] = None,
    default_job_result_configuration: Optional[
        MembershipProtectedJobResultConfiguration
    ] = None,
    membership_payment_configuration: Optional[
        UpdateMembershipPaymentConfiguration
    ] = None,
) -> UpdateMembershipOutput

Updates a membership.

Parameters:

  • membership_identifier (MembershipIdentifier) –

    The unique identifier of the membership.

  • query_log_status (Optional[MembershipQueryLogStatus], default: None ) –

    An indicator as to whether query logging has been enabled or disabled for the membership.

    When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

  • job_log_status (Optional[MembershipJobLogStatus], default: None ) –

    An indicator as to whether job logging has been enabled or disabled for the collaboration.

    When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

  • default_result_configuration (Optional[MembershipProtectedQueryResultConfiguration], default: None ) –

    The default protected query result configuration as specified by the member who can receive results.

  • default_job_result_configuration (Optional[MembershipProtectedJobResultConfiguration], default: None ) –

    The default job result configuration.

  • membership_payment_configuration (Optional[UpdateMembershipPaymentConfiguration], default: None ) –

    The payment configuration to update for the membership.

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def update_membership(
    self,
    membership_identifier: "capo_cleanrooms.types.membership_identifier.MembershipIdentifier",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    query_log_status: Optional[
        "capo_cleanrooms.types.membership_query_log_status.MembershipQueryLogStatus"
    ] = None,
    job_log_status: Optional[
        "capo_cleanrooms.types.membership_job_log_status.MembershipJobLogStatus"
    ] = None,
    default_result_configuration: Optional[
        "capo_cleanrooms.types.membership_protected_query_result_configuration.MembershipProtectedQueryResultConfiguration"
    ] = None,
    default_job_result_configuration: Optional[
        "capo_cleanrooms.types.membership_protected_job_result_configuration.MembershipProtectedJobResultConfiguration"
    ] = None,
    membership_payment_configuration: Optional[
        "capo_cleanrooms.types.update_membership_payment_configuration.UpdateMembershipPaymentConfiguration"
    ] = None,
) -> "capo_cleanrooms.types.update_membership_output.UpdateMembershipOutput":
    """<p>Updates a membership.</p>

    Args:
        membership_identifier: <p>The unique identifier of the membership.</p>
        query_log_status: <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
        job_log_status: <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
        default_result_configuration: <p>The default protected query result configuration as specified by the member who can receive results.</p>
        default_job_result_configuration: <p> The default job result configuration.</p>
        membership_payment_configuration: <p>The payment configuration to update for the membership.</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_membership_input.UpdateMembershipInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.update_membership_output.UpdateMembershipOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.update_membership

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateMembership")
    )
    input_: capo_cleanrooms.types.update_membership_input.UpdateMembershipInput = {
        "membership_identifier": membership_identifier
    }
    if query_log_status is not None:
        input_["query_log_status"] = query_log_status
    if job_log_status is not None:
        input_["job_log_status"] = job_log_status
    if default_result_configuration is not None:
        input_["default_result_configuration"] = default_result_configuration
    if default_job_result_configuration is not None:
        input_["default_job_result_configuration"] = (
            default_job_result_configuration
        )
    if membership_payment_configuration is not None:
        input_["membership_payment_configuration"] = (
            membership_payment_configuration
        )

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