Cancels an existing membership.
Parameters:
-
membership_id
(MembershipId)
–
Required element used in combination with CancelMembershipRequest to identify the membership ID to cancel.
Raises:
Examples:
Invoke CancelMembership
>>> client.cancel_membership(membership_id='m-abcd1234efgh')
Source code in docs_src/capo_security_ir/_services/security_ir.py
| def cancel_membership(
self,
membership_id: "capo_security_ir.types.membership_id.MembershipId",
*,
config_overrides: Optional[SecurityIRClientConfig] = None,
) -> "capo_security_ir.types.cancel_membership_response.CancelMembershipResponse":
"""<p>Cancels an existing membership.</p>
Args:
membership_id: <p>Required element used in combination with CancelMembershipRequest to identify the membership ID to cancel. </p>
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 CancelMembership
>>> client.cancel_membership(membership_id='m-abcd1234efgh')
"""
def _handler(
req: "OperationRequest[capo_security_ir.types.cancel_membership_request.CancelMembershipRequest]",
) -> OperationResponse[
"capo_security_ir.types.cancel_membership_response.CancelMembershipResponse"
]:
import capo_security_ir._operations.security_incident_response.cancel_membership
output, http_response = (
capo_security_ir._operations.security_incident_response.cancel_membership.cancel_membership(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CancelMembership")
)
input_: capo_security_ir.types.cancel_membership_request.CancelMembershipRequest = {
"membership_id": membership_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|