update_security_group ¶

def update_security_group(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    group_id: "capo_wickr.types.generic_string.GenericString",
    *,
    config_overrides: Optional[WickrClientConfig] = None,
    name: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    security_group_settings: Optional[
        "capo_wickr.types.security_group_settings.SecurityGroupSettings"
    ] = None,
) -> "capo_wickr.types.update_security_group_response.UpdateSecurityGroupResponse":
    """<p>Updates the properties of an existing security group in a Wickr network, such as its name or settings.</p>

    Args:
        network_id: <p>The ID of the Wickr network containing the security group to update.</p>
        group_id: <p>The unique identifier of the security group to update.</p>
        name: <p>The new name for the security group.</p>
        security_group_settings: <p>The updated configuration settings for the security group.</p> <p>Federation mode - 0 (Local federation), 1 (Restricted federation), 2 (Global federation) </p>

    Raises:
        capo_wickr.errors.bad_request_error.BadRequestError: <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
        capo_wickr.errors.forbidden_error.ForbiddenError: <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
        capo_wickr.errors.internal_server_error.InternalServerError: <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
        capo_wickr.errors.rate_limit_error.RateLimitError: <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
        capo_wickr.errors.resource_not_found_error.ResourceNotFoundError: <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
        capo_wickr.errors.unauthorized_error.UnauthorizedError: <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
        capo_wickr.errors.validation_error.ValidationError: <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
        capo_wickr.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Update security group successfully

        >>> client.update_security_group(network_id='12345678', group_id='abc12345', name='Updated Group Name', security_group_settings={'lockoutThreshold': 15})
        Update security group - not found

        >>> client.update_security_group(network_id='12345678', group_id='invalid99', name='New Name')
    """

    def _handler(
        req: "OperationRequest[capo_wickr.types.update_security_group_request.UpdateSecurityGroupRequest]",
    ) -> OperationResponse[
        "capo_wickr.types.update_security_group_response.UpdateSecurityGroupResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.update_security_group

        output, http_response = (
            capo_wickr._operations.wickr_admin_api.update_security_group.update_security_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSecurityGroup")
    )
    input_: capo_wickr.types.update_security_group_request.UpdateSecurityGroupRequest = {
        "network_id": network_id,
        "group_id": group_id,
    }
    if name is not None:
        input_["name"] = name
    if security_group_settings is not None:
        input_["security_group_settings"] = security_group_settings

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