SecurityIncidentResponse / Client / update_membership

update_membership

SecurityIncidentResponse.Client.update_membership(**kwargs)

Updates membership configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_membership(
    membershipId='string',
    membershipName='string',
    incidentResponseTeam=[
        {
            'name': 'string',
            'jobTitle': 'string',
            'email': 'string'
        },
    ],
    optInFeatures=[
        {
            'featureName': 'Triage',
            'isEnabled': True|False
        },
    ],
    membershipAccountsConfigurationsUpdate={
        'coverEntireOrganization': True|False,
        'organizationalUnitsToAdd': [
            'string',
        ],
        'organizationalUnitsToRemove': [
            'string',
        ]
    },
    undoMembershipCancellation=True|False
)

Parameters:

• membershipId (string) –

  [REQUIRED]

  Required element for UpdateMembership to identify the membership to update.

• membershipName (string) – Optional element for UpdateMembership to update the membership name.

• incidentResponseTeam (list) –

  Optional element for UpdateMembership to update the membership name.

  • (dict) –

    • name (string) – [REQUIRED]

    • jobTitle (string) – [REQUIRED]

    • email (string) – [REQUIRED]

• optInFeatures (list) –

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

  • (dict) –

    • featureName (string) – [REQUIRED]

    • isEnabled (boolean) – [REQUIRED]

• membershipAccountsConfigurationsUpdate (dict) –

  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.

  • coverEntireOrganization (boolean) –

    The coverEntireOrganization field is a boolean value that determines whether the membership configuration should be applied across the entire Amazon Web Services Organization.

    When set to true, the configuration will be applied to all accounts within the organization. When set to false, the configuration will only apply to specifically designated accounts.

  • organizationalUnitsToAdd (list) –

    A list of organizational unit IDs to add to the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}.

    The list must contain between 1 and 5 organizational unit IDs.

    • (string) –

  • organizationalUnitsToRemove (list) –

    A list of organizational unit IDs to remove from the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}.

    The list must contain between 1 and 5 organizational unit IDs per invocation of the API request.

    • (string) –

• undoMembershipCancellation (boolean) –

  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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• SecurityIncidentResponse.Client.exceptions.ServiceQuotaExceededException

• SecurityIncidentResponse.Client.exceptions.AccessDeniedException

• SecurityIncidentResponse.Client.exceptions.ValidationException

• SecurityIncidentResponse.Client.exceptions.SecurityIncidentResponseNotActiveException

• SecurityIncidentResponse.Client.exceptions.InternalServerException

• SecurityIncidentResponse.Client.exceptions.ThrottlingException

• SecurityIncidentResponse.Client.exceptions.ConflictException

• SecurityIncidentResponse.Client.exceptions.ResourceNotFoundException

• SecurityIncidentResponse.Client.exceptions.InvalidTokenException