Skip to content

UpdateMembershipRequest

Source code in docs_src/capo_security_ir/types/update_membership_request.py
class UpdateMembershipRequest(TypedDict, closed=True):
    membership_id: "capo_security_ir.types.membership_id.MembershipId"
    """<p>Required element for UpdateMembership to identify the membership to update.</p>"""
    membership_name: NotRequired[
        "capo_security_ir.types.membership_name.MembershipName"
    ]
    """<p>Optional element for UpdateMembership to update the membership name.</p>"""
    incident_response_team: NotRequired[
        "capo_security_ir.types.incident_response_team.IncidentResponseTeam"
    ]
    """<p>Optional element for UpdateMembership to update the membership name.</p>"""
    opt_in_features: NotRequired["capo_security_ir.types.opt_in_features.OptInFeatures"]
    """<p>Optional element for UpdateMembership to enable or disable opt-in features for the service.</p>"""
    membership_accounts_configurations_update: NotRequired[
        "capo_security_ir.types.membership_accounts_configurations_update.MembershipAccountsConfigurationsUpdate"
    ]
    """<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: NotRequired["bool"]
    """<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>"""

incident_response_team instance-attribute

incident_response_team: NotRequired[IncidentResponseTeam]

Optional element for UpdateMembership to update the membership name.

membership_accounts_configurations_update instance-attribute

membership_accounts_configurations_update: NotRequired[
    MembershipAccountsConfigurationsUpdate
]

The membershipAccountsConfigurationsUpdate field in the UpdateMembershipRequest structure allows you to update the configuration settings for accounts within a membership.

This field is optional and contains a structure of type MembershipAccountsConfigurationsUpdate that specifies the updated account configurations for the membership.

membership_id instance-attribute

membership_id: MembershipId

Required element for UpdateMembership to identify the membership to update.

membership_name instance-attribute

membership_name: NotRequired[MembershipName]

Optional element for UpdateMembership to update the membership name.

opt_in_features instance-attribute

opt_in_features: NotRequired[OptInFeatures]

Optional element for UpdateMembership to enable or disable opt-in features for the service.

undo_membership_cancellation instance-attribute

undo_membership_cancellation: NotRequired[bool]

The undoMembershipCancellation 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.

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.

  • If set to true, the cancellation request will be revoked

  • If set to false the service will throw a ValidationException.