update_membership ¶

def update_membership(
    self,
    membership_id: "capo_security_ir.types.membership_id.MembershipId",
    *,
    config_overrides: Optional[SecurityIRClientConfig] = None,
    membership_name: Optional[
        "capo_security_ir.types.membership_name.MembershipName"
    ] = None,
    incident_response_team: Optional[
        "capo_security_ir.types.incident_response_team.IncidentResponseTeam"
    ] = None,
    opt_in_features: Optional[
        "capo_security_ir.types.opt_in_features.OptInFeatures"
    ] = None,
    membership_accounts_configurations_update: Optional[
        "capo_security_ir.types.membership_accounts_configurations_update.MembershipAccountsConfigurationsUpdate"
    ] = None,
    undo_membership_cancellation: Optional[bool] = None,
) -> "capo_security_ir.types.update_membership_response.UpdateMembershipResponse":
    """<p>Updates membership configuration.</p>

    Args:
        membership_id: <p>Required element for UpdateMembership to identify the membership to update.</p>
        membership_name: <p>Optional element for UpdateMembership to update the membership name.</p>
        incident_response_team: <p>Optional element for UpdateMembership to update the membership name.</p>
        opt_in_features: <p>Optional element for UpdateMembership to enable or disable opt-in features for the service.</p>
        membership_accounts_configurations_update: <p>The <code>membershipAccountsConfigurationsUpdate</code> field in the <code>UpdateMembershipRequest</code> structure allows you to update the configuration settings for accounts within a membership. </p> <p>This field is optional and contains a structure of type <code>MembershipAccountsConfigurationsUpdate </code> that specifies the updated account configurations for the membership. </p>
        undo_membership_cancellation: <p>The <code>undoMembershipCancellation</code> parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status. </p> <p>This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn't been fully terminated yet. </p> <ul> <li> <p>If set to <code>true</code>, the cancellation request will be revoked </p> </li> <li> <p>If set to <code>false</code> the service will throw a ValidationException. </p> </li> </ul>

    Raises:
        capo_security_ir.errors.access_denied_exception.AccessDeniedException: <p/>
        capo_security_ir.errors.conflict_exception.ConflictException: <p/>
        capo_security_ir.errors.internal_server_exception.InternalServerException: <p/>
        capo_security_ir.errors.invalid_token_exception.InvalidTokenException: <p/>
        capo_security_ir.errors.resource_not_found_exception.ResourceNotFoundException: <p/>
        capo_security_ir.errors.security_incident_response_not_active_exception.SecurityIncidentResponseNotActiveException: <p/>
        capo_security_ir.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p/>
        capo_security_ir.errors.throttling_exception.ThrottlingException: <p/>
        capo_security_ir.errors.validation_exception.ValidationException: <p/>
        capo_security_ir.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Invoke UpdateMembership

        >>> client.update_membership(membership_id='m-abcd1234efgh', membership_name='New membership name', incident_response_team=[{'name': 'Bob Jones', 'jobTitle': 'Security Responder', 'email': '[email protected]'}, {'email': '[email protected]', 'name': 'Alice', 'jobTitle': 'CEO'}], opt_in_features=[{'featureName': 'Triage', 'isEnabled': True}])
    """

    def _handler(
        req: "OperationRequest[capo_security_ir.types.update_membership_request.UpdateMembershipRequest]",
    ) -> OperationResponse[
        "capo_security_ir.types.update_membership_response.UpdateMembershipResponse"
    ]:
        import capo_security_ir._operations.security_incident_response.update_membership

        output, http_response = (
            capo_security_ir._operations.security_incident_response.update_membership.update_membership(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_security_ir.types.update_membership_request.UpdateMembershipRequest",
    ) -> dict[str, Any]:
        import capo_security_ir.types.update_membership_request

        return capo_security_ir.types.update_membership_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateMembership", redact_input=_redact_input),
    )
    input_: capo_security_ir.types.update_membership_request.UpdateMembershipRequest = {
        "membership_id": membership_id
    }
    if membership_name is not None:
        input_["membership_name"] = membership_name
    if incident_response_team is not None:
        input_["incident_response_team"] = incident_response_team
    if opt_in_features is not None:
        input_["opt_in_features"] = opt_in_features
    if membership_accounts_configurations_update is not None:
        input_["membership_accounts_configurations_update"] = (
            membership_accounts_configurations_update
        )
    if undo_membership_cancellation is not None:
        input_["undo_membership_cancellation"] = undo_membership_cancellation

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